annotate lispref/objects.texi @ 54037:96796d3ede2e

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