Mercurial > emacs
annotate lispref/objects.texi @ 49389:2867da9cc2b0
Regenerated.
author | Andreas Schwab <schwab@suse.de> |
---|---|
date | Wed, 22 Jan 2003 19:57:26 +0000 |
parents | a8d9fd32a154 |
children | 23a1cea22d13 |
rev | line source |
---|---|
6447 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
27189 | 3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999 |
4 @c Free Software Foundation, Inc. | |
6447 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/objects | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
7 @node Lisp Data Types, Numbers, Introduction, Top |
6447 | 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 | |
26188 | 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}.) | |
6447 | 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 | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
44 variable can have any type of value, and it remembers whatever value |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
45 you store in it, type and all. |
6447 | 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. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
56 * Circular Objects:: Read syntax for circular structure. |
6447 | 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 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
71 object. @xref{Read and Print}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
72 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
73 Most objects have more than one possible read syntax. Some types of |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
74 object have no read syntax, since it may not make sense to enter objects |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
75 of these types directly in a Lisp program. Except for these cases, the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
76 printed representation of an object is also a read syntax for it. |
6447 | 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 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
86 syntax---for example, the buffer type has none. Objects of these types |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
87 are printed in @dfn{hash notation}: the characters @samp{#<} followed by |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
88 a descriptive string (typically the type name followed by the name of |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
89 the object), and closed with a matching @samp{>}. Hash notation cannot |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
90 be read at all, so the Lisp reader signals the error |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
91 @code{invalid-read-syntax} whenever it encounters @samp{#<}. |
6447 | 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 | |
12098 | 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 | |
6447 | 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. | |
7337
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7118
diff
changeset
|
142 * Symbol Type:: A multi-use object that refers to a function, |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7118
diff
changeset
|
143 variable, or property list, and has a unique identity. |
6447 | 144 * Sequence Type:: Both lists and arrays are classified as sequences. |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
145 * Cons Cell Type:: Cons cells, and lists (which are made from cons cells). |
6447 | 146 * Array Type:: Arrays include strings and vectors. |
147 * String Type:: An (efficient) array of characters. | |
148 * Vector Type:: One-dimensional arrays. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
149 * Char-Table Type:: One-dimensional sparse arrays indexed by characters. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
150 * Bool-Vector Type:: One-dimensional arrays of @code{t} or @code{nil}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
151 * Hash Table Type:: Super-fast lookup tables. |
7337
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7118
diff
changeset
|
152 * Function Type:: A piece of executable code you can call from elsewhere. |
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7118
diff
changeset
|
153 * Macro Type:: A method of expanding an expression into another |
6447 | 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 | |
10559 | 164 The range of values for integers in Emacs Lisp is @minus{}134217728 to |
165 134217727 (28 bits; i.e., | |
27193 | 166 @ifnottex |
10559 | 167 -2**27 |
27193 | 168 @end ifnottex |
6447 | 169 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
170 @math{-2^{27}} |
6447 | 171 @end tex |
172 to | |
27193 | 173 @ifnottex |
10559 | 174 2**27 - 1) |
27193 | 175 @end ifnottex |
6447 | 176 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
177 @math{2^{28}-1}) |
6447 | 178 @end tex |
10559 | 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. | |
6447 | 183 |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
184 The read syntax for integers is a sequence of (base ten) digits with an |
6447 | 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.} | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
193 1. ; @r{Also the integer 1.} |
6447 | 194 +1 ; @r{Also the integer 1.} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
195 268435457 ; @r{Also the integer 1 on a 28-bit implementation.} |
6447 | 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 | |
36987
3a9bdf46b7db
Floating point is always available; say a little about what it is.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
204 Floating point numbers are the computer equivalent of scientific |
3a9bdf46b7db
Floating point is always available; say a little about what it is.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
205 notation. The precise number of significant figures and the range of |
3a9bdf46b7db
Floating point is always available; say a little about what it is.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
206 possible exponents is machine-specific; Emacs always uses the C data |
3a9bdf46b7db
Floating point is always available; say a little about what it is.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
207 type @code{double} to store the value. |
6447 | 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 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
219 @cindex @sc{ascii} character codes |
6447 | 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 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
230 range of 0 to 524287---nineteen bits. But not all values in that range |
27374
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
231 are valid character codes. Codes 0 through 127 are @sc{ascii} codes; the |
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
232 rest are non-@sc{ascii} (@pxref{Non-ASCII Characters}). Characters that represent |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
233 keyboard input have a much wider range, to encode modifier keys such as |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
234 Control, Meta and Shift. |
6447 | 235 |
236 @cindex read syntax for characters | |
237 @cindex printed representation for characters | |
238 @cindex syntax for characters | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
239 @cindex @samp{?} in character constant |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
240 @cindex question mark in character constant |
6447 | 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 | |
251 character @kbd{a}. | |
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 | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
260 often a good idea to add a @samp{\} so that the Emacs commands for |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
261 editing Lisp code don't get confused. For example, @samp{?\ } is the |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
262 way to write the space character. If the character is @samp{\}, you |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
263 @emph{must} use a second @samp{\} to quote it: @samp{?\\}. |
6447 | 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, | |
37418 | 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, | |
6447 | 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}} | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
291 ?\n @result{} 10 ; @r{newline, @kbd{C-j}} |
6447 | 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{\}} | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
297 ?\d @result{} 127 ; @r{delete character, @key{DEL}} |
6447 | 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 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
319 In strings and buffers, the only control characters allowed are those |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
320 that exist in @sc{ascii}; but for keyboard input purposes, you can turn |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
321 any character into a control character with @samp{C-}. The character |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
322 codes for these non-@sc{ascii} control characters include the |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
323 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
324 @math{2^{26}} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
325 @end tex |
27193 | 326 @ifnottex |
12098 | 327 2**26 |
27193 | 328 @end ifnottex |
12098 | 329 bit as well as the code for the corresponding non-control |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
330 character. Ordinary terminals have no way of generating non-@sc{ascii} |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
331 control characters, but you can generate them straightforwardly using X |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
332 and other window systems. |
6447 | 333 |
12098 | 334 For historical reasons, Emacs treats the @key{DEL} character as |
335 the control equivalent of @kbd{?}: | |
6447 | 336 |
337 @example | |
338 ?\^? @result{} 127 ?\C-? @result{} 127 | |
339 @end example | |
340 | |
12098 | 341 @noindent |
342 As a result, it is currently not possible to represent the character | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
343 @kbd{Control-?}, which is a meaningful input character under X, using |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
344 @samp{\C-}. It is not easy to change this, as various Lisp files refer |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
345 to @key{DEL} in this way. |
12098 | 346 |
6447 | 347 For representing control characters to be found in files or strings, |
348 we recommend the @samp{^} syntax; for control characters in keyboard | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
349 input, we prefer the @samp{C-} syntax. Which one you use does not |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
350 affect the meaning of the program, but may guide the understanding of |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
351 people who read it. |
6447 | 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 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
356 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
357 @math{2^{27}} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
358 @end tex |
27193 | 359 @ifnottex |
12098 | 360 2**27 |
27193 | 361 @end ifnottex |
12098 | 362 bit set (which on most machines makes it a negative number). We |
6447 | 363 use high bits for this and other modifiers to make possible a wide range |
364 of basic character codes. | |
365 | |
12098 | 366 In a string, the |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
367 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
368 @math{2^{7}} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
369 @end tex |
27193 | 370 @ifnottex |
12098 | 371 2**7 |
27193 | 372 @end ifnottex |
27374
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
373 bit attached to an @sc{ascii} character indicates a meta character; thus, the |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
374 meta characters that can fit in a string have codes in the range from |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
375 128 to 255, and are the meta versions of the ordinary @sc{ascii} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
376 characters. (In Emacs versions 18 and older, this convention was used |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
377 for characters outside of strings as well.) |
6447 | 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 | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
381 octal character codes (see below), with @samp{\C-}, or with any other |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
382 syntax for a character. Thus, you can write @kbd{M-A} as @samp{?\M-A}, |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
383 or as @samp{?\M-\101}. Likewise, you can write @kbd{C-M-b} as |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
384 @samp{?\M-\C-b}, @samp{?\C-\M-b}, or @samp{?\M-\002}. |
6447 | 385 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
386 The case of a graphic character is indicated by its character code; |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
387 for example, @sc{ascii} distinguishes between the characters @samp{a} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
388 and @samp{A}. But @sc{ascii} has no way to represent whether a control |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
389 character is upper case or lower case. Emacs uses the |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
390 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
391 @math{2^{25}} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
392 @end tex |
27193 | 393 @ifnottex |
12098 | 394 2**25 |
27193 | 395 @end ifnottex |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
396 bit to indicate that the shift key was used in typing a control |
12098 | 397 character. This distinction is possible only when you use X terminals |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
398 or other special terminals; ordinary terminals do not report the |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
399 distinction to the computer in any way. The Lisp syntax for |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
400 the shift bit is @samp{\S-}; thus, @samp{?\C-\S-o} or @samp{?\C-\S-O} |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
401 represents the shifted-control-o character. |
6447 | 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 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
408 for these bits are @samp{\H-}, @samp{\s-} and @samp{\A-}. (Case is |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
409 significant in these prefixes.) Thus, @samp{?\H-\M-\A-x} represents |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
410 @kbd{Alt-Hyper-Meta-x}. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
411 @tex |
12098 | 412 Numerically, the |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
413 bit values are @math{2^{22}} for alt, @math{2^{23}} for super and @math{2^{24}} for hyper. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
414 @end tex |
27193 | 415 @ifnottex |
12098 | 416 Numerically, the |
417 bit values are 2**22 for alt, 2**23 for super and 2**24 for hyper. | |
27193 | 418 @end ifnottex |
6447 | 419 |
420 @cindex @samp{\} in character constant | |
421 @cindex backslash in character constant | |
422 @cindex octal character code | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
423 Finally, the most general read syntax for a character represents the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
424 character code in either octal or hex. To use octal, write a question |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
425 mark followed by a backslash and the octal character code (up to three |
6447 | 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 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
428 character @kbd{C-b}. Although this syntax can represent any @sc{ascii} |
6447 | 429 character, it is preferred only when the precise octal value is more |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
430 important than the @sc{ascii} representation. |
6447 | 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 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
439 To use hex, write a question mark followed by a backslash, @samp{x}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
440 and the hexadecimal character code. You can use any number of hex |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
441 digits, so you can represent any character code in this way. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
442 Thus, @samp{?\x41} for the character @kbd{A}, @samp{?\x1} for the |
35477 | 443 character @kbd{C-a}, and @code{?\x8e0} for the Latin-1 character |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
444 @iftex |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
445 @samp{@`a}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
446 @end iftex |
27193 | 447 @ifnottex |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
448 @samp{a} with grave accent. |
27193 | 449 @end ifnottex |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
450 |
6447 | 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 | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
461 @node Symbol Type |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
462 @subsection Symbol Type |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
463 |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
464 A @dfn{symbol} in GNU Emacs Lisp is an object with a name. The symbol |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
465 name serves as the printed representation of the symbol. In ordinary |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
466 use, the name is unique---no two symbols have the same name. |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
467 |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
468 A symbol can serve as a variable, as a function name, or to hold a |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
469 property list. Or it may serve only to be distinct from all other Lisp |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
470 objects, so that its presence in a data structure may be recognized |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
471 reliably. In a given context, usually only one of these uses is |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
472 intended. But you can use one symbol in all of these ways, |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
473 independently. |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
474 |
26188 | 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 | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
480 @cindex @samp{\} in symbols |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
481 @cindex backslash in symbols |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
482 A symbol name can contain any characters whatever. Most symbol names |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
483 are written with letters, digits, and the punctuation characters |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
484 @samp{-+=*/}. Such names require no special punctuation; the characters |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
485 of the name suffice as long as the name does not look like a number. |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
486 (If it does, write a @samp{\} at the beginning of the name to force |
31561 | 487 interpretation as a symbol.) The characters @samp{_~!@@$%^&:<>@{@}?} are |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
488 less often used but also require no special punctuation. Any other |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
489 characters may be included in a symbol's name by escaping them with a |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
490 backslash. In contrast to its use in strings, however, a backslash in |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
491 the name of a symbol simply quotes the single character that follows the |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
492 backslash. For example, in a string, @samp{\t} represents a tab |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
493 character; in the name of a symbol, however, @samp{\t} merely quotes the |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
494 letter @samp{t}. To have a symbol with a tab character in its name, you |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
495 must actually use a tab (preceded with a backslash). But it's rare to |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
496 do such a thing. |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
497 |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
498 @cindex CL note---case of letters |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
499 @quotation |
7734 | 500 @b{Common Lisp note:} In Common Lisp, lower case letters are always |
12098 | 501 ``folded'' to upper case, unless they are explicitly escaped. In Emacs |
502 Lisp, upper case and lower case letters are distinct. | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
503 @end quotation |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
504 |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
505 Here are several examples of symbol names. Note that the @samp{+} in |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
506 the fifth example is escaped to prevent it from being read as a number. |
12098 | 507 This is not necessary in the sixth example because the rest of the name |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
508 makes it invalid as a number. |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
509 |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
510 @example |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
511 @group |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
512 foo ; @r{A symbol named @samp{foo}.} |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
513 FOO ; @r{A symbol named @samp{FOO}, different from @samp{foo}.} |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
514 char-to-string ; @r{A symbol named @samp{char-to-string}.} |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
515 @end group |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
516 @group |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
517 1+ ; @r{A symbol named @samp{1+}} |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
518 ; @r{(not @samp{+1}, which is an integer).} |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
519 @end group |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
520 @group |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
521 \+1 ; @r{A symbol named @samp{+1}} |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
522 ; @r{(not a very readable name).} |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
523 @end group |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
524 @group |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
525 \(*\ 1\ 2\) ; @r{A symbol named @samp{(* 1 2)} (a worse name).} |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
526 @c the @'s in this next line use up three characters, hence the |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
527 @c apparent misalignment of the comment. |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
528 +-*/_~!@@$%^&=:<>@{@} ; @r{A symbol named @samp{+-*/_~!@@$%^&=:<>@{@}}.} |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
529 ; @r{These characters need not be escaped.} |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
530 @end group |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
531 @end example |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
532 |
44089
a8d9fd32a154
(Symbol Type): Use `colon' in index entries instead of `:' only in Info.
Eli Zaretskii <eliz@gnu.org>
parents:
43888
diff
changeset
|
533 @ifinfo |
43888
b777a45900bb
(Symbol Type): Avoid makeinfo warning about colons in indices.
Eli Zaretskii <eliz@gnu.org>
parents:
38940
diff
changeset
|
534 @c This uses ``colon'' instead of a literal `:' because Info cannot |
b777a45900bb
(Symbol Type): Avoid makeinfo warning about colons in indices.
Eli Zaretskii <eliz@gnu.org>
parents:
38940
diff
changeset
|
535 @c cope with a `:' in a menu |
b777a45900bb
(Symbol Type): Avoid makeinfo warning about colons in indices.
Eli Zaretskii <eliz@gnu.org>
parents:
38940
diff
changeset
|
536 @cindex @samp{#@var{colon}} read syntax |
44089
a8d9fd32a154
(Symbol Type): Use `colon' in index entries instead of `:' only in Info.
Eli Zaretskii <eliz@gnu.org>
parents:
43888
diff
changeset
|
537 @end ifinfo |
a8d9fd32a154
(Symbol Type): Use `colon' in index entries instead of `:' only in Info.
Eli Zaretskii <eliz@gnu.org>
parents:
43888
diff
changeset
|
538 @ifnotinfo |
a8d9fd32a154
(Symbol Type): Use `colon' in index entries instead of `:' only in Info.
Eli Zaretskii <eliz@gnu.org>
parents:
43888
diff
changeset
|
539 @cindex @samp{#:} read syntax |
a8d9fd32a154
(Symbol Type): Use `colon' in index entries instead of `:' only in Info.
Eli Zaretskii <eliz@gnu.org>
parents:
43888
diff
changeset
|
540 @end ifnotinfo |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
541 Normally the Lisp reader interns all symbols (@pxref{Creating |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
542 Symbols}). To prevent interning, you can write @samp{#:} before the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
543 name of the symbol. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
544 |
6447 | 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 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
553 Arrays are further subdivided into strings, vectors, char-tables and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
554 bool-vectors. Vectors can hold elements of any type, but string |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
555 elements must be characters, and bool-vector elements must be @code{t} |
35111
b1adf7e27ea8
Minor fix because a bool-vector's elements can't be characters.
Richard M. Stallman <rms@gnu.org>
parents:
31561
diff
changeset
|
556 or @code{nil}. Char-tables are like vectors except that they are |
b1adf7e27ea8
Minor fix because a bool-vector's elements can't be characters.
Richard M. Stallman <rms@gnu.org>
parents:
31561
diff
changeset
|
557 indexed by any valid character code. The characters in a string can |
b1adf7e27ea8
Minor fix because a bool-vector's elements can't be characters.
Richard M. Stallman <rms@gnu.org>
parents:
31561
diff
changeset
|
558 have text properties like characters in a buffer (@pxref{Text |
b1adf7e27ea8
Minor fix because a bool-vector's elements can't be characters.
Richard M. Stallman <rms@gnu.org>
parents:
31561
diff
changeset
|
559 Properties}), but vectors do not support text properties, even when |
b1adf7e27ea8
Minor fix because a bool-vector's elements can't be characters.
Richard M. Stallman <rms@gnu.org>
parents:
31561
diff
changeset
|
560 their elements happen to be characters. |
6447 | 561 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
562 Lists, strings and the other array types are different, but they have |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
563 important similarities. For example, all have a length @var{l}, and all |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
564 have elements which can be indexed from zero to @var{l} minus one. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
565 Several functions, called sequence functions, accept any kind of |
6447 | 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 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
570 It is generally impossible to read the same sequence twice, since |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
571 sequences are always created anew upon reading. If you read the read |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
572 syntax for a sequence twice, you get two sequences with equal contents. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
573 There is one exception: the empty list @code{()} always stands for the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
574 same object, @code{nil}. |
6447 | 575 |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
576 @node Cons Cell Type |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
577 @subsection Cons Cell and List Types |
6447 | 578 @cindex address field of register |
579 @cindex decrement field of register | |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
580 @cindex pointers |
6447 | 581 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
582 A @dfn{cons cell} is an object that consists of two slots, called the |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
583 @sc{car} slot and the @sc{cdr} slot. Each slot can @dfn{hold} or |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
584 @dfn{refer to} any Lisp object. We also say that ``the @sc{car} of |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
585 this cons cell is'' whatever object its @sc{car} slot currently holds, |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
586 and likewise for the @sc{cdr}. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
587 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
588 @quotation |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
589 A note to C programmers: in Lisp, we do not distinguish between |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
590 ``holding'' a value and ``pointing to'' the value, because pointers in |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
591 Lisp are implicit. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
592 @end quotation |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
593 |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
594 A @dfn{list} is a series of cons cells, linked together so that the |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
595 @sc{cdr} slot of each cons cell holds either the next cons cell or the |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
596 empty list. @xref{Lists}, for functions that work on lists. Because |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
597 most cons cells are used as part of lists, the phrase @dfn{list |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
598 structure} has come to refer to any structure made out of cons cells. |
6447 | 599 |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
600 The names @sc{car} and @sc{cdr} derive from the history of Lisp. The |
6447 | 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 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
606 for the function @code{cons} that creates them, which in turn was named |
6447 | 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 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
621 @sc{car} slot of the cons cell holds the element, and its @sc{cdr} |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
622 slot refers to the next cons cell of the list, which holds the next |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
623 element in the list. The @sc{cdr} slot of the last cons cell is set to |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
624 hold @code{nil}. |
6447 | 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 | |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
629 shown as pairs of boxes, like dominoes. (The Lisp reader cannot read |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
630 such an illustration; unlike the textual notation, which can be |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
631 understood by both humans and computers, the box illustrations can be |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
632 understood only by humans.) This picture represents the three-element |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
633 list @code{(rose violet buttercup)}: |
6447 | 634 |
635 @example | |
636 @group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
637 --- --- --- --- --- --- |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
638 | | |--> | | |--> | | |--> nil |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
639 --- --- --- --- --- --- |
6447 | 640 | | | |
641 | | | | |
642 --> rose --> violet --> buttercup | |
643 @end group | |
644 @end example | |
645 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
646 In this diagram, each box represents a slot that can hold or refer to |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
647 any Lisp object. Each pair of boxes represents a cons cell. Each arrow |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
648 represents a reference to a Lisp object, either an atom or another cons |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
649 cell. |
6447 | 650 |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
651 In this example, the first box, which holds the @sc{car} of the first |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
652 cons cell, refers to or ``holds'' @code{rose} (a symbol). The second |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
653 box, holding the @sc{cdr} of the first cons cell, refers to the next |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
654 pair of boxes, the second cons cell. The @sc{car} of the second cons |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
655 cell is @code{violet}, and its @sc{cdr} is the third cons cell. The |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
656 @sc{cdr} of the third (and last) cons cell is @code{nil}. |
6447 | 657 |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
658 Here is another diagram of the same list, @code{(rose violet |
6447 | 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 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
696 --- --- --- --- |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
697 | | |--> | | |--> nil |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
698 --- --- --- --- |
6447 | 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 | |
38940
848626a721b2
Remove two excess spaces.
Richard M. Stallman <rms@gnu.org>
parents:
38788
diff
changeset
|
721 pair notation, the list @samp{(1 2 3)} is written as @samp{(1 . (2 . (3 |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
722 . nil)))}. For @code{nil}-terminated lists, you can use either |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
723 notation, but list notation is usually clearer and more convenient. |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
724 When printing a list, the dotted pair notation is only used if the |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
725 @sc{cdr} of a cons cell is not a list. |
6447 | 726 |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
727 Here's an example using boxes to illustrate dotted pair notation. |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
728 This example shows the pair @code{(rose . violet)}: |
6447 | 729 |
730 @example | |
731 @group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
732 --- --- |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
733 | | |--> violet |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
734 --- --- |
6447 | 735 | |
736 | | |
737 --> rose | |
738 @end group | |
739 @end example | |
740 | |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
741 You can combine dotted pair notation with list notation to represent |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
742 conveniently a chain of cons cells with a non-@code{nil} final @sc{cdr}. |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
743 You write a dot after the last element of the list, followed by the |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
744 @sc{cdr} of the final cons cell. For example, @code{(rose violet |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
745 . buttercup)} is equivalent to @code{(rose . (violet . buttercup))}. |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
746 The object looks like this: |
6447 | 747 |
748 @example | |
749 @group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
750 --- --- --- --- |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
751 | | |--> | | |--> buttercup |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
752 --- --- --- --- |
6447 | 753 | | |
754 | | | |
755 --> rose --> violet | |
756 @end group | |
757 @end example | |
758 | |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
759 The syntax @code{(rose .@: violet .@: buttercup)} is invalid because |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
760 there is nothing that it could mean. If anything, it would say to put |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
761 @code{buttercup} in the @sc{cdr} of a cons cell whose @sc{cdr} is already |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
762 used for @code{violet}. |
6447 | 763 |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
764 The list @code{(rose violet)} is equivalent to @code{(rose . (violet))}, |
6447 | 765 and looks like this: |
766 | |
767 @example | |
768 @group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
769 --- --- --- --- |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
770 | | |--> | | |--> nil |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
771 --- --- --- --- |
6447 | 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)))}. | |
27193 | 780 @ifnottex |
6447 | 781 It looks like this: |
782 | |
783 @example | |
784 @group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
785 --- --- --- --- --- --- |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
786 | | |--> | | |--> | | |--> nil |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
787 --- --- --- --- --- --- |
6447 | 788 | | | |
789 | | | | |
790 --> rose --> violet --> buttercup | |
791 @end group | |
792 @end example | |
27193 | 793 @end ifnottex |
6447 | 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 | |
38940
848626a721b2
Remove two excess spaces.
Richard M. Stallman <rms@gnu.org>
parents:
38788
diff
changeset
|
811 '((rose . red) (lily . white) (buttercup . yellow))) |
6447 | 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 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
819 functions that work on alists. @xref{Hash Tables}, for another kind of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
820 lookup table, which is much faster for handling a large number of keys. |
6447 | 821 |
822 @node Array Type | |
823 @subsection Array Type | |
824 | |
825 An @dfn{array} is composed of an arbitrary number of slots for | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
826 holding or referring to other Lisp objects, arranged in a contiguous block of |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
827 memory. Accessing any element of an array takes approximately the same |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
828 amount of time. In contrast, accessing an element of a list requires |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
829 time proportional to the position of the element in the list. (Elements |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
830 at the end of a list take longer to access than elements at the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
831 beginning of a list.) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
832 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
833 Emacs defines four types of array: strings, vectors, bool-vectors, and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
834 char-tables. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
835 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
836 A string is an array of characters and a vector is an array of |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
837 arbitrary objects. A bool-vector can hold only @code{t} or @code{nil}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
838 These kinds of array may have any length up to the largest integer. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
839 Char-tables are sparse arrays indexed by any valid character code; they |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
840 can hold arbitrary objects. |
6447 | 841 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
842 The first element of an array has index zero, the second element has |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
843 index 1, and so on. This is called @dfn{zero-origin} indexing. For |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
844 example, an array of four elements has indices 0, 1, 2, @w{and 3}. The |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
845 largest possible index value is one less than the length of the array. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
846 Once an array is created, its length is fixed. |
6447 | 847 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
848 All Emacs Lisp arrays are one-dimensional. (Most other programming |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
849 languages support multidimensional arrays, but they are not essential; |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
850 you can get the same effect with an array of arrays.) Each type of |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
851 array has its own read syntax; see the following sections for details. |
6447 | 852 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
853 The array type is contained in the sequence type and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
854 contains the string type, the vector type, the bool-vector type, and the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
855 char-table type. |
6447 | 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 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
866 @xref{Strings and Characters}, for functions that operate on strings. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
867 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
868 @menu |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
869 * Syntax for Strings:: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
870 * Non-ASCII in Strings:: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
871 * Nonprinting Characters:: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
872 * Text Props and Strings:: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
873 @end menu |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
874 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
875 @node Syntax for Strings |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
876 @subsubsection Syntax for Strings |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
877 |
6447 | 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 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
883 characters, and another double-quote, @code{"like this"}. To include a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
884 double-quote in a string, precede it with a backslash; thus, @code{"\""} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
885 is a string containing just a single double-quote character. Likewise, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
886 you can include a backslash by preceding it with another backslash, like |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
887 this: @code{"this \\ is a single embedded backslash"}. |
6447 | 888 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
889 @cindex newline in strings |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
890 The newline character is not special in the read syntax for strings; |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
891 if you write a new line between the double-quotes, it becomes a |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
892 character in the string. But an escaped newline---one that is preceded |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
893 by @samp{\}---does not become part of the string; i.e., the Lisp reader |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
894 ignores an escaped newline while reading a string. An escaped space |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
895 @w{@samp{\ }} is likewise ignored. |
6447 | 896 |
897 @example | |
898 "It is useful to include newlines | |
899 in documentation strings, | |
900 but the newline is \ | |
901 ignored if escaped." | |
902 @result{} "It is useful to include newlines | |
903 in documentation strings, | |
904 but the newline is ignored if escaped." | |
905 @end example | |
906 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
907 @node Non-ASCII in Strings |
27374
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
908 @subsubsection Non-@sc{ascii} Characters in Strings |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
909 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
910 You can include a non-@sc{ascii} international character in a string |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
911 constant by writing it literally. There are two text representations |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
912 for non-@sc{ascii} characters in Emacs strings (and in buffers): unibyte |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
913 and multibyte. If the string constant is read from a multibyte source, |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
914 such as a multibyte buffer or string, or a file that would be visited as |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
915 multibyte, then the character is read as a multibyte character, and that |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
916 makes the string multibyte. If the string constant is read from a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
917 unibyte source, then the character is read as unibyte and that makes the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
918 string unibyte. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
919 |
26783 | 920 You can also represent a multibyte non-@sc{ascii} character with its |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
921 character code: use a hex escape, @samp{\x@var{nnnnnnn}}, with as many |
26783 | 922 digits as necessary. (Multibyte non-@sc{ascii} character codes are all |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
923 greater than 256.) Any character which is not a valid hex digit |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
924 terminates this construct. If the next character in the string could be |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
925 interpreted as a hex digit, write @w{@samp{\ }} (backslash and space) to |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
926 terminate the hex escape---for example, @w{@samp{\x8e0\ }} represents |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
927 one character, @samp{a} with grave accent. @w{@samp{\ }} in a string |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
928 constant is just like backslash-newline; it does not contribute any |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
929 character to the string, but it does terminate the preceding hex escape. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
930 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
931 Using a multibyte hex escape forces the string to multibyte. You can |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
932 represent a unibyte non-@sc{ascii} character with its character code, |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
933 which must be in the range from 128 (0200 octal) to 255 (0377 octal). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
934 This forces a unibyte string. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
935 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
936 @xref{Text Representations}, for more information about the two |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
937 text representations. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
938 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
939 @node Nonprinting Characters |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
940 @subsubsection Nonprinting Characters in Strings |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
941 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
942 You can use the same backslash escape-sequences in a string constant |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
943 as in character literals (but do not use the question mark that begins a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
944 character constant). For example, you can write a string containing the |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
945 nonprinting characters tab and @kbd{C-a}, with commas and spaces between |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
946 them, like this: @code{"\t, \C-a"}. @xref{Character Type}, for a |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
947 description of the read syntax for characters. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
948 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
949 However, not all of the characters you can write with backslash |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
950 escape-sequences are valid in strings. The only control characters that |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
951 a string can hold are the @sc{ascii} control characters. Strings do not |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
952 distinguish case in @sc{ascii} control characters. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
953 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
954 Properly speaking, strings cannot hold meta characters; but when a |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
955 string is to be used as a key sequence, there is a special convention |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
956 that provides a way to represent meta versions of @sc{ascii} characters in a |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
957 string. If you use the @samp{\M-} syntax to indicate a meta character |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
958 in a string constant, this sets the |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
959 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
960 @math{2^{7}} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
961 @end tex |
27193 | 962 @ifnottex |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
963 2**7 |
27193 | 964 @end ifnottex |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
965 bit of the character in the string. If the string is used in |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
966 @code{define-key} or @code{lookup-key}, this numeric code is translated |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
967 into the equivalent meta character. @xref{Character Type}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
968 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
969 Strings cannot hold characters that have the hyper, super, or alt |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
970 modifiers. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
971 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
972 @node Text Props and Strings |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
973 @subsubsection Text Properties in Strings |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
974 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
975 A string can hold properties for the characters it contains, in |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
976 addition to the characters themselves. This enables programs that copy |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
977 text between strings and buffers to copy the text's properties with no |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
978 special effort. @xref{Text Properties}, for an explanation of what text |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
979 properties mean. Strings with text properties use a special read and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
980 print syntax: |
6447 | 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 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
997 that range. For example, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
998 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
999 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1000 #("foo bar" 0 3 (face bold) 3 4 nil 4 7 (face italic)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1001 @end example |
6447 | 1002 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1003 @noindent |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1004 represents a string whose textual contents are @samp{foo bar}, in which |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1005 the first three characters have a @code{face} property with value |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1006 @code{bold}, and the last three have a @code{face} property with value |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1007 @code{italic}. (The fourth character has no text properties, so its |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1008 property list is @code{nil}. It is not actually necessary to mention |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1009 ranges with @code{nil} as the property list, since any characters not |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1010 mentioned in any range will default to having no properties.) |
6447 | 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 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1032 @node Char-Table Type |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1033 @subsection Char-Table Type |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1034 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1035 A @dfn{char-table} is a one-dimensional array of elements of any type, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1036 indexed by character codes. Char-tables have certain extra features to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1037 make them more useful for many jobs that involve assigning information |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1038 to character codes---for example, a char-table can have a parent to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1039 inherit from, a default value, and a small number of extra slots to use for |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1040 special purposes. A char-table can also specify a single value for |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1041 a whole character set. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1042 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1043 The printed representation of a char-table is like a vector |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1044 except that there is an extra @samp{#^} at the beginning. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1045 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1046 @xref{Char-Tables}, for special functions to operate on char-tables. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1047 Uses of char-tables include: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1048 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1049 @itemize @bullet |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1050 @item |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1051 Case tables (@pxref{Case Tables}). |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1052 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1053 @item |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1054 Character category tables (@pxref{Categories}). |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1055 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1056 @item |
38788 | 1057 Display tables (@pxref{Display Tables}). |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1058 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1059 @item |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1060 Syntax tables (@pxref{Syntax Tables}). |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1061 @end itemize |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1062 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1063 @node Bool-Vector Type |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1064 @subsection Bool-Vector Type |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1065 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1066 A @dfn{bool-vector} is a one-dimensional array of elements that |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1067 must be @code{t} or @code{nil}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1068 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1069 The printed representation of a bool-vector is like a string, except |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1070 that it begins with @samp{#&} followed by the length. The string |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1071 constant that follows actually specifies the contents of the bool-vector |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1072 as a bitmap---each ``character'' in the string contains 8 bits, which |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1073 specify the next 8 elements of the bool-vector (1 stands for @code{t}, |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1074 and 0 for @code{nil}). The least significant bits of the character |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1075 correspond to the lowest indices in the bool-vector. If the length is not a |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1076 multiple of 8, the printed representation shows extra elements, but |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1077 these extras really make no difference. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1078 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1079 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1080 (make-bool-vector 3 t) |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1081 @result{} #&3"\007" |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1082 (make-bool-vector 3 nil) |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1083 @result{} #&3"\0" |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1084 ;; @r{These are equal since only the first 3 bits are used.} |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1085 (equal #&3"\377" #&3"\007") |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1086 @result{} t |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1087 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1088 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1089 @node Hash Table Type |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1090 @subsection Hash Table Type |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1091 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1092 A hash table is a very fast kind of lookup table, somewhat like an |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1093 alist in that it maps keys to corresponding values, but much faster. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1094 Hash tables are a new feature in Emacs 21; they have no read syntax, and |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1095 print using hash notation. @xref{Hash Tables}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1096 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1097 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1098 (make-hash-table) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1099 @result{} #<hash-table 'eql nil 0/65 0x83af980> |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1100 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1101 |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
1102 @node Function Type |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
1103 @subsection Function Type |
6447 | 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 | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
1123 @node Macro Type |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
1124 @subsection Macro Type |
6447 | 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 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1128 different argument-passing semantics. A Lisp macro has the form of a |
6447 | 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 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1137 @strong{Warning}: Lisp macros and keyboard macros (@pxref{Keyboard |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1138 Macros}) are entirely different things. When we use the word ``macro'' |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1139 without qualification, we mean a Lisp macro, not a keyboard macro. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1140 |
6447 | 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 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1154 primitive. However, this does matter if you try to redefine a primitive |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1155 with a function written in Lisp. The reason is that the primitive |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1156 function may be called directly from C code. Calls to the redefined |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1157 function from Lisp will use the new definition, but calls from C code |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1158 may still use the built-in definition. Therefore, @strong{we discourage |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1159 redefinition of primitive functions}. |
6447 | 1160 |
1161 The term @dfn{function} refers to all Emacs functions, whether written | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
1162 in Lisp or C. @xref{Function Type}, for information about the |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
1163 functions written in Lisp. |
6447 | 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 | |
12098 | 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{[}. | |
6447 | 1190 |
1191 @node Autoload Type | |
1192 @subsection Autoload Type | |
1193 | |
1194 An @dfn{autoload object} is a list whose first element is the symbol | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1195 @code{autoload}. It is stored as the function definition of a symbol, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1196 where it serves as a placeholder for the real definition. The autoload |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1197 object says that the real definition is found in a file of Lisp code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1198 that should be loaded when necessary. It contains the name of the file, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1199 plus some other information about the real definition. |
6447 | 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 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1215 The types in the previous section are used for general programming |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1216 purposes, and most of them are common to most Lisp dialects. Emacs Lisp |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1217 provides several additional data types for purposes connected with |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1218 editing. |
6447 | 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. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1226 * Frame Configuration Type:: Recording the status of all frames. |
6447 | 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. | |
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 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1245 different. For example, you can insert text efficiently into an |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1246 existing buffer, altering the buffer's contents, whereas ``inserting'' |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1247 text into a string requires concatenating substrings, and the result is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1248 an entirely new string object. |
6447 | 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 | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
1253 buffer in the neighborhood of point. Many of the standard Emacs |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
1254 functions manipulate or test the characters in the current buffer; a |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
1255 whole chapter in this manual is devoted to describing these functions |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
1256 (@pxref{Text}). |
6447 | 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 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1268 a list of buffer-local variable bindings (@pxref{Buffer-Local Variables}). |
12098 | 1269 |
1270 @item | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1271 overlays (@pxref{Overlays}). |
12098 | 1272 |
1273 @item | |
1274 text properties for the text in the buffer (@pxref{Text Properties}). | |
6447 | 1275 @end itemize |
1276 | |
1277 @noindent | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
1278 The local keymap and variable list contain entries that individually |
6447 | 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 | |
12098 | 1283 A buffer may be @dfn{indirect}, which means it shares the text |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1284 of another buffer, but presents it differently. @xref{Indirect Buffers}. |
12098 | 1285 |
1286 Buffers have no read syntax. They print in hash notation, showing the | |
6447 | 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 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1352 A @dfn{frame} is a rectangle on the screen that contains one or more |
6447 | 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) | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1364 @result{} #<frame emacs@@psilocin.gnu.org 0xdac80> |
6447 | 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 | |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
1378 Window configurations do not have a read syntax; their print syntax |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
1379 looks like @samp{#<window-configuration>}. @xref{Window |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
1380 Configurations}, for a description of several functions related to |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
1381 window configurations. |
6447 | 1382 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1383 @node Frame Configuration Type |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1384 @subsection Frame Configuration Type |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1385 @cindex screen layout |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1386 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1387 A @dfn{frame configuration} stores information about the positions, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1388 sizes, and contents of the windows in all frames. It is actually |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1389 a list whose @sc{car} is @code{frame-configuration} and whose |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1390 @sc{cdr} is an alist. Each alist element describes one frame, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1391 which appears as the @sc{car} of that element. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1392 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1393 @xref{Frame Configurations}, for a description of several functions |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1394 related to frame configurations. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1395 |
6447 | 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 | |
7337
cd57cd335fff
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7118
diff
changeset
|
1444 @xref{Read and Print}, for a description of functions |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
1445 related to streams, including parsing and printing functions. |
6447 | 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 | |
1457 @node Overlay Type | |
1458 @subsection Overlay Type | |
1459 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1460 An @dfn{overlay} specifies properties that apply to a part of a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1461 buffer. Each overlay applies to a specified range of the buffer, and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1462 contains a property list (a list whose elements are alternating property |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1463 names and values). Overlay properties are used to present parts of the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1464 buffer temporarily in a different display style. Overlays have no read |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1465 syntax, and print in hash notation, giving the buffer name and range of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1466 positions. |
6447 | 1467 |
12098 | 1468 @xref{Overlays}, for how to create and use overlays. |
6447 | 1469 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1470 @node Circular Objects |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1471 @section Read Syntax for Circular Objects |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1472 @cindex circular structure, read syntax |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1473 @cindex shared structure, read syntax |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1474 @cindex @samp{#@var{n}=} read syntax |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1475 @cindex @samp{#@var{n}#} read syntax |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1476 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1477 In Emacs 21, to represent shared or circular structure within a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1478 complex of Lisp objects, you can use the reader constructs |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1479 @samp{#@var{n}=} and @samp{#@var{n}#}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1480 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1481 Use @code{#@var{n}=} before an object to label it for later reference; |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1482 subsequently, you can use @code{#@var{n}#} to refer the same object in |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1483 another place. Here, @var{n} is some integer. For example, here is how |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1484 to make a list in which the first element recurs as the third element: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1485 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1486 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1487 (#1=(a) b #1#) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1488 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1489 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1490 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1491 This differs from ordinary syntax such as this |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1492 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1493 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1494 ((a) b (a)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1495 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1496 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1497 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1498 which would result in a list whose first and third elements |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1499 look alike but are not the same Lisp object. This shows the difference: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1500 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1501 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1502 (prog1 nil |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1503 (setq x '(#1=(a) b #1#))) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1504 (eq (nth 0 x) (nth 2 x)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1505 @result{} t |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1506 (setq x '((a) b (a))) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1507 (eq (nth 0 x) (nth 2 x)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1508 @result{} nil |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1509 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1510 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1511 You can also use the same syntax to make a circular structure, which |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1512 appears as an ``element'' within itself. Here is an example: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1513 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1514 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1515 #1=(a #1#) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1516 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1517 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1518 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1519 This makes a list whose second element is the list itself. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1520 Here's how you can see that it really works: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1521 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1522 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1523 (prog1 nil |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1524 (setq x '#1=(a #1#))) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1525 (eq x (cadr x)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1526 @result{} t |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1527 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1528 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1529 The Lisp printer can produce this syntax to record circular and shared |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1530 structure in a Lisp object, if you bind the variable @code{print-circle} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1531 to a non-@code{nil} value. @xref{Output Variables}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1532 |
6447 | 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 | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
1549 pass an argument to @code{+} that it cannot handle: |
6447 | 1550 |
1551 @example | |
1552 @group | |
1553 (+ 2 'a) | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1554 @error{} Wrong type argument: number-or-marker-p, a |
6447 | 1555 @end group |
1556 @end example | |
1557 | |
1558 @cindex type predicates | |
1559 @cindex testing types | |
12067 | 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. | |
1565 | |
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. | |
6447 | 1573 |
12067 | 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 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1583 ;; We handle only symbols and lists. |
12067 | 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, | |
6447 | 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 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1597 @item bool-vector-p |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1598 @xref{Bool-Vectors, bool-vector-p}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1599 |
6447 | 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 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1607 @xref{Case Tables, case-table-p}. |
6447 | 1608 |
1609 @item char-or-string-p | |
1610 @xref{Predicates for Strings, char-or-string-p}. | |
1611 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1612 @item char-table-p |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1613 @xref{Char-Tables, char-table-p}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1614 |
6447 | 1615 @item commandp |
1616 @xref{Interactive Call, commandp}. | |
1617 | |
1618 @item consp | |
1619 @xref{List-related Predicates, consp}. | |
1620 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1621 @item display-table-p |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1622 @xref{Display Tables, display-table-p}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1623 |
6447 | 1624 @item floatp |
1625 @xref{Predicates on Numbers, floatp}. | |
1626 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1627 @item frame-configuration-p |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1628 @xref{Frame Configurations, frame-configuration-p}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1629 |
6447 | 1630 @item frame-live-p |
1631 @xref{Deleting Frames, frame-live-p}. | |
1632 | |
1633 @item framep | |
1634 @xref{Frames, framep}. | |
1635 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1636 @item functionp |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1637 @xref{Functions, functionp}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1638 |
6447 | 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 | |
27528 | 1648 @item keywordp |
1649 @xref{Constant Variables}. | |
1650 | |
6447 | 1651 @item listp |
1652 @xref{List-related Predicates, listp}. | |
1653 | |
1654 @item markerp | |
1655 @xref{Predicates on Markers, markerp}. | |
1656 | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
1657 @item wholenump |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
1658 @xref{Predicates on Numbers, wholenump}. |
6447 | 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 | |
12067 | 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 | |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
1715 @var{object}. The value is one of the symbols @code{symbol}, |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
1716 @code{integer}, @code{float}, @code{string}, @code{cons}, @code{vector}, |
26188 | 1717 @code{char-table}, @code{bool-vector}, @code{hash-table}, @code{subr}, |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1718 @code{compiled-function}, @code{marker}, @code{overlay}, @code{window}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1719 @code{buffer}, @code{frame}, @code{process}, or |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
1720 @code{window-configuration}. |
12067 | 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 | |
6447 | 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 | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
1740 types, e.g., strings. For these predicates, see the appropriate chapter |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6447
diff
changeset
|
1741 describing the data type. |
6447 | 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 | |
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 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1797 The @code{make-symbol} function returns an uninterned symbol, distinct |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1798 from the symbol that is used if you write the name in a Lisp expression. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1799 Distinct symbols with the same name are not @code{eq}. @xref{Creating |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1800 Symbols}. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1801 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1802 @example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1803 @group |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1804 (eq (make-symbol "foo") 'foo) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1805 @result{} nil |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1806 @end group |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1807 @end example |
6447 | 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 | |
26188 | 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. | |
6447 | 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 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1867 Comparison of strings is case-sensitive, but does not take account of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1868 text properties---it compares only the characters in the strings. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1869 A unibyte string never equals a multibyte string unless the |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1870 contents are entirely @sc{ascii} (@pxref{Text Representations}). |
6447 | 1871 |
1872 @example | |
1873 @group | |
1874 (equal "asdf" "ASDF") | |
1875 @result{} nil | |
1876 @end group | |
1877 @end example | |
12098 | 1878 |
26188 | 1879 However, two distinct buffers are never considered @code{equal}, even if |
1880 their textual contents are the same. | |
6447 | 1881 @end defun |
1882 | |
26188 | 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). |