Mercurial > hg > xemacs-beta
annotate man/lispref/objects.texi @ 5444:388762703a21
Added copyright notices and GPLv3 license to PROBLEMS and Emacs.ad.
| author | Mats Lidell <matsl@xemacs.org> |
|---|---|
| date | Sun, 26 Dec 2010 01:48:40 +0100 |
| parents | 02d875ebd1ea |
| children | f5a5501814f5 |
| rev | line source |
|---|---|
| 428 | 1 @c -*-texinfo-*- |
| 2 @c This is part of the XEmacs Lisp Reference Manual. | |
| 3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc. | |
| 4 @c See the file lispref.texi for copying conditions. | |
| 5 @setfilename ../../info/objects.info | |
| 693 | 6 @node Lisp Data Types, Numbers, Packaging, Top |
| 428 | 7 @chapter Lisp Data Types |
| 8 @cindex object | |
| 9 @cindex Lisp object | |
| 10 @cindex type | |
| 11 @cindex data type | |
| 12 | |
| 13 A Lisp @dfn{object} is a piece of data used and manipulated by Lisp | |
| 14 programs. For our purposes, a @dfn{type} or @dfn{data type} is a set of | |
| 15 possible objects. | |
| 16 | |
| 17 Every object belongs to at least one type. Objects of the same type | |
| 18 have similar structures and may usually be used in the same contexts. | |
| 19 Types can overlap, and objects can belong to two or more types. | |
| 20 Consequently, we can ask whether an object belongs to a particular type, | |
| 21 but not for ``the'' type of an object. | |
| 22 | |
| 23 @cindex primitive type | |
| 24 A few fundamental object types are built into XEmacs. These, from | |
| 25 which all other types are constructed, are called @dfn{primitive types}. | |
| 26 Each object belongs to one and only one primitive type. These types | |
| 27 include @dfn{integer}, @dfn{character} (starting with XEmacs 20.0), | |
| 28 @dfn{float}, @dfn{cons}, @dfn{symbol}, @dfn{string}, @dfn{vector}, | |
| 29 @dfn{bit-vector}, @dfn{subr}, @dfn{compiled-function}, @dfn{hash-table}, | |
| 30 @dfn{range-table}, @dfn{char-table}, @dfn{weak-list}, and several | |
| 31 special types, such as @dfn{buffer}, that are related to editing. | |
| 32 (@xref{Editing Types}.) | |
| 33 | |
| 34 Each primitive type has a corresponding Lisp function that checks | |
| 35 whether an object is a member of that type. | |
| 36 | |
| 37 Note that Lisp is unlike many other languages in that Lisp objects are | |
| 38 @dfn{self-typing}: the primitive type of the object is implicit in the | |
| 39 object itself. For example, if an object is a vector, nothing can treat | |
| 40 it as a number; Lisp knows it is a vector, not a number. | |
| 41 | |
| 42 In most languages, the programmer must declare the data type of each | |
| 43 variable, and the type is known by the compiler but not represented in | |
| 44 the data. Such type declarations do not exist in XEmacs Lisp. A Lisp | |
| 45 variable can have any type of value, and it remembers whatever value | |
| 46 you store in it, type and all. | |
| 47 | |
| 48 This chapter describes the purpose, printed representation, and read | |
| 49 syntax of each of the standard types in Emacs Lisp. Details on how | |
| 50 to use these types can be found in later chapters. | |
| 51 | |
| 52 @menu | |
| 53 * Printed Representation:: How Lisp objects are represented as text. | |
| 54 * Comments:: Comments and their formatting conventions. | |
| 55 * Primitive Types:: List of all primitive types in XEmacs. | |
| 56 * Programming Types:: Types found in all Lisp systems. | |
| 57 * Editing Types:: Types specific to XEmacs. | |
| 58 * Window-System Types:: Types specific to windowing systems. | |
| 59 * Type Predicates:: Tests related to types. | |
| 60 * Equality Predicates:: Tests of equality between any two objects. | |
| 61 @end menu | |
| 62 | |
| 63 @node Printed Representation | |
| 64 @section Printed Representation and Read Syntax | |
| 65 @cindex printed representation | |
| 66 @cindex read syntax | |
| 67 | |
| 68 The @dfn{printed representation} of an object is the format of the | |
| 69 output generated by the Lisp printer (the function @code{prin1}) for | |
| 70 that object. The @dfn{read syntax} of an object is the format of the | |
| 71 input accepted by the Lisp reader (the function @code{read}) for that | |
| 72 object. Most objects have more than one possible read syntax. Some | |
| 73 types of object have no read syntax; except for these cases, the printed | |
| 74 representation of an object is also a read syntax for it. | |
| 75 | |
| 76 In other languages, an expression is text; it has no other form. In | |
| 77 Lisp, an expression is primarily a Lisp object and only secondarily the | |
| 78 text that is the object's read syntax. Often there is no need to | |
| 79 emphasize this distinction, but you must keep it in the back of your | |
| 80 mind, or you will occasionally be very confused. | |
| 81 | |
| 82 @cindex hash notation | |
| 83 Every type has a printed representation. Some types have no read | |
| 84 syntax, since it may not make sense to enter objects of these types | |
| 85 directly in a Lisp program. For example, the buffer type does not have | |
| 86 a read syntax. Objects of these types are printed in @dfn{hash | |
| 87 notation}: the characters @samp{#<} followed by a descriptive string | |
| 88 (typically the type name followed by the name of the object), and closed | |
| 89 with a matching @samp{>}. Hash notation cannot be read at all, so the | |
| 90 Lisp reader signals the error @code{invalid-read-syntax} whenever it | |
| 91 encounters @samp{#<}. | |
| 92 @kindex invalid-read-syntax | |
| 93 | |
| 94 @example | |
| 95 (current-buffer) | |
| 96 @result{} #<buffer "objects.texi"> | |
| 97 @end example | |
| 98 | |
| 99 When you evaluate an expression interactively, the Lisp interpreter | |
| 100 first reads the textual representation of it, producing a Lisp object, | |
| 101 and then evaluates that object (@pxref{Evaluation}). However, | |
| 102 evaluation and reading are separate activities. Reading returns the | |
| 103 Lisp object represented by the text that is read; the object may or may | |
| 104 not be evaluated later. @xref{Input Functions}, for a description of | |
| 105 @code{read}, the basic function for reading objects. | |
| 106 | |
| 107 @node Comments | |
| 108 @section Comments | |
| 109 @cindex comments | |
| 110 @cindex @samp{;} in comment | |
| 111 | |
| 112 A @dfn{comment} is text that is written in a program only for the sake | |
| 113 of humans that read the program, and that has no effect on the meaning | |
| 114 of the program. In Lisp, a semicolon (@samp{;}) starts a comment if it | |
| 115 is not within a string or character constant. The comment continues to | |
| 116 the end of line. The Lisp reader discards comments; they do not become | |
| 117 part of the Lisp objects which represent the program within the Lisp | |
| 118 system. | |
| 119 | |
| 120 The @samp{#@@@var{count}} construct, which skips the next @var{count} | |
| 121 characters, is useful for program-generated comments containing binary | |
| 122 data. The XEmacs Lisp byte compiler uses this in its output files | |
| 123 (@pxref{Byte Compilation}). It isn't meant for source files, however. | |
| 124 | |
| 125 @xref{Comment Tips}, for conventions for formatting comments. | |
| 126 | |
| 127 @node Primitive Types | |
| 128 @section Primitive Types | |
| 129 @cindex primitive types | |
| 130 | |
| 131 For reference, here is a list of all the primitive types that may | |
| 132 exist in XEmacs. Note that some of these types may not exist | |
| 133 in some XEmacs executables; that depends on the options that | |
| 134 XEmacs was configured with. | |
| 135 | |
| 136 @itemize @bullet | |
| 137 @item | |
| 138 bit-vector | |
| 139 @item | |
| 140 buffer | |
| 141 @item | |
| 142 char-table | |
| 143 @item | |
| 144 character | |
| 145 @item | |
| 146 charset | |
| 147 @item | |
| 148 coding-system | |
| 149 @item | |
| 150 cons | |
| 151 @item | |
| 152 color-instance | |
| 153 @item | |
| 154 compiled-function | |
| 155 @item | |
| 156 console | |
| 157 @item | |
| 158 database | |
| 159 @item | |
| 160 device | |
| 161 @item | |
| 162 event | |
| 163 @item | |
| 164 extent | |
| 165 @item | |
| 166 face | |
| 167 @item | |
| 168 float | |
| 169 @item | |
| 170 font-instance | |
| 171 @item | |
| 172 frame | |
| 173 @item | |
| 174 glyph | |
| 175 @item | |
| 176 hash-table | |
| 177 @item | |
| 178 image-instance | |
| 179 @item | |
| 180 integer | |
| 181 @item | |
| 182 keymap | |
| 183 @item | |
| 184 marker | |
| 185 @item | |
| 186 process | |
| 187 @item | |
| 188 range-table | |
| 189 @item | |
| 190 specifier | |
| 191 @item | |
| 192 string | |
| 193 @item | |
| 194 subr | |
| 195 @item | |
| 196 subwindow | |
| 197 @item | |
| 198 symbol | |
| 199 @item | |
| 200 toolbar-button | |
| 201 @item | |
| 202 tooltalk-message | |
| 203 @item | |
| 204 tooltalk-pattern | |
| 205 @item | |
| 206 vector | |
| 207 @item | |
| 208 weak-list | |
| 209 @item | |
| 210 window | |
| 211 @item | |
| 212 window-configuration | |
| 213 @item | |
| 214 x-resource | |
| 215 @end itemize | |
| 216 | |
| 217 In addition, the following special types are created internally | |
| 218 but will never be seen by Lisp code. You may encounter them, | |
| 219 however, if you are debugging XEmacs. The printed representation | |
| 220 of these objects begins @samp{#<INTERNAL EMACS BUG}, which indicates | |
| 221 to the Lisp programmer that he has found an internal bug in XEmacs | |
| 222 if he ever encounters any of these objects. | |
| 223 | |
| 224 @itemize @bullet | |
| 225 @item | |
| 226 char-table-entry | |
| 227 @item | |
| 228 command-builder | |
| 229 @item | |
| 230 extent-auxiliary | |
| 231 @item | |
| 232 extent-info | |
| 233 @item | |
| 234 lcrecord-list | |
| 235 @item | |
| 236 lstream | |
| 237 @item | |
| 238 opaque | |
| 239 @item | |
| 240 opaque-list | |
| 241 @item | |
| 242 popup-data | |
| 243 @item | |
| 244 symbol-value-buffer-local | |
| 245 @item | |
| 246 symbol-value-forward | |
| 247 @item | |
| 248 symbol-value-lisp-magic | |
| 249 @item | |
| 250 symbol-value-varalias | |
| 251 @item | |
| 252 toolbar-data | |
| 253 @end itemize | |
| 254 | |
| 255 @node Programming Types | |
| 256 @section Programming Types | |
| 257 @cindex programming types | |
| 258 | |
| 259 There are two general categories of types in XEmacs Lisp: those having | |
| 260 to do with Lisp programming, and those having to do with editing. The | |
| 261 former exist in many Lisp implementations, in one form or another. The | |
| 262 latter are unique to XEmacs Lisp. | |
| 263 | |
| 264 @menu | |
| 265 * Integer Type:: Numbers without fractional parts. | |
| 266 * Floating Point Type:: Numbers with fractional parts and with a large range. | |
| 267 * Character Type:: The representation of letters, numbers and | |
| 268 control characters. | |
| 269 * Symbol Type:: A multi-use object that refers to a function, | |
| 270 variable, or property list, and has a unique identity. | |
| 271 * Sequence Type:: Both lists and arrays are classified as sequences. | |
| 272 * Cons Cell Type:: Cons cells, and lists (which are made from cons cells). | |
| 273 * Array Type:: Arrays include strings and vectors. | |
| 274 * String Type:: An (efficient) array of characters. | |
| 275 * Vector Type:: One-dimensional arrays. | |
| 276 * Bit Vector Type:: An (efficient) array of bits. | |
| 277 * Function Type:: A piece of executable code you can call from elsewhere. | |
| 278 * Macro Type:: A method of expanding an expression into another | |
| 279 expression, more fundamental but less pretty. | |
| 280 * Primitive Function Type:: A function written in C, callable from Lisp. | |
| 281 * Compiled-Function Type:: A function written in Lisp, then compiled. | |
| 282 * Autoload Type:: A type used for automatically loading seldom-used | |
| 283 functions. | |
| 284 * Char Table Type:: A mapping from characters to Lisp objects. | |
| 285 * Hash Table Type:: A fast mapping between Lisp objects. | |
| 286 * Range Table Type:: A mapping from ranges of integers to Lisp objects. | |
| 287 * Weak List Type:: A list with special garbage-collection properties. | |
| 288 @end menu | |
| 289 | |
| 290 @node Integer Type | |
| 291 @subsection Integer Type | |
| 292 | |
|
4885
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
293 In XEmacs Lisp, integers can be fixnums (that is, fixed-precision |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
294 integers) or bignums (arbitrary-precision integers), if compile-time |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
295 configuration supports this. The read syntax for the two types is the |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
296 same, the type chosen depending on the numeric values involved. |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
297 |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
298 The range of values for fixnums in XEmacs Lisp is given by the |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
299 constants @code{most-positive-fixnum} and @code{most-negative-fixnum}. |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
300 On 32-bit machines, these constants reflect 31 value bits, ranging from |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
301 @minus{}1073741824 to 1073741823. |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
302 |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
303 In the absence of @xref{The Bignum Extension}, XEmacs Lisp |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
304 arithmetic functions do not check for overflow; so the code snippet |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
305 @code{(= most-negative-fixnum (1+ most-positive-fixnum))} will give |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
306 @code{t}. However, you @emph{will} get an error if you attempt to read |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
307 an out-of-range number using the Lisp reader. |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
308 |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
309 The main read syntax for integers is a sequence of base ten digits |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
310 with an optional sign at the beginning. (The printed representation |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
311 produced by the Lisp interpreter never has a leading @samp{+}.) |
| 428 | 312 |
| 313 @example | |
| 314 @group | |
| 315 -1 ; @r{The integer -1.} | |
| 316 1 ; @r{The integer 1.} | |
| 317 +1 ; @r{Also the integer 1.} | |
| 318 268435457 ; @r{Causes an error on a 28-bit implementation.} | |
| 319 @end group | |
| 320 @end example | |
| 321 | |
| 322 @xref{Numbers}, for more information. | |
| 323 | |
| 324 @node Floating Point Type | |
| 325 @subsection Floating Point Type | |
| 326 | |
| 327 XEmacs supports floating point numbers. The precise range of floating | |
| 328 point numbers is machine-specific. | |
| 329 | |
| 330 The printed representation for floating point numbers requires either | |
| 331 a decimal point (with at least one digit following), an exponent, or | |
| 332 both. For example, @samp{1500.0}, @samp{15e2}, @samp{15.0e2}, | |
| 333 @samp{1.5e3}, and @samp{.15e4} are five ways of writing a floating point | |
| 334 number whose value is 1500. They are all equivalent. | |
| 335 | |
| 336 @xref{Numbers}, for more information. | |
| 337 | |
| 338 @node Character Type | |
| 339 @subsection Character Type | |
| 340 @cindex @sc{ascii} character codes | |
| 341 @cindex char-int confoundance disease | |
| 342 | |
| 343 In XEmacs version 19, and in all versions of FSF GNU Emacs, a | |
| 344 @dfn{character} in XEmacs Lisp is nothing more than an integer. | |
| 345 This is yet another holdover from XEmacs Lisp's derivation from | |
| 346 vintage-1980 Lisps; modern versions of Lisp consider this equivalence | |
| 347 a bad idea, and have separate character types. In XEmacs version 20, | |
| 348 the modern convention is followed, and characters are their own | |
| 349 primitive types. (This change was necessary in order for @sc{mule}, | |
| 350 i.e. Asian-language, support to be correctly implemented.) | |
| 351 | |
| 352 Even in XEmacs version 20, remnants of the equivalence between | |
| 353 characters and integers still exist; this is termed the @dfn{char-int | |
| 354 confoundance disease}. In particular, many functions such as @code{eq}, | |
| 355 @code{equal}, and @code{memq} have equivalent functions (@code{old-eq}, | |
| 356 @code{old-equal}, @code{old-memq}, etc.) that pretend like characters | |
| 357 are integers are the same. Byte code compiled under any version 19 | |
| 358 Emacs will have all such functions mapped to their @code{old-} equivalents | |
| 359 when the byte code is read into XEmacs 20. This is to preserve | |
| 440 | 360 compatibility---Emacs 19 converts all constant characters to the equivalent |
| 428 | 361 integer during byte-compilation, and thus there is no other way to preserve |
| 362 byte-code compatibility even if the code has specifically been written | |
| 363 with the distinction between characters and integers in mind. | |
| 364 | |
| 365 Every character has an equivalent integer, called the @dfn{character | |
| 366 code}. For example, the character @kbd{A} is represented as the | |
| 367 @w{integer 65}, following the standard @sc{ascii} representation of | |
| 368 characters. If XEmacs was not compiled with @sc{mule} support, the | |
| 440 | 369 range of this integer will always be 0 to 255---eight bits, or one |
| 428 | 370 byte. (Integers outside this range are accepted but silently truncated; |
| 371 however, you should most decidedly @emph{not} rely on this, because it | |
| 372 will not work under XEmacs with @sc{mule} support.) When @sc{mule} | |
| 373 support is present, the range of character codes is much | |
| 374 larger. (Currently, 19 bits are used.) | |
| 375 | |
| 376 FSF GNU Emacs uses kludgy character codes above 255 to represent | |
| 377 keyboard input of @sc{ascii} characters in combination with certain | |
| 378 modifiers. XEmacs does not use this (a more general mechanism is | |
| 379 used that does not distinguish between @sc{ascii} keys and other | |
| 380 keys), so you will never find character codes above 255 in a | |
| 381 non-@sc{mule} XEmacs. | |
| 382 | |
| 383 Individual characters are not often used in programs. It is far more | |
| 384 common to work with @emph{strings}, which are sequences composed of | |
| 385 characters. @xref{String Type}. | |
| 386 | |
| 387 @cindex read syntax for characters | |
| 388 @cindex printed representation for characters | |
| 389 @cindex syntax for characters | |
| 390 | |
| 391 The read syntax for characters begins with a question mark, followed | |
| 392 by the character (if it's printable) or some symbolic representation of | |
| 393 it. In XEmacs 20, where characters are their own type, this is also the | |
| 394 print representation. In XEmacs 19, however, where characters are | |
| 395 really integers, the printed representation of a character is a decimal | |
| 396 number. This is also a possible read syntax for a character, but | |
| 397 writing characters that way in Lisp programs is a very bad idea. You | |
| 398 should @emph{always} use the special read syntax formats that XEmacs Lisp | |
| 399 provides for characters. | |
| 400 | |
| 401 The usual read syntax for alphanumeric characters is a question mark | |
| 402 followed by the character; thus, @samp{?A} for the character | |
| 403 @kbd{A}, @samp{?B} for the character @kbd{B}, and @samp{?a} for the | |
| 404 character @kbd{a}. | |
| 405 | |
| 406 For example: | |
| 407 | |
| 408 @example | |
| 409 ;; @r{Under XEmacs 20:} | |
| 410 ?Q @result{} ?Q ?q @result{} ?q | |
| 411 (char-int ?Q) @result{} 81 | |
| 412 ;; @r{Under XEmacs 19:} | |
| 413 ?Q @result{} 81 ?q @result{} 113 | |
| 414 @end example | |
| 415 | |
| 416 You can use the same syntax for punctuation characters, but it is | |
| 417 often a good idea to add a @samp{\} so that the Emacs commands for | |
| 418 editing Lisp code don't get confused. For example, @samp{?\ } is the | |
| 419 way to write the space character. If the character is @samp{\}, you | |
| 420 @emph{must} use a second @samp{\} to quote it: @samp{?\\}. XEmacs 20 | |
| 421 always prints punctuation characters with a @samp{\} in front of them, | |
| 422 to avoid confusion. | |
| 423 | |
| 424 @cindex whitespace | |
| 425 @cindex bell character | |
| 426 @cindex @samp{\a} | |
| 427 @cindex backspace | |
| 428 @cindex @samp{\b} | |
| 429 @cindex tab | |
| 430 @cindex @samp{\t} | |
| 431 @cindex vertical tab | |
| 432 @cindex @samp{\v} | |
| 433 @cindex formfeed | |
| 434 @cindex @samp{\f} | |
| 435 @cindex newline | |
| 436 @cindex @samp{\n} | |
| 437 @cindex return | |
| 438 @cindex @samp{\r} | |
| 439 @cindex escape | |
| 440 @cindex @samp{\e} | |
| 441 You can express the characters Control-g, backspace, tab, newline, | |
| 442 vertical tab, formfeed, return, and escape as @samp{?\a}, @samp{?\b}, | |
| 443 @samp{?\t}, @samp{?\n}, @samp{?\v}, @samp{?\f}, @samp{?\r}, @samp{?\e}, | |
| 444 respectively. Their character codes are 7, 8, 9, 10, 11, 12, 13, and 27 | |
| 445 in decimal. Thus, | |
| 446 | |
| 447 @example | |
| 448 ;; @r{Under XEmacs 20:} | |
| 449 ?\a @result{} ?\^G ; @r{@kbd{C-g}} | |
| 450 (char-int ?\a) @result{} 7 | |
| 451 ?\b @result{} ?\^H ; @r{backspace, @key{BS}, @kbd{C-h}} | |
| 452 (char-int ?\b) @result{} 8 | |
| 453 ?\t @result{} ?\t ; @r{tab, @key{TAB}, @kbd{C-i}} | |
| 454 (char-int ?\t) @result{} 9 | |
| 455 ?\n @result{} ?\n ; @r{newline, @key{LFD}, @kbd{C-j}} | |
| 456 ?\v @result{} ?\^K ; @r{vertical tab, @kbd{C-k}} | |
| 457 ?\f @result{} ?\^L ; @r{formfeed character, @kbd{C-l}} | |
| 458 ?\r @result{} ?\r ; @r{carriage return, @key{RET}, @kbd{C-m}} | |
| 459 ?\e @result{} ?\^[ ; @r{escape character, @key{ESC}, @kbd{C-[}} | |
| 460 ?\\ @result{} ?\\ ; @r{backslash character, @kbd{\}} | |
| 461 ;; @r{Under XEmacs 19:} | |
| 462 ?\a @result{} 7 ; @r{@kbd{C-g}} | |
| 463 ?\b @result{} 8 ; @r{backspace, @key{BS}, @kbd{C-h}} | |
| 464 ?\t @result{} 9 ; @r{tab, @key{TAB}, @kbd{C-i}} | |
| 465 ?\n @result{} 10 ; @r{newline, @key{LFD}, @kbd{C-j}} | |
| 466 ?\v @result{} 11 ; @r{vertical tab, @kbd{C-k}} | |
| 467 ?\f @result{} 12 ; @r{formfeed character, @kbd{C-l}} | |
| 468 ?\r @result{} 13 ; @r{carriage return, @key{RET}, @kbd{C-m}} | |
| 469 ?\e @result{} 27 ; @r{escape character, @key{ESC}, @kbd{C-[}} | |
| 470 ?\\ @result{} 92 ; @r{backslash character, @kbd{\}} | |
| 471 @end example | |
| 472 | |
| 473 @cindex escape sequence | |
| 474 These sequences which start with backslash are also known as | |
| 475 @dfn{escape sequences}, because backslash plays the role of an escape | |
| 476 character; this usage has nothing to do with the character @key{ESC}. | |
| 477 | |
| 478 @cindex control characters | |
| 479 Control characters may be represented using yet another read syntax. | |
| 480 This consists of a question mark followed by a backslash, caret, and the | |
| 481 corresponding non-control character, in either upper or lower case. For | |
| 482 example, both @samp{?\^I} and @samp{?\^i} are valid read syntax for the | |
| 483 character @kbd{C-i}, the character whose value is 9. | |
| 484 | |
| 485 Instead of the @samp{^}, you can use @samp{C-}; thus, @samp{?\C-i} is | |
| 486 equivalent to @samp{?\^I} and to @samp{?\^i}: | |
| 487 | |
| 488 @example | |
| 489 ;; @r{Under XEmacs 20:} | |
| 490 ?\^I @result{} ?\t ?\C-I @result{} ?\t | |
| 491 (char-int ?\^I) @result{} 9 | |
| 492 ;; @r{Under XEmacs 19:} | |
| 493 ?\^I @result{} 9 ?\C-I @result{} 9 | |
| 494 @end example | |
| 495 | |
| 496 There is also a character read syntax beginning with @samp{\M-}. This | |
| 497 sets the high bit of the character code (same as adding 128 to the | |
| 498 character code). For example, @samp{?\M-A} stands for the character | |
| 499 with character code 193, or 128 plus 65. You should @emph{not} use this | |
| 500 syntax in your programs. It is a holdover of yet another confoundance | |
| 501 disease from earlier Emacsen. (This was used to represent keyboard input | |
| 502 with the @key{META} key set, thus the @samp{M}; however, it conflicts | |
| 503 with the legitimate @sc{iso}-8859-1 interpretation of the character code. | |
| 504 For example, character code 193 is a lowercase @samp{a} with an acute | |
| 505 accent, in @sc{iso}-8859-1.) | |
| 506 | |
| 3367 | 507 @cindex unicode character escape |
| 508 From version 21.5.25 onwards, XEmacs provides a syntax for specifying | |
| 509 characters by their Unicode code points. @samp{?\uABCD} will give you | |
| 510 an XEmacs character that maps to the code point @samp{U+ABCD} in | |
| 511 Unicode-based representations (UTF-8 text files, Unicode-oriented fonts, | |
| 512 etc.) Just as in the C# language, there is a slightly different syntax | |
| 513 for specifying characters with code points above @samp{#xFFFF}; | |
| 514 @samp{\U00ABCDEF} will give you an XEmacs character that maps to the | |
| 515 code point @samp{U+ABCDEF} in Unicode-based representations, if such an | |
| 516 XEmacs character exists. | |
| 517 | |
| 518 Unlike in C#, while this syntax is available for character literals, | |
| 519 and (see later) in strings, it is not available elsewhere in your Lisp | |
| 520 source code. | |
| 521 | |
| 428 | 522 @ignore @c None of this crap applies to XEmacs. |
| 523 For use in strings and buffers, you are limited to the control | |
| 524 characters that exist in @sc{ascii}, but for keyboard input purposes, | |
| 525 you can turn any character into a control character with @samp{C-}. The | |
| 526 character codes for these non-@sc{ascii} control characters include the | |
| 527 @iftex | |
| 528 $2^{26}$ | |
| 529 @end iftex | |
| 530 @ifinfo | |
| 531 2**26 | |
| 532 @end ifinfo | |
| 533 bit as well as the code for the corresponding non-control | |
| 534 character. Ordinary terminals have no way of generating non-@sc{ASCII} | |
| 535 control characters, but you can generate them straightforwardly using an | |
| 536 X terminal. | |
| 537 | |
| 538 For historical reasons, Emacs treats the @key{DEL} character as | |
| 539 the control equivalent of @kbd{?}: | |
| 540 | |
| 541 @example | |
| 542 ?\^? @result{} 127 ?\C-? @result{} 127 | |
| 543 @end example | |
| 544 | |
| 545 @noindent | |
| 546 As a result, it is currently not possible to represent the character | |
| 547 @kbd{Control-?}, which is a meaningful input character under X. It is | |
| 548 not easy to change this as various Lisp files refer to @key{DEL} in this | |
| 549 way. | |
| 550 | |
| 551 For representing control characters to be found in files or strings, | |
| 552 we recommend the @samp{^} syntax; for control characters in keyboard | |
| 553 input, we prefer the @samp{C-} syntax. This does not affect the meaning | |
| 554 of the program, but may guide the understanding of people who read it. | |
| 555 | |
| 556 @cindex meta characters | |
| 557 A @dfn{meta character} is a character typed with the @key{META} | |
| 558 modifier key. The integer that represents such a character has the | |
| 559 @iftex | |
| 560 $2^{27}$ | |
| 561 @end iftex | |
| 562 @ifinfo | |
| 563 2**27 | |
| 564 @end ifinfo | |
| 565 bit set (which on most machines makes it a negative number). We | |
| 566 use high bits for this and other modifiers to make possible a wide range | |
| 567 of basic character codes. | |
| 568 | |
| 569 In a string, the | |
| 570 @iftex | |
| 571 $2^{7}$ | |
| 572 @end iftex | |
| 573 @ifinfo | |
| 574 2**7 | |
| 575 @end ifinfo | |
| 576 bit indicates a meta character, so the meta | |
| 577 characters that can fit in a string have codes in the range from 128 to | |
| 578 255, and are the meta versions of the ordinary @sc{ASCII} characters. | |
| 579 (In Emacs versions 18 and older, this convention was used for characters | |
| 580 outside of strings as well.) | |
| 581 | |
| 582 The read syntax for meta characters uses @samp{\M-}. For example, | |
| 583 @samp{?\M-A} stands for @kbd{M-A}. You can use @samp{\M-} together with | |
| 584 octal character codes (see below), with @samp{\C-}, or with any other | |
| 585 syntax for a character. Thus, you can write @kbd{M-A} as @samp{?\M-A}, | |
| 586 or as @samp{?\M-\101}. Likewise, you can write @kbd{C-M-b} as | |
| 587 @samp{?\M-\C-b}, @samp{?\C-\M-b}, or @samp{?\M-\002}. | |
| 588 | |
| 589 The case of an ordinary letter is indicated by its character code as | |
| 590 part of @sc{ASCII}, but @sc{ASCII} has no way to represent whether a | |
| 591 control character is upper case or lower case. Emacs uses the | |
| 592 @iftex | |
| 593 $2^{25}$ | |
| 594 @end iftex | |
| 595 @ifinfo | |
| 596 2**25 | |
| 597 @end ifinfo | |
| 598 bit to indicate that the shift key was used for typing a control | |
| 599 character. This distinction is possible only when you use X terminals | |
| 600 or other special terminals; ordinary terminals do not indicate the | |
| 601 distinction to the computer in any way. | |
| 602 | |
| 603 @cindex hyper characters | |
| 604 @cindex super characters | |
| 605 @cindex alt characters | |
| 606 The X Window System defines three other modifier bits that can be set | |
| 607 in a character: @dfn{hyper}, @dfn{super} and @dfn{alt}. The syntaxes | |
| 608 for these bits are @samp{\H-}, @samp{\s-} and @samp{\A-}. Thus, | |
| 609 @samp{?\H-\M-\A-x} represents @kbd{Alt-Hyper-Meta-x}. | |
| 610 @iftex | |
| 611 Numerically, the | |
| 612 bit values are $2^{22}$ for alt, $2^{23}$ for super and $2^{24}$ for hyper. | |
| 613 @end iftex | |
| 614 @ifinfo | |
| 615 Numerically, the | |
| 616 bit values are 2**22 for alt, 2**23 for super and 2**24 for hyper. | |
| 617 @end ifinfo | |
| 618 @end ignore | |
| 619 | |
| 620 @cindex @samp{?} in character constant | |
| 621 @cindex question mark in character constant | |
| 622 @cindex @samp{\} in character constant | |
| 623 @cindex backslash in character constant | |
| 624 @cindex octal character code | |
| 1549 | 625 @cindex hexadecimal character code |
|
5247
02d875ebd1ea
Make Lisp reader errors more informative with over-long hex, octal characters
Aidan Kehoe <kehoea@parhasard.net>
parents:
4905
diff
changeset
|
626 @cindex Overlong hex character escape |
|
02d875ebd1ea
Make Lisp reader errors more informative with over-long hex, octal characters
Aidan Kehoe <kehoea@parhasard.net>
parents:
4905
diff
changeset
|
627 @cindex Non-ISO-8859-1 octal character escape |
| 3367 | 628 |
| 1549 | 629 Finally, there are two read syntaxes involving character codes. |
| 630 It is not possible to represent multibyte or wide characters in this | |
| 631 way; the permissible range of codes is from 0 to 255 (@emph{i.e.}, | |
| 632 @samp{0377} octal or @samp{0xFF} hexadecimal). If you wish to convert | |
| 633 code points to other characters, you must use the @samp{make-char} or | |
| 634 @samp{unicode-to-char} primitives in Mule. (Non-Mule XEmacsen cannot | |
| 635 represent codes out of that range at all, although you can set the font | |
| 636 to a registry other than ISO 8859/1 to get the appearance of a greater | |
| 637 range of characters.) Although these syntaxes can represent any | |
| 638 @sc{ascii} or Latin-1 character, they are preferred only when the | |
| 639 precise integral value is more important than the @sc{ascii} | |
| 640 representation. | |
| 641 | |
| 642 The first consists of a question mark | |
| 428 | 643 followed by a backslash and the character code in octal (up to three |
| 644 octal digits); thus, @samp{?\101} for the character @kbd{A}, | |
| 645 @samp{?\001} for the character @kbd{C-a}, and @code{?\002} for the | |
|
4486
f9104f0e9b91
Document the error on over-long hex character constants.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4472
diff
changeset
|
646 character @kbd{C-b}. The reader will finalize the character and start |
|
f9104f0e9b91
Document the error on over-long hex character constants.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4472
diff
changeset
|
647 reading the next token when a non-octal-digit is encountered or three |
|
5247
02d875ebd1ea
Make Lisp reader errors more informative with over-long hex, octal characters
Aidan Kehoe <kehoea@parhasard.net>
parents:
4905
diff
changeset
|
648 octal digits are read. When a given character code is above |
|
02d875ebd1ea
Make Lisp reader errors more informative with over-long hex, octal characters
Aidan Kehoe <kehoea@parhasard.net>
parents:
4905
diff
changeset
|
649 @code{#o377}, the Lisp reader signals an @code{invalid-read-syntax} |
|
02d875ebd1ea
Make Lisp reader errors more informative with over-long hex, octal characters
Aidan Kehoe <kehoea@parhasard.net>
parents:
4905
diff
changeset
|
650 error. Such errors are typically provoked by code written for older |
|
02d875ebd1ea
Make Lisp reader errors more informative with over-long hex, octal characters
Aidan Kehoe <kehoea@parhasard.net>
parents:
4905
diff
changeset
|
651 versions of GNU Emacs, where the absence of the #o octal syntax for |
|
02d875ebd1ea
Make Lisp reader errors more informative with over-long hex, octal characters
Aidan Kehoe <kehoea@parhasard.net>
parents:
4905
diff
changeset
|
652 integers made the character syntax convenient for non-character |
|
02d875ebd1ea
Make Lisp reader errors more informative with over-long hex, octal characters
Aidan Kehoe <kehoea@parhasard.net>
parents:
4905
diff
changeset
|
653 values. Those older versions of GNU Emacs are long obsolete, so |
|
02d875ebd1ea
Make Lisp reader errors more informative with over-long hex, octal characters
Aidan Kehoe <kehoea@parhasard.net>
parents:
4905
diff
changeset
|
654 changing the code to use the #o integer escape is the best |
|
02d875ebd1ea
Make Lisp reader errors more informative with over-long hex, octal characters
Aidan Kehoe <kehoea@parhasard.net>
parents:
4905
diff
changeset
|
655 solution. @pxref{Numbers}. |
| 1549 | 656 |
| 657 The second consists of a question mark followed by a backslash, the | |
| 658 character @samp{x}, and the character code in hexadecimal (up to two | |
| 659 hexadecimal digits); thus, @samp{?\x41} for the character @kbd{A}, | |
| 660 @samp{?\x1} for the character @kbd{C-a}, and @code{?\x2} for the | |
|
4486
f9104f0e9b91
Document the error on over-long hex character constants.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4472
diff
changeset
|
661 character @kbd{C-b}. If more than two hexadecimal codes are given, the |
|
5247
02d875ebd1ea
Make Lisp reader errors more informative with over-long hex, octal characters
Aidan Kehoe <kehoea@parhasard.net>
parents:
4905
diff
changeset
|
662 reader signals an @code{invalid-read-syntax} error. |
| 428 | 663 |
| 664 @example | |
| 665 @group | |
| 666 ;; @r{Under XEmacs 20:} | |
| 667 ?\012 @result{} ?\n ?\n @result{} ?\n ?\C-j @result{} ?\n | |
| 1549 | 668 ?\101 @result{} ?A ?A @result{} ?A ?\x0A @result{} ?\n |
| 669 ?\x41 @result{} ?A '(?\xAZ) @result{} '(?\n Z) '(?\0123) @result{} (?\n 3) | |
| 428 | 670 @end group |
| 671 @group | |
| 672 ;; @r{Under XEmacs 19:} | |
| 673 ?\012 @result{} 10 ?\n @result{} 10 ?\C-j @result{} 10 | |
| 674 ?\101 @result{} 65 ?A @result{} 65 | |
| 1549 | 675 ;; ?\x41 @r{is a syntax error.} |
| 428 | 676 @end group |
| 677 @end example | |
| 678 | |
| 679 A backslash is allowed, and harmless, preceding any character without | |
| 680 a special escape meaning; thus, @samp{?\+} is equivalent to @samp{?+}. | |
| 681 There is no reason to add a backslash before most characters. However, | |
| 682 you should add a backslash before any of the characters | |
| 683 @samp{()\|;'`"#.,} to avoid confusing the Emacs commands for editing | |
| 684 Lisp code. Also add a backslash before whitespace characters such as | |
| 685 space, tab, newline and formfeed. However, it is cleaner to use one of | |
| 686 the easily readable escape sequences, such as @samp{\t}, instead of an | |
| 687 actual whitespace character such as a tab. | |
| 688 | |
| 689 @node Symbol Type | |
| 690 @subsection Symbol Type | |
| 691 | |
| 692 A @dfn{symbol} in XEmacs Lisp is an object with a name. The symbol | |
| 693 name serves as the printed representation of the symbol. In ordinary | |
| 694 use, the name is unique---no two symbols have the same name. | |
| 695 | |
| 696 A symbol can serve as a variable, as a function name, or to hold a | |
| 697 property list. Or it may serve only to be distinct from all other Lisp | |
| 698 objects, so that its presence in a data structure may be recognized | |
| 699 reliably. In a given context, usually only one of these uses is | |
| 700 intended. But you can use one symbol in all of these ways, | |
| 701 independently. | |
| 702 | |
| 703 @cindex @samp{\} in symbols | |
| 704 @cindex backslash in symbols | |
| 705 A symbol name can contain any characters whatever. Most symbol names | |
| 706 are written with letters, digits, and the punctuation characters | |
| 707 @samp{-+=*/}. Such names require no special punctuation; the characters | |
| 708 of the name suffice as long as the name does not look like a number. | |
| 709 (If it does, write a @samp{\} at the beginning of the name to force | |
| 710 interpretation as a symbol.) The characters @samp{_~!@@$%^&:<>@{@}} are | |
| 711 less often used but also require no special punctuation. Any other | |
| 712 characters may be included in a symbol's name by escaping them with a | |
| 713 backslash. In contrast to its use in strings, however, a backslash in | |
| 714 the name of a symbol simply quotes the single character that follows the | |
| 715 backslash. For example, in a string, @samp{\t} represents a tab | |
| 716 character; in the name of a symbol, however, @samp{\t} merely quotes the | |
| 717 letter @kbd{t}. To have a symbol with a tab character in its name, you | |
| 718 must actually use a tab (preceded with a backslash). But it's rare to | |
| 719 do such a thing. | |
| 720 | |
| 721 @cindex CL note---case of letters | |
| 722 @quotation | |
| 723 @b{Common Lisp note:} In Common Lisp, lower case letters are always | |
| 724 ``folded'' to upper case, unless they are explicitly escaped. In Emacs | |
| 725 Lisp, upper case and lower case letters are distinct. | |
| 726 @end quotation | |
| 727 | |
| 728 Here are several examples of symbol names. Note that the @samp{+} in | |
| 729 the fifth example is escaped to prevent it from being read as a number. | |
| 730 This is not necessary in the sixth example because the rest of the name | |
| 731 makes it invalid as a number. | |
| 732 | |
| 733 @example | |
| 734 @group | |
| 735 foo ; @r{A symbol named @samp{foo}.} | |
| 736 FOO ; @r{A symbol named @samp{FOO}, different from @samp{foo}.} | |
| 737 char-to-string ; @r{A symbol named @samp{char-to-string}.} | |
| 738 @end group | |
| 739 @group | |
| 740 1+ ; @r{A symbol named @samp{1+}} | |
| 741 ; @r{(not @samp{+1}, which is an integer).} | |
| 742 @end group | |
| 743 @group | |
| 744 \+1 ; @r{A symbol named @samp{+1}} | |
| 745 ; @r{(not a very readable name).} | |
| 746 @end group | |
| 747 @group | |
| 748 \(*\ 1\ 2\) ; @r{A symbol named @samp{(* 1 2)} (a worse name).} | |
| 749 @c the @'s in this next line use up three characters, hence the | |
| 750 @c apparent misalignment of the comment. | |
| 751 +-*/_~!@@$%^&=:<>@{@} ; @r{A symbol named @samp{+-*/_~!@@$%^&=:<>@{@}}.} | |
| 752 ; @r{These characters need not be escaped.} | |
| 753 @end group | |
| 754 @end example | |
| 755 | |
| 756 @node Sequence Type | |
| 757 @subsection Sequence Types | |
| 758 | |
| 759 A @dfn{sequence} is a Lisp object that represents an ordered set of | |
| 760 elements. There are two kinds of sequence in XEmacs Lisp, lists and | |
| 761 arrays. Thus, an object of type list or of type array is also | |
| 762 considered a sequence. | |
| 763 | |
| 764 Arrays are further subdivided into strings, vectors, and bit vectors. | |
| 765 Vectors can hold elements of any type, but string elements must be | |
| 766 characters, and bit vector elements must be either 0 or 1. However, the | |
| 767 characters in a string can have extents (@pxref{Extents}) and text | |
| 768 properties (@pxref{Text Properties}) like characters in a buffer; | |
| 769 vectors do not support extents or text properties even when their | |
| 770 elements happen to be characters. | |
| 771 | |
| 772 Lists, strings, vectors, and bit vectors are different, but they have | |
| 773 important similarities. For example, all have a length @var{l}, and all | |
| 774 have elements which can be indexed from zero to @var{l} minus one. | |
| 775 Also, several functions, called sequence functions, accept any kind of | |
| 776 sequence. For example, the function @code{elt} can be used to extract | |
| 777 an element of a sequence, given its index. @xref{Sequences Arrays | |
| 778 Vectors}. | |
| 779 | |
| 780 It is impossible to read the same sequence twice, since sequences are | |
| 781 always created anew upon reading. If you read the read syntax for a | |
| 782 sequence twice, you get two sequences with equal contents. There is one | |
| 783 exception: the empty list @code{()} always stands for the same object, | |
| 784 @code{nil}. | |
| 785 | |
| 786 @node Cons Cell Type | |
| 787 @subsection Cons Cell and List Types | |
| 788 @cindex address field of register | |
| 789 @cindex decrement field of register | |
| 790 | |
| 791 A @dfn{cons cell} is an object comprising two pointers named the | |
| 792 @sc{car} and the @sc{cdr}. Each of them can point to any Lisp object. | |
| 793 | |
| 794 A @dfn{list} is a series of cons cells, linked together so that the | |
| 795 @sc{cdr} of each cons cell points either to another cons cell or to the | |
| 796 empty list. @xref{Lists}, for functions that work on lists. Because | |
| 797 most cons cells are used as part of lists, the phrase @dfn{list | |
| 798 structure} has come to refer to any structure made out of cons cells. | |
| 799 | |
| 800 The names @sc{car} and @sc{cdr} have only historical meaning now. The | |
| 801 original Lisp implementation ran on an @w{IBM 704} computer which | |
| 802 divided words into two parts, called the ``address'' part and the | |
| 803 ``decrement''; @sc{car} was an instruction to extract the contents of | |
| 804 the address part of a register, and @sc{cdr} an instruction to extract | |
| 805 the contents of the decrement. By contrast, ``cons cells'' are named | |
| 806 for the function @code{cons} that creates them, which in turn is named | |
| 807 for its purpose, the construction of cells. | |
| 808 | |
| 809 @cindex atom | |
| 810 Because cons cells are so central to Lisp, we also have a word for | |
| 811 ``an object which is not a cons cell''. These objects are called | |
| 812 @dfn{atoms}. | |
| 813 | |
| 814 @cindex parenthesis | |
| 815 The read syntax and printed representation for lists are identical, and | |
| 816 consist of a left parenthesis, an arbitrary number of elements, and a | |
| 817 right parenthesis. | |
| 818 | |
| 819 Upon reading, each object inside the parentheses becomes an element | |
| 820 of the list. That is, a cons cell is made for each element. The | |
| 821 @sc{car} of the cons cell points to the element, and its @sc{cdr} points | |
| 822 to the next cons cell of the list, which holds the next element in the | |
| 823 list. The @sc{cdr} of the last cons cell is set to point to @code{nil}. | |
| 824 | |
| 825 @cindex box diagrams, for lists | |
| 826 @cindex diagrams, boxed, for lists | |
| 827 A list can be illustrated by a diagram in which the cons cells are | |
| 828 shown as pairs of boxes. (The Lisp reader cannot read such an | |
| 829 illustration; unlike the textual notation, which can be understood by | |
| 830 both humans and computers, the box illustrations can be understood only | |
| 831 by humans.) The following represents the three-element list @code{(rose | |
| 832 violet buttercup)}: | |
| 833 | |
| 834 @example | |
| 835 @group | |
| 836 ___ ___ ___ ___ ___ ___ | |
| 837 |___|___|--> |___|___|--> |___|___|--> nil | |
| 838 | | | | |
| 839 | | | | |
| 840 --> rose --> violet --> buttercup | |
| 841 @end group | |
| 842 @end example | |
| 843 | |
| 844 In this diagram, each box represents a slot that can refer to any Lisp | |
| 845 object. Each pair of boxes represents a cons cell. Each arrow is a | |
| 846 reference to a Lisp object, either an atom or another cons cell. | |
| 847 | |
| 848 In this example, the first box, the @sc{car} of the first cons cell, | |
| 849 refers to or ``contains'' @code{rose} (a symbol). The second box, the | |
| 850 @sc{cdr} of the first cons cell, refers to the next pair of boxes, the | |
| 851 second cons cell. The @sc{car} of the second cons cell refers to | |
| 852 @code{violet} and the @sc{cdr} refers to the third cons cell. The | |
| 853 @sc{cdr} of the third (and last) cons cell refers to @code{nil}. | |
| 854 | |
| 855 Here is another diagram of the same list, @code{(rose violet | |
| 856 buttercup)}, sketched in a different manner: | |
| 857 | |
| 858 @smallexample | |
| 859 @group | |
| 860 --------------- ---------------- ------------------- | |
| 861 | car | cdr | | car | cdr | | car | cdr | | |
| 862 | rose | o-------->| violet | o-------->| buttercup | nil | | |
| 863 | | | | | | | | | | |
| 864 --------------- ---------------- ------------------- | |
| 865 @end group | |
| 866 @end smallexample | |
| 867 | |
| 868 @cindex @samp{(@dots{})} in lists | |
| 869 @cindex @code{nil} in lists | |
| 870 @cindex empty list | |
| 871 A list with no elements in it is the @dfn{empty list}; it is identical | |
| 872 to the symbol @code{nil}. In other words, @code{nil} is both a symbol | |
| 873 and a list. | |
| 874 | |
| 875 Here are examples of lists written in Lisp syntax: | |
| 876 | |
| 877 @example | |
| 878 (A 2 "A") ; @r{A list of three elements.} | |
| 879 () ; @r{A list of no elements (the empty list).} | |
| 880 nil ; @r{A list of no elements (the empty list).} | |
| 881 ("A ()") ; @r{A list of one element: the string @code{"A ()"}.} | |
| 882 (A ()) ; @r{A list of two elements: @code{A} and the empty list.} | |
| 883 (A nil) ; @r{Equivalent to the previous.} | |
| 884 ((A B C)) ; @r{A list of one element} | |
| 885 ; @r{(which is a list of three elements).} | |
| 886 @end example | |
| 887 | |
| 888 Here is the list @code{(A ())}, or equivalently @code{(A nil)}, | |
| 889 depicted with boxes and arrows: | |
| 890 | |
| 891 @example | |
| 892 @group | |
| 893 ___ ___ ___ ___ | |
| 894 |___|___|--> |___|___|--> nil | |
| 895 | | | |
| 896 | | | |
| 897 --> A --> nil | |
| 898 @end group | |
| 899 @end example | |
| 900 | |
| 901 @menu | |
| 902 * Dotted Pair Notation:: An alternative syntax for lists. | |
| 903 * Association List Type:: A specially constructed list. | |
| 904 @end menu | |
| 905 | |
| 906 @node Dotted Pair Notation | |
| 907 @subsubsection Dotted Pair Notation | |
| 908 @cindex dotted pair notation | |
| 909 @cindex @samp{.} in lists | |
| 910 | |
| 911 @dfn{Dotted pair notation} is an alternative syntax for cons cells | |
| 912 that represents the @sc{car} and @sc{cdr} explicitly. In this syntax, | |
| 913 @code{(@var{a} .@: @var{b})} stands for a cons cell whose @sc{car} is | |
| 914 the object @var{a}, and whose @sc{cdr} is the object @var{b}. Dotted | |
| 915 pair notation is therefore more general than list syntax. In the dotted | |
| 916 pair notation, the list @samp{(1 2 3)} is written as @samp{(1 . (2 . (3 | |
| 917 . nil)))}. For @code{nil}-terminated lists, the two notations produce | |
| 918 the same result, but list notation is usually clearer and more | |
| 919 convenient when it is applicable. When printing a list, the dotted pair | |
| 920 notation is only used if the @sc{cdr} of a cell is not a list. | |
| 921 | |
| 922 Here's how box notation can illustrate dotted pairs. This example | |
| 923 shows the pair @code{(rose . violet)}: | |
| 924 | |
| 925 @example | |
| 926 @group | |
| 927 ___ ___ | |
| 928 |___|___|--> violet | |
| 929 | | |
| 930 | | |
| 931 --> rose | |
| 932 @end group | |
| 933 @end example | |
| 934 | |
| 935 Dotted pair notation can be combined with list notation to represent a | |
| 936 chain of cons cells with a non-@code{nil} final @sc{cdr}. For example, | |
| 937 @code{(rose violet . buttercup)} is equivalent to @code{(rose . (violet | |
| 938 . buttercup))}. The object looks like this: | |
| 939 | |
| 940 @example | |
| 941 @group | |
| 942 ___ ___ ___ ___ | |
| 943 |___|___|--> |___|___|--> buttercup | |
| 944 | | | |
| 945 | | | |
| 946 --> rose --> violet | |
| 947 @end group | |
| 948 @end example | |
| 949 | |
| 950 These diagrams make it evident why @w{@code{(rose .@: violet .@: | |
| 951 buttercup)}} is invalid syntax; it would require a cons cell that has | |
| 952 three parts rather than two. | |
| 953 | |
| 954 The list @code{(rose violet)} is equivalent to @code{(rose . (violet))} | |
| 955 and looks like this: | |
| 956 | |
| 957 @example | |
| 958 @group | |
| 959 ___ ___ ___ ___ | |
| 960 |___|___|--> |___|___|--> nil | |
| 961 | | | |
| 962 | | | |
| 963 --> rose --> violet | |
| 964 @end group | |
| 965 @end example | |
| 966 | |
| 967 Similarly, the three-element list @code{(rose violet buttercup)} | |
| 968 is equivalent to @code{(rose . (violet . (buttercup)))}. | |
| 969 @ifinfo | |
| 970 It looks like this: | |
| 971 | |
| 972 @example | |
| 973 @group | |
| 974 ___ ___ ___ ___ ___ ___ | |
| 975 |___|___|--> |___|___|--> |___|___|--> nil | |
| 976 | | | | |
| 977 | | | | |
| 978 --> rose --> violet --> buttercup | |
| 979 @end group | |
| 980 @end example | |
| 981 @end ifinfo | |
| 982 | |
| 983 @node Association List Type | |
| 984 @subsubsection Association List Type | |
| 985 | |
| 986 An @dfn{association list} or @dfn{alist} is a specially-constructed | |
| 987 list whose elements are cons cells. In each element, the @sc{car} is | |
| 988 considered a @dfn{key}, and the @sc{cdr} is considered an | |
| 989 @dfn{associated value}. (In some cases, the associated value is stored | |
| 990 in the @sc{car} of the @sc{cdr}.) Association lists are often used as | |
| 991 stacks, since it is easy to add or remove associations at the front of | |
| 992 the list. | |
| 993 | |
| 994 For example, | |
| 995 | |
| 996 @example | |
| 997 (setq alist-of-colors | |
| 998 '((rose . red) (lily . white) (buttercup . yellow))) | |
| 999 @end example | |
| 1000 | |
| 1001 @noindent | |
| 1002 sets the variable @code{alist-of-colors} to an alist of three elements. In the | |
| 1003 first element, @code{rose} is the key and @code{red} is the value. | |
| 1004 | |
| 1005 @xref{Association Lists}, for a further explanation of alists and for | |
| 1006 functions that work on alists. | |
| 1007 | |
| 1008 @node Array Type | |
| 1009 @subsection Array Type | |
| 1010 | |
| 1011 An @dfn{array} is composed of an arbitrary number of slots for | |
| 1012 referring to other Lisp objects, arranged in a contiguous block of | |
| 1013 memory. Accessing any element of an array takes the same amount of | |
| 1014 time. In contrast, accessing an element of a list requires time | |
| 1015 proportional to the position of the element in the list. (Elements at | |
| 1016 the end of a list take longer to access than elements at the beginning | |
| 1017 of a list.) | |
| 1018 | |
| 1019 XEmacs defines three types of array, strings, vectors, and bit | |
| 1020 vectors. A string is an array of characters, a vector is an array of | |
| 1021 arbitrary objects, and a bit vector is an array of 1's and 0's. All are | |
| 1022 one-dimensional. (Most other programming languages support | |
| 1023 multidimensional arrays, but they are not essential; you can get the | |
| 1024 same effect with an array of arrays.) Each type of array has its own | |
| 1025 read syntax; see @ref{String Type}, @ref{Vector Type}, and @ref{Bit | |
| 1026 Vector Type}. | |
| 1027 | |
|
4885
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
1028 An array may have any length up to the largest fixnum; but once |
| 428 | 1029 created, it has a fixed size. The first element of an array has index |
| 1030 zero, the second element has index 1, and so on. This is called | |
| 1031 @dfn{zero-origin} indexing. For example, an array of four elements has | |
| 1032 indices 0, 1, 2, @w{and 3}. | |
| 1033 | |
| 1034 The array type is contained in the sequence type and contains the | |
| 1035 string type, the vector type, and the bit vector type. | |
| 1036 | |
| 1037 @node String Type | |
| 1038 @subsection String Type | |
| 1039 | |
| 1040 A @dfn{string} is an array of characters. Strings are used for many | |
| 1041 purposes in XEmacs, as can be expected in a text editor; for example, as | |
| 1042 the names of Lisp symbols, as messages for the user, and to represent | |
| 1043 text extracted from buffers. Strings in Lisp are constants: evaluation | |
| 1044 of a string returns the same string. | |
| 1045 | |
| 1046 @cindex @samp{"} in strings | |
| 1047 @cindex double-quote in strings | |
| 1048 @cindex @samp{\} in strings | |
| 1049 @cindex backslash in strings | |
| 1050 The read syntax for strings is a double-quote, an arbitrary number of | |
| 1051 characters, and another double-quote, @code{"like this"}. The Lisp | |
| 1052 reader accepts the same formats for reading the characters of a string | |
| 1053 as it does for reading single characters (without the question mark that | |
| 1054 begins a character literal). You can enter a nonprinting character such | |
| 1055 as tab or @kbd{C-a} using the convenient escape sequences, like this: | |
| 1056 @code{"\t, \C-a"}. You can include a double-quote in a string by | |
| 1057 preceding it with a backslash; thus, @code{"\""} is a string containing | |
| 1058 just a single double-quote character. (@xref{Character Type}, for a | |
| 1059 description of the read syntax for characters.) | |
| 1060 | |
| 1061 @ignore @c More ill-conceived FSF Emacs crap. | |
| 1062 If you use the @samp{\M-} syntax to indicate a meta character in a | |
| 1063 string constant, this sets the | |
| 1064 @iftex | |
| 1065 $2^{7}$ | |
| 1066 @end iftex | |
| 1067 @ifinfo | |
| 1068 2**7 | |
| 1069 @end ifinfo | |
| 1070 bit of the character in the string. | |
| 1071 This is not the same representation that the meta modifier has in a | |
| 1072 character on its own (not inside a string). @xref{Character Type}. | |
| 1073 | |
| 1074 Strings cannot hold characters that have the hyper, super, or alt | |
| 1075 modifiers; they can hold @sc{ASCII} control characters, but no others. | |
| 1076 They do not distinguish case in @sc{ASCII} control characters. | |
| 1077 @end ignore | |
| 1078 | |
| 1079 The printed representation of a string consists of a double-quote, the | |
| 1080 characters it contains, and another double-quote. However, you must | |
| 1081 escape any backslash or double-quote characters in the string with a | |
| 1082 backslash, like this: @code{"this \" is an embedded quote"}. | |
| 1083 | |
| 3543 | 1084 An alternative syntax allows insertion of raw backslashes into a |
| 1085 string, like this: @code{#r"this \ is an embedded backslash"}. In such | |
| 1086 a string, each character following a backslash is included literally in | |
| 1087 the string, and all backslashes are left in the string. This means that | |
| 1088 @code{#r"\""} is a valid string literal with two characters, a backslash and a | |
| 4265 | 1089 double-quote. It also means that a string with this syntax cannot end |
| 1090 in a single backslash. As with Python, from where this syntax was | |
| 3543 | 1091 taken, you can specify @code{u} or @code{U} after the @code{#r} to |
| 4265 | 1092 specify that interpretation of Unicode escapes should be |
| 1093 done---@pxref{Character Type}---and if you use @code{#ru} for your raw | |
| 1094 strings, the restriction on the trailing backslash can be worked around | |
| 1095 like so: @code{#ru"Backslash: \u005C"}. | |
| 3543 | 1096 |
| 428 | 1097 The newline character is not special in the read syntax for strings; |
| 1098 if you write a new line between the double-quotes, it becomes a | |
| 1099 character in the string. But an escaped newline---one that is preceded | |
| 1100 by @samp{\}---does not become part of the string; i.e., the Lisp reader | |
| 1101 ignores an escaped newline while reading a string. | |
| 1102 @cindex newline in strings | |
| 1103 | |
| 1104 @example | |
| 1105 "It is useful to include newlines | |
| 1106 in documentation strings, | |
| 1107 but the newline is \ | |
| 1108 ignored if escaped." | |
| 1109 @result{} "It is useful to include newlines | |
| 1110 in documentation strings, | |
| 1111 but the newline is ignored if escaped." | |
| 1112 @end example | |
| 1113 | |
| 1114 A string can hold extents and properties of the text it contains, in | |
| 1115 addition to the characters themselves. This enables programs that copy | |
| 1116 text between strings and buffers to preserve the extents and properties | |
| 1117 with no special effort. @xref{Extents}, @xref{Text Properties}. | |
| 1118 | |
| 1119 Note that FSF GNU Emacs has a special read and print syntax for | |
| 1120 strings with text properties, but XEmacs does not currently implement | |
| 1121 this. It was judged better not to include this in XEmacs because it | |
| 1122 entails that @code{equal} return @code{nil} when passed a string with | |
| 1123 text properties and the equivalent string without text properties, which | |
| 1124 is often counter-intuitive. | |
| 1125 | |
| 1126 @ignore @c Not in XEmacs | |
| 1127 Strings with text | |
| 1128 properties have a special read and print syntax: | |
| 1129 | |
| 1130 @example | |
| 1131 #("@var{characters}" @var{property-data}...) | |
| 1132 @end example | |
| 1133 | |
| 1134 @noindent | |
| 1135 where @var{property-data} consists of zero or more elements, in groups | |
| 1136 of three as follows: | |
| 1137 | |
| 1138 @example | |
| 444 | 1139 @var{start} @var{end} @var{plist} |
| 428 | 1140 @end example |
| 1141 | |
| 1142 @noindent | |
| 444 | 1143 The elements @var{start} and @var{end} are integers, and together specify |
| 428 | 1144 a range of indices in the string; @var{plist} is the property list for |
| 1145 that range. | |
| 1146 @end ignore | |
| 1147 | |
| 1148 @xref{Strings and Characters}, for functions that work on strings. | |
| 1149 | |
| 1150 @node Vector Type | |
| 1151 @subsection Vector Type | |
| 1152 | |
| 1153 A @dfn{vector} is a one-dimensional array of elements of any type. It | |
| 1154 takes a constant amount of time to access any element of a vector. (In | |
| 1155 a list, the access time of an element is proportional to the distance of | |
| 1156 the element from the beginning of the list.) | |
| 1157 | |
| 1158 The printed representation of a vector consists of a left square | |
| 1159 bracket, the elements, and a right square bracket. This is also the | |
| 1160 read syntax. Like numbers and strings, vectors are considered constants | |
| 1161 for evaluation. | |
| 1162 | |
| 1163 @example | |
| 1164 [1 "two" (three)] ; @r{A vector of three elements.} | |
| 1165 @result{} [1 "two" (three)] | |
| 1166 @end example | |
| 1167 | |
| 1168 @xref{Vectors}, for functions that work with vectors. | |
| 1169 | |
| 1170 @node Bit Vector Type | |
| 1171 @subsection Bit Vector Type | |
| 1172 | |
| 1173 A @dfn{bit vector} is a one-dimensional array of 1's and 0's. It | |
| 1174 takes a constant amount of time to access any element of a bit vector, | |
| 1175 as for vectors. Bit vectors have an extremely compact internal | |
| 1176 representation (one machine bit per element), which makes them ideal | |
| 1177 for keeping track of unordered sets, large collections of boolean values, | |
| 1178 etc. | |
| 1179 | |
| 1180 The printed representation of a bit vector consists of @samp{#*} | |
| 1181 followed by the bits in the vector. This is also the read syntax. Like | |
| 1182 numbers, strings, and vectors, bit vectors are considered constants for | |
| 1183 evaluation. | |
| 1184 | |
| 1185 @example | |
| 1186 #*00101000 ; @r{A bit vector of eight elements.} | |
| 1187 @result{} #*00101000 | |
| 1188 @end example | |
| 1189 | |
| 1190 @xref{Bit Vectors}, for functions that work with bit vectors. | |
| 1191 | |
| 1192 @node Function Type | |
| 1193 @subsection Function Type | |
| 1194 | |
| 1195 Just as functions in other programming languages are executable, | |
| 1196 @dfn{Lisp function} objects are pieces of executable code. However, | |
| 1197 functions in Lisp are primarily Lisp objects, and only secondarily the | |
| 1198 text which represents them. These Lisp objects are lambda expressions: | |
| 1199 lists whose first element is the symbol @code{lambda} (@pxref{Lambda | |
| 1200 Expressions}). | |
| 1201 | |
| 1202 In most programming languages, it is impossible to have a function | |
| 1203 without a name. In Lisp, a function has no intrinsic name. A lambda | |
| 1204 expression is also called an @dfn{anonymous function} (@pxref{Anonymous | |
| 1205 Functions}). A named function in Lisp is actually a symbol with a valid | |
| 1206 function in its function cell (@pxref{Defining Functions}). | |
| 1207 | |
| 1208 Most of the time, functions are called when their names are written in | |
| 1209 Lisp expressions in Lisp programs. However, you can construct or obtain | |
| 1210 a function object at run time and then call it with the primitive | |
| 1211 functions @code{funcall} and @code{apply}. @xref{Calling Functions}. | |
| 1212 | |
| 1213 @node Macro Type | |
| 1214 @subsection Macro Type | |
| 1215 | |
| 1216 A @dfn{Lisp macro} is a user-defined construct that extends the Lisp | |
| 1217 language. It is represented as an object much like a function, but with | |
| 1218 different parameter-passing semantics. A Lisp macro has the form of a | |
| 1219 list whose first element is the symbol @code{macro} and whose @sc{cdr} | |
| 1220 is a Lisp function object, including the @code{lambda} symbol. | |
| 1221 | |
| 1222 Lisp macro objects are usually defined with the built-in | |
| 1223 @code{defmacro} function, but any list that begins with @code{macro} is | |
| 1224 a macro as far as XEmacs is concerned. @xref{Macros}, for an explanation | |
| 1225 of how to write a macro. | |
| 1226 | |
| 1227 @node Primitive Function Type | |
| 1228 @subsection Primitive Function Type | |
|
4905
755ae5b97edb
Change "special form" to "special operator" in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4885
diff
changeset
|
1229 @cindex special operators |
| 428 | 1230 |
| 1231 A @dfn{primitive function} is a function callable from Lisp but | |
| 1232 written in the C programming language. Primitive functions are also | |
| 1233 called @dfn{subrs} or @dfn{built-in functions}. (The word ``subr'' is | |
| 1234 derived from ``subroutine''.) Most primitive functions evaluate all | |
| 1235 their arguments when they are called. A primitive function that does | |
|
4905
755ae5b97edb
Change "special form" to "special operator" in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4885
diff
changeset
|
1236 not evaluate all its arguments is called a @dfn{special operator} |
|
755ae5b97edb
Change "special form" to "special operator" in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4885
diff
changeset
|
1237 (@pxref{Special Operators}).@refill |
| 428 | 1238 |
| 1239 It does not matter to the caller of a function whether the function is | |
| 1240 primitive. However, this does matter if you try to substitute a | |
| 1241 function written in Lisp for a primitive of the same name. The reason | |
| 1242 is that the primitive function may be called directly from C code. | |
| 1243 Calls to the redefined function from Lisp will use the new definition, | |
| 1244 but calls from C code may still use the built-in definition. | |
| 1245 | |
| 1246 The term @dfn{function} refers to all Emacs functions, whether written | |
| 1247 in Lisp or C. @xref{Function Type}, for information about the | |
| 1248 functions written in Lisp. | |
| 1249 | |
| 1250 Primitive functions have no read syntax and print in hash notation | |
| 1251 with the name of the subroutine. | |
| 1252 | |
| 1253 @example | |
| 1254 @group | |
| 1255 (symbol-function 'car) ; @r{Access the function cell} | |
| 1256 ; @r{of the symbol.} | |
| 1257 @result{} #<subr car> | |
| 1258 (subrp (symbol-function 'car)) ; @r{Is this a primitive function?} | |
| 1259 @result{} t ; @r{Yes.} | |
| 1260 @end group | |
| 1261 @end example | |
| 1262 | |
| 1263 @node Compiled-Function Type | |
| 1264 @subsection Compiled-Function Type | |
| 1265 | |
| 1266 The byte compiler produces @dfn{compiled-function objects}. The | |
| 1267 evaluator handles this data type specially when it appears as a function | |
| 1268 to be called. @xref{Byte Compilation}, for information about the byte | |
| 1269 compiler. | |
| 1270 | |
| 1271 The printed representation for a compiled-function object is normally | |
| 1272 @samp{#<compiled-function...>}. If @code{print-readably} is true, | |
| 1273 however, it is @samp{#[...]}. | |
| 1274 | |
| 1275 @node Autoload Type | |
| 1276 @subsection Autoload Type | |
| 1277 | |
| 1278 An @dfn{autoload object} is a list whose first element is the symbol | |
| 1279 @code{autoload}. It is stored as the function definition of a symbol as | |
| 1280 a placeholder for the real definition; it says that the real definition | |
| 1281 is found in a file of Lisp code that should be loaded when necessary. | |
| 1282 The autoload object contains the name of the file, plus some other | |
| 1283 information about the real definition. | |
| 1284 | |
| 1285 After the file has been loaded, the symbol should have a new function | |
| 1286 definition that is not an autoload object. The new definition is then | |
| 1287 called as if it had been there to begin with. From the user's point of | |
| 1288 view, the function call works as expected, using the function definition | |
| 1289 in the loaded file. | |
| 1290 | |
| 1291 An autoload object is usually created with the function | |
| 1292 @code{autoload}, which stores the object in the function cell of a | |
| 1293 symbol. @xref{Autoload}, for more details. | |
| 1294 | |
| 1295 @node Char Table Type | |
| 1296 @subsection Char Table Type | |
| 1297 @cindex char table type | |
| 1298 | |
| 1299 (not yet documented) | |
| 1300 | |
| 1301 @node Hash Table Type | |
| 1302 @subsection Hash Table Type | |
| 1303 @cindex hash table type | |
| 1304 | |
| 1305 A @dfn{hash table} is a table providing an arbitrary mapping from | |
| 1306 one Lisp object to another, using an internal indexing method | |
| 1307 called @dfn{hashing}. Hash tables are very fast (much more efficient | |
| 1308 that using an association list, when there are a large number of | |
| 1309 elements in the table). | |
| 1310 | |
| 1311 Hash tables have a special read syntax beginning with | |
| 1312 @samp{#s(hash-table} (this is an example of @dfn{structure} read | |
| 1313 syntax. This notation is also used for printing when | |
| 1314 @code{print-readably} is @code{t}. | |
| 1315 | |
| 1316 Otherwise they print in hash notation (The ``hash'' in ``hash notation'' | |
| 1317 has nothing to do with the ``hash'' in ``hash table''), giving the | |
| 1318 number of elements, total space allocated for elements, and a unique | |
| 1319 number assigned at the time the hash table was created. (Hash tables | |
| 1320 automatically resize as necessary so there is no danger of running out | |
| 1321 of space for elements.) | |
| 1322 | |
| 1323 @example | |
| 1324 @group | |
| 1325 (make-hash-table :size 50) | |
|
4820
e6dec75ded0e
Use keywords, not ordinary symbols, in the structure syntax for hash tables.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4792
diff
changeset
|
1326 @result{} #<hash-table :size 0/107 0x3babb0e4> |
| 428 | 1327 @end group |
| 1328 @end example | |
| 1329 | |
| 1330 @xref{Hash Tables}, for information on how to create and work with hash | |
| 1331 tables. | |
| 1332 | |
| 1333 @node Range Table Type | |
| 1334 @subsection Range Table Type | |
| 1335 @cindex range table type | |
| 1336 | |
|
4885
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
1337 A @dfn{range table} is a table that maps from ranges of fixnums to |
| 428 | 1338 arbitrary Lisp objects. Range tables automatically combine overlapping |
| 1339 ranges that map to the same Lisp object, and operations are provided | |
| 1340 for mapping over all of the ranges in a range table. | |
| 1341 | |
| 1342 Range tables have a special read syntax beginning with | |
| 1343 @samp{#s(range-table} (this is an example of @dfn{structure} read syntax, | |
| 1344 which is also used for char tables and faces). | |
| 1345 | |
| 1346 @example | |
| 1347 @group | |
| 1348 (setq x (make-range-table)) | |
| 1349 (put-range-table 20 50 'foo x) | |
| 1350 (put-range-table 100 200 "bar" x) | |
| 1351 x | |
| 1352 @result{} #s(range-table data ((20 50) foo (100 200) "bar")) | |
| 1353 @end group | |
| 1354 @end example | |
| 1355 | |
| 1356 @xref{Range Tables}, for information on how to create and work with range | |
| 1357 tables. | |
| 1358 | |
| 1359 @node Weak List Type | |
| 1360 @subsection Weak List Type | |
| 1361 @cindex weak list type | |
| 1362 | |
| 1363 (not yet documented) | |
| 1364 | |
| 1365 @node Editing Types | |
| 1366 @section Editing Types | |
| 1367 @cindex editing types | |
| 1368 | |
| 1369 The types in the previous section are common to many Lisp dialects. | |
| 1370 XEmacs Lisp provides several additional data types for purposes connected | |
| 1371 with editing. | |
| 1372 | |
| 1373 @menu | |
| 1374 * Buffer Type:: The basic object of editing. | |
| 1375 * Marker Type:: A position in a buffer. | |
| 1376 * Extent Type:: A range in a buffer or string, maybe with properties. | |
| 1377 * Window Type:: Buffers are displayed in windows. | |
| 1378 * Frame Type:: Windows subdivide frames. | |
| 1379 * Device Type:: Devices group all frames on a display. | |
| 1380 * Console Type:: Consoles group all devices with the same keyboard. | |
| 1381 * Window Configuration Type:: Recording the way a frame is subdivided. | |
| 1382 * Event Type:: An interesting occurrence in the system. | |
| 1383 * Process Type:: A process running on the underlying OS. | |
| 1384 * Stream Type:: Receive or send characters. | |
| 1385 * Keymap Type:: What function a keystroke invokes. | |
| 1386 * Syntax Table Type:: What a character means. | |
| 1387 * Display Table Type:: How display tables are represented. | |
| 1388 * Database Type:: A connection to an external DBM or DB database. | |
| 1389 * Charset Type:: A character set (e.g. all Kanji characters), | |
| 1390 under XEmacs/MULE. | |
| 1391 * Coding System Type:: An object encapsulating a way of converting between | |
| 1392 different textual encodings, under XEmacs/MULE. | |
| 1393 * ToolTalk Message Type:: A message, in the ToolTalk IPC protocol. | |
| 1394 * ToolTalk Pattern Type:: A pattern, in the ToolTalk IPC protocol. | |
| 1395 @end menu | |
| 1396 | |
| 1397 @node Buffer Type | |
| 1398 @subsection Buffer Type | |
| 1399 | |
| 1400 A @dfn{buffer} is an object that holds text that can be edited | |
| 1401 (@pxref{Buffers}). Most buffers hold the contents of a disk file | |
| 1402 (@pxref{Files}) so they can be edited, but some are used for other | |
| 1403 purposes. Most buffers are also meant to be seen by the user, and | |
| 1404 therefore displayed, at some time, in a window (@pxref{Windows}). But a | |
| 1405 buffer need not be displayed in any window. | |
| 1406 | |
| 1407 The contents of a buffer are much like a string, but buffers are not | |
| 1408 used like strings in XEmacs Lisp, and the available operations are | |
| 1409 different. For example, insertion of text into a buffer is very | |
| 1410 efficient, whereas ``inserting'' text into a string requires | |
| 1411 concatenating substrings, and the result is an entirely new string | |
| 1412 object. | |
| 1413 | |
| 1414 Each buffer has a designated position called @dfn{point} | |
| 1415 (@pxref{Positions}). At any time, one buffer is the @dfn{current | |
| 1416 buffer}. Most editing commands act on the contents of the current | |
| 1417 buffer in the neighborhood of point. Many of the standard Emacs | |
| 1418 functions manipulate or test the characters in the current buffer; a | |
| 1419 whole chapter in this manual is devoted to describing these functions | |
| 1420 (@pxref{Text}). | |
| 1421 | |
| 1422 Several other data structures are associated with each buffer: | |
| 1423 | |
| 1424 @itemize @bullet | |
| 1425 @item | |
| 1426 a local syntax table (@pxref{Syntax Tables}); | |
| 1427 | |
| 1428 @item | |
| 1429 a local keymap (@pxref{Keymaps}); | |
| 1430 | |
| 1431 @item | |
| 1432 a local variable binding list (@pxref{Buffer-Local Variables}); | |
| 1433 | |
| 1434 @item | |
| 1435 a list of extents (@pxref{Extents}); | |
| 1436 | |
| 1437 @item | |
| 1438 and various other related properties. | |
| 1439 @end itemize | |
| 1440 | |
| 1441 @noindent | |
| 1442 The local keymap and variable list contain entries that individually | |
| 1443 override global bindings or values. These are used to customize the | |
| 1444 behavior of programs in different buffers, without actually changing the | |
| 1445 programs. | |
| 1446 | |
| 1447 A buffer may be @dfn{indirect}, which means it shares the text | |
| 1448 of another buffer. @xref{Indirect Buffers}. | |
| 1449 | |
| 1450 Buffers have no read syntax. They print in hash notation, showing the | |
| 1451 buffer name. | |
| 1452 | |
| 1453 @example | |
| 1454 @group | |
| 1455 (current-buffer) | |
| 1456 @result{} #<buffer "objects.texi"> | |
| 1457 @end group | |
| 1458 @end example | |
| 1459 | |
| 1460 @node Marker Type | |
| 1461 @subsection Marker Type | |
| 1462 | |
| 1463 A @dfn{marker} denotes a position in a specific buffer. Markers | |
| 1464 therefore have two components: one for the buffer, and one for the | |
| 1465 position. Changes in the buffer's text automatically relocate the | |
| 1466 position value as necessary to ensure that the marker always points | |
| 1467 between the same two characters in the buffer. | |
| 1468 | |
| 1469 Markers have no read syntax. They print in hash notation, giving the | |
| 1470 current character position and the name of the buffer. | |
| 1471 | |
| 1472 @example | |
| 1473 @group | |
| 1474 (point-marker) | |
| 1475 @result{} #<marker at 50661 in objects.texi> | |
| 1476 @end group | |
| 1477 @end example | |
| 1478 | |
| 1479 @xref{Markers}, for information on how to test, create, copy, and move | |
| 1480 markers. | |
| 1481 | |
| 1482 @node Extent Type | |
| 1483 @subsection Extent Type | |
| 1484 | |
| 1485 An @dfn{extent} specifies temporary alteration of the display | |
| 1486 appearance of a part of a buffer (or string). It contains markers | |
| 1487 delimiting a range of the buffer, plus a property list (a list whose | |
| 1488 elements are alternating property names and values). Extents are used | |
| 1489 to present parts of the buffer temporarily in a different display style. | |
| 1490 They have no read syntax, and print in hash notation, giving the buffer | |
| 1491 name and range of positions. | |
| 1492 | |
| 1493 Extents can exist over strings as well as buffers; the primary use | |
| 1494 of this is to preserve extent and text property information as text | |
| 1495 is copied from one buffer to another or between different parts of | |
| 1496 a buffer. | |
| 1497 | |
| 1498 Extents have no read syntax. They print in hash notation, giving the | |
| 1499 range of text they cover, the name of the buffer or string they are in, | |
| 1500 the address in core, and a summary of some of the properties attached to | |
| 1501 the extent. | |
| 1502 | |
| 1503 @example | |
| 1504 @group | |
| 1505 (extent-at (point)) | |
| 1506 @result{} #<extent [51742, 51748) font-lock text-prop 0x90121e0 in buffer objects.texi> | |
| 1507 @end group | |
| 1508 @end example | |
| 1509 | |
| 1510 @xref{Extents}, for how to create and use extents. | |
| 1511 | |
| 1512 Extents are used to implement text properties. @xref{Text Properties}. | |
| 1513 | |
| 1514 @node Window Type | |
| 1515 @subsection Window Type | |
| 1516 | |
| 1517 A @dfn{window} describes the portion of the frame that XEmacs uses to | |
| 1518 display a buffer. (In standard window-system usage, a @dfn{window} is | |
| 1519 what XEmacs calls a @dfn{frame}; XEmacs confusingly uses the term | |
| 1520 ``window'' to refer to what is called a @dfn{pane} in standard | |
| 1521 window-system usage.) Every window has one associated buffer, whose | |
| 1522 contents appear in the window. By contrast, a given buffer may appear | |
| 1523 in one window, no window, or several windows. | |
| 1524 | |
| 1525 Though many windows may exist simultaneously, at any time one window | |
| 1526 is designated the @dfn{selected window}. This is the window where the | |
| 1527 cursor is (usually) displayed when XEmacs is ready for a command. The | |
| 1528 selected window usually displays the current buffer, but this is not | |
| 1529 necessarily the case. | |
| 1530 | |
| 1531 Windows are grouped on the screen into frames; each window belongs to | |
| 1532 one and only one frame. @xref{Frame Type}. | |
| 1533 | |
| 1534 Windows have no read syntax. They print in hash notation, giving the | |
| 1535 name of the buffer being displayed and a unique number assigned at the | |
| 1536 time the window was created. (This number can be useful because the | |
| 1537 buffer displayed in any given window can change frequently.) | |
| 1538 | |
| 1539 @example | |
| 1540 @group | |
| 1541 (selected-window) | |
| 1542 @result{} #<window on "objects.texi" 0x266c> | |
| 1543 @end group | |
| 1544 @end example | |
| 1545 | |
| 1546 @xref{Windows}, for a description of the functions that work on windows. | |
| 1547 | |
| 1548 @node Frame Type | |
| 1549 @subsection Frame Type | |
| 1550 | |
| 1551 A @var{frame} is a rectangle on the screen (a @dfn{window} in standard | |
| 1552 window-system terminology) that contains one or more non-overlapping | |
| 1553 Emacs windows (@dfn{panes} in standard window-system terminology). A | |
| 1554 frame initially contains a single main window (plus perhaps a minibuffer | |
| 1555 window) which you can subdivide vertically or horizontally into smaller | |
| 1556 windows. | |
| 1557 | |
| 1558 Frames have no read syntax. They print in hash notation, giving the | |
| 1559 frame's type, name as used for resourcing, and a unique number assigned | |
| 1560 at the time the frame was created. | |
| 1561 | |
| 1562 @example | |
| 1563 @group | |
| 1564 (selected-frame) | |
| 1565 @result{} #<x-frame "emacs" 0x9db> | |
| 1566 @end group | |
| 1567 @end example | |
| 1568 | |
| 1569 @xref{Frames}, for a description of the functions that work on frames. | |
| 1570 | |
| 1571 @node Device Type | |
| 1572 @subsection Device Type | |
| 1573 | |
| 1574 A @dfn{device} represents a single display on which frames exist. | |
| 1575 Normally, there is only one device object, but there may be more | |
| 1576 than one if XEmacs is being run on a multi-headed display (e.g. an | |
| 1577 X server with attached color and mono screens) or if XEmacs is | |
| 1578 simultaneously driving frames attached to different consoles, e.g. | |
| 1579 an X display and a @sc{tty} connection. | |
| 1580 | |
| 1581 Devices do not have a read syntax. They print in hash notation, | |
| 1582 giving the device's type, connection name, and a unique number assigned | |
| 1583 at the time the device was created. | |
| 1584 | |
| 1585 @example | |
| 1586 @group | |
| 1587 (selected-device) | |
| 1588 @result{} #<x-device on ":0.0" 0x5b9> | |
| 1589 @end group | |
| 1590 @end example | |
| 1591 | |
| 1592 @xref{Consoles and Devices}, for a description of several functions | |
| 1593 related to devices. | |
| 1594 | |
| 1595 @node Console Type | |
| 1596 @subsection Console Type | |
| 1597 | |
| 1598 A @dfn{console} represents a single keyboard to which devices | |
| 1599 (i.e. displays on which frames exist) are connected. Normally, there is | |
| 1600 only one console object, but there may be more than one if XEmacs is | |
| 1601 simultaneously driving frames attached to different X servers and/or | |
| 1602 @sc{tty} connections. (XEmacs is capable of driving multiple X and | |
| 1603 @sc{tty} connections at the same time, and provides a robust mechanism | |
| 1604 for handling the differing display capabilities of such heterogeneous | |
| 1605 environments. A buffer with embedded glyphs and multiple fonts and | |
| 1606 colors, for example, will display reasonably if it simultaneously | |
| 1607 appears on a frame on a color X display, a frame on a mono X display, | |
| 1608 and a frame on a @sc{tty} connection.) | |
| 1609 | |
| 1610 Consoles do not have a read syntax. They print in hash notation, | |
| 1611 giving the console's type, connection name, and a unique number assigned | |
| 1612 at the time the console was created. | |
| 1613 | |
| 1614 @example | |
| 1615 @group | |
| 1616 (selected-console) | |
| 1617 @result{} #<x-console on "localhost:0" 0x5b7> | |
| 1618 @end group | |
| 1619 @end example | |
| 1620 | |
| 1621 @xref{Consoles and Devices}, for a description of several functions | |
| 1622 related to consoles. | |
| 1623 | |
| 1624 @node Window Configuration Type | |
| 1625 @subsection Window Configuration Type | |
| 1626 @cindex screen layout | |
| 1627 | |
| 1628 A @dfn{window configuration} stores information about the positions, | |
| 1629 sizes, and contents of the windows in a frame, so you can recreate the | |
| 1630 same arrangement of windows later. | |
| 1631 | |
| 1632 Window configurations do not have a read syntax. They print in hash | |
| 1633 notation, giving a unique number assigned at the time the window | |
| 1634 configuration was created. | |
| 1635 | |
| 1636 @example | |
| 1637 @group | |
| 1638 (current-window-configuration) | |
| 1639 @result{} #<window-configuration 0x2db4> | |
| 1640 @end group | |
| 1641 @end example | |
| 1642 | |
| 1643 @xref{Window Configurations}, for a description of several functions | |
| 1644 related to window configurations. | |
| 1645 | |
| 1646 @node Event Type | |
| 1647 @subsection Event Type | |
| 1648 | |
| 1649 (not yet documented) | |
| 1650 | |
| 1651 @node Process Type | |
| 1652 @subsection Process Type | |
| 1653 | |
| 1654 The word @dfn{process} usually means a running program. XEmacs itself | |
| 1655 runs in a process of this sort. However, in XEmacs Lisp, a process is a | |
| 1656 Lisp object that designates a subprocess created by the XEmacs process. | |
| 1657 Programs such as shells, GDB, ftp, and compilers, running in | |
| 1658 subprocesses of XEmacs, extend the capabilities of XEmacs. | |
| 1659 | |
| 1660 An Emacs subprocess takes textual input from Emacs and returns textual | |
| 1661 output to Emacs for further manipulation. Emacs can also send signals | |
| 1662 to the subprocess. | |
| 1663 | |
| 1664 Process objects have no read syntax. They print in hash notation, | |
| 1665 giving the name of the process, its associated process ID, and the | |
| 1666 current state of the process: | |
| 1667 | |
| 1668 @example | |
| 1669 @group | |
| 1670 (process-list) | |
| 1671 @result{} (#<process "shell" pid 2909 state:run>) | |
| 1672 @end group | |
| 1673 @end example | |
| 1674 | |
| 1675 @xref{Processes}, for information about functions that create, delete, | |
| 1676 return information about, send input or signals to, and receive output | |
| 1677 from processes. | |
| 1678 | |
| 1679 @node Stream Type | |
| 1680 @subsection Stream Type | |
| 1681 | |
| 1682 A @dfn{stream} is an object that can be used as a source or sink for | |
| 1683 characters---either to supply characters for input or to accept them as | |
| 1684 output. Many different types can be used this way: markers, buffers, | |
| 1685 strings, and functions. Most often, input streams (character sources) | |
| 1686 obtain characters from the keyboard, a buffer, or a file, and output | |
| 1687 streams (character sinks) send characters to a buffer, such as a | |
| 1688 @file{*Help*} buffer, or to the echo area. | |
| 1689 | |
| 1690 The object @code{nil}, in addition to its other meanings, may be used | |
| 1691 as a stream. It stands for the value of the variable | |
| 1692 @code{standard-input} or @code{standard-output}. Also, the object | |
| 1693 @code{t} as a stream specifies input using the minibuffer | |
| 1694 (@pxref{Minibuffers}) or output in the echo area (@pxref{The Echo | |
| 1695 Area}). | |
| 1696 | |
| 1697 Streams have no special printed representation or read syntax, and | |
| 1698 print as whatever primitive type they are. | |
| 1699 | |
| 1700 @xref{Read and Print}, for a description of functions | |
| 1701 related to streams, including parsing and printing functions. | |
| 1702 | |
| 1703 @node Keymap Type | |
| 1704 @subsection Keymap Type | |
| 1705 | |
| 1706 A @dfn{keymap} maps keys typed by the user to commands. This mapping | |
| 1707 controls how the user's command input is executed. | |
| 1708 | |
| 1709 NOTE: In XEmacs, a keymap is a separate primitive type. In FSF GNU | |
| 1710 Emacs, a keymap is actually a list whose @sc{car} is the symbol | |
| 1711 @code{keymap}. | |
| 1712 | |
| 1713 @xref{Keymaps}, for information about creating keymaps, handling prefix | |
| 1714 keys, local as well as global keymaps, and changing key bindings. | |
| 1715 | |
| 1716 @node Syntax Table Type | |
| 1717 @subsection Syntax Table Type | |
| 1718 | |
| 1719 Under XEmacs 20, a @dfn{syntax table} is a particular type of char | |
|
4885
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
1720 table. Under XEmacs 19, a syntax table is a vector of 256 integers. In |
| 428 | 1721 both cases, each element defines how one character is interpreted when it |
| 1722 appears in a buffer. For example, in C mode (@pxref{Major Modes}), the | |
| 1723 @samp{+} character is punctuation, but in Lisp mode it is a valid | |
| 1724 character in a symbol. These modes specify different interpretations by | |
| 1725 changing the syntax table entry for @samp{+}. | |
| 1726 | |
| 1727 Syntax tables are used only for scanning text in buffers, not for | |
| 1728 reading Lisp expressions. The table the Lisp interpreter uses to read | |
| 1729 expressions is built into the XEmacs source code and cannot be changed; | |
| 1730 thus, to change the list delimiters to be @samp{@{} and @samp{@}} | |
| 1731 instead of @samp{(} and @samp{)} would be impossible. | |
| 1732 | |
| 1733 @xref{Syntax Tables}, for details about syntax classes and how to make | |
| 1734 and modify syntax tables. | |
| 1735 | |
| 1736 @node Display Table Type | |
| 1737 @subsection Display Table Type | |
| 1738 | |
| 1739 A @dfn{display table} specifies how to display each character code. | |
| 1740 Each buffer and each window can have its own display table. A display | |
| 1741 table is actually a vector of length 256, although in XEmacs 20 this may | |
| 1742 change to be a particular type of char table. @xref{Display Tables}. | |
| 1743 | |
| 1744 @node Database Type | |
| 1745 @subsection Database Type | |
| 1746 @cindex database type | |
| 1747 | |
| 1748 (not yet documented) | |
| 1749 | |
| 1750 @node Charset Type | |
| 1751 @subsection Charset Type | |
| 1752 @cindex charset type | |
| 1753 | |
| 1754 (not yet documented) | |
| 1755 | |
| 1756 @node Coding System Type | |
| 1757 @subsection Coding System Type | |
| 1758 @cindex coding system type | |
| 1759 | |
| 1760 (not yet documented) | |
| 1761 | |
| 1762 @node ToolTalk Message Type | |
| 1763 @subsection ToolTalk Message Type | |
| 1764 | |
| 1765 (not yet documented) | |
| 1766 | |
| 1767 @node ToolTalk Pattern Type | |
| 1768 @subsection ToolTalk Pattern Type | |
| 1769 | |
| 1770 (not yet documented) | |
| 1771 | |
| 1772 @node Window-System Types | |
| 1773 @section Window-System Types | |
| 1774 @cindex window system types | |
| 1775 | |
| 1776 XEmacs also has some types that represent objects such as faces | |
| 1777 (collections of display characters), fonts, and pixmaps that are | |
| 1778 commonly found in windowing systems. | |
| 1779 | |
| 1780 @menu | |
| 1781 * Face Type:: A collection of display characteristics. | |
| 1782 * Glyph Type:: An image appearing in a buffer or elsewhere. | |
| 1783 * Specifier Type:: A way of controlling display characteristics on | |
| 1784 a per-buffer, -frame, -window, or -device level. | |
| 1785 * Font Instance Type:: The way a font appears on a particular device. | |
| 1786 * Color Instance Type:: The way a color appears on a particular device. | |
| 1787 * Image Instance Type:: The way an image appears on a particular device. | |
| 1788 * Toolbar Button Type:: An object representing a button in a toolbar. | |
| 1789 * Subwindow Type:: An externally-controlled window-system window | |
| 1790 appearing in a buffer. | |
| 1791 * X Resource Type:: A miscellaneous X resource, if Epoch support was | |
| 1792 compiled into XEmacs. | |
| 1793 @end menu | |
| 1794 | |
| 1795 @node Face Type | |
| 1796 @subsection Face Type | |
| 1797 @cindex face type | |
| 1798 | |
| 1799 (not yet documented) | |
| 1800 | |
| 1801 @node Glyph Type | |
| 1802 @subsection Glyph Type | |
| 1803 @cindex glyph type | |
| 1804 | |
| 1805 (not yet documented) | |
| 1806 | |
| 1807 @node Specifier Type | |
| 1808 @subsection Specifier Type | |
| 1809 @cindex specifier type | |
| 1810 | |
| 1811 (not yet documented) | |
| 1812 | |
| 1813 @node Font Instance Type | |
| 1814 @subsection Font Instance Type | |
| 1815 @cindex font instance type | |
| 1816 | |
| 1817 (not yet documented) | |
| 1818 | |
| 1819 @node Color Instance Type | |
| 1820 @subsection Color Instance Type | |
| 1821 @cindex color instance type | |
| 1822 | |
| 1823 (not yet documented) | |
| 1824 | |
| 1825 @node Image Instance Type | |
| 1826 @subsection Image Instance Type | |
| 1827 @cindex image instance type | |
| 1828 | |
| 1829 (not yet documented) | |
| 1830 | |
| 1831 @node Toolbar Button Type | |
| 1832 @subsection Toolbar Button Type | |
| 1833 @cindex toolbar button type | |
| 1834 | |
| 1835 (not yet documented) | |
| 1836 | |
| 1837 @node Subwindow Type | |
| 1838 @subsection Subwindow Type | |
| 1839 @cindex subwindow type | |
| 1840 | |
| 1841 (not yet documented) | |
| 1842 | |
| 1843 @node X Resource Type | |
| 1844 @subsection X Resource Type | |
| 1845 @cindex X resource type | |
| 1846 | |
| 1847 (not yet documented) | |
| 1848 | |
| 1849 @node Type Predicates | |
| 1850 @section Type Predicates | |
| 1851 @cindex predicates | |
| 1852 @cindex type checking | |
| 1853 @kindex wrong-type-argument | |
| 1854 | |
| 1855 The XEmacs Lisp interpreter itself does not perform type checking on | |
| 1856 the actual arguments passed to functions when they are called. It could | |
| 1857 not do so, since function arguments in Lisp do not have declared data | |
| 1858 types, as they do in other programming languages. It is therefore up to | |
| 1859 the individual function to test whether each actual argument belongs to | |
| 1860 a type that the function can use. | |
| 1861 | |
| 1862 All built-in functions do check the types of their actual arguments | |
| 1863 when appropriate, and signal a @code{wrong-type-argument} error if an | |
| 1864 argument is of the wrong type. For example, here is what happens if you | |
| 1865 pass an argument to @code{+} that it cannot handle: | |
| 1866 | |
| 1867 @example | |
| 1868 @group | |
| 1869 (+ 2 'a) | |
| 1870 @error{} Wrong type argument: integer-or-marker-p, a | |
| 1871 @end group | |
| 1872 @end example | |
| 1873 | |
| 1874 @cindex type predicates | |
| 1875 @cindex testing types | |
| 1876 If you want your program to handle different types differently, you | |
| 1877 must do explicit type checking. The most common way to check the type | |
| 1878 of an object is to call a @dfn{type predicate} function. Emacs has a | |
| 1879 type predicate for each type, as well as some predicates for | |
| 1880 combinations of types. | |
| 1881 | |
| 1882 A type predicate function takes one argument; it returns @code{t} if | |
| 1883 the argument belongs to the appropriate type, and @code{nil} otherwise. | |
| 1884 Following a general Lisp convention for predicate functions, most type | |
| 1885 predicates' names end with @samp{p}. | |
| 1886 | |
| 1887 Here is an example which uses the predicates @code{listp} to check for | |
| 1888 a list and @code{symbolp} to check for a symbol. | |
| 1889 | |
| 1890 @example | |
| 1891 (defun add-on (x) | |
| 1892 (cond ((symbolp x) | |
| 1893 ;; If X is a symbol, put it on LIST. | |
| 1894 (setq list (cons x list))) | |
| 1895 ((listp x) | |
| 1896 ;; If X is a list, add its elements to LIST. | |
| 1897 (setq list (append x list))) | |
| 1898 @need 3000 | |
| 1899 (t | |
| 1900 ;; We only handle symbols and lists. | |
| 1901 (error "Invalid argument %s in add-on" x)))) | |
| 1902 @end example | |
| 1903 | |
| 1904 Here is a table of predefined type predicates, in alphabetical order, | |
| 1905 with references to further information. | |
| 1906 | |
| 1907 @table @code | |
| 1908 @item annotationp | |
| 1909 @xref{Annotation Primitives, annotationp}. | |
| 1910 | |
| 1911 @item arrayp | |
| 1912 @xref{Array Functions, arrayp}. | |
| 1913 | |
| 1914 @item atom | |
| 1915 @xref{List-related Predicates, atom}. | |
| 1916 | |
| 1917 @item bit-vector-p | |
| 1918 @xref{Bit Vector Functions, bit-vector-p}. | |
| 1919 | |
| 1920 @item bitp | |
| 1921 @xref{Bit Vector Functions, bitp}. | |
| 1922 | |
| 1923 @item boolean-specifier-p | |
| 1924 @xref{Specifier Types, boolean-specifier-p}. | |
| 1925 | |
| 1926 @item buffer-glyph-p | |
| 1927 @xref{Glyph Types, buffer-glyph-p}. | |
| 1928 | |
| 1929 @item buffer-live-p | |
| 1930 @xref{Killing Buffers, buffer-live-p}. | |
| 1931 | |
| 1932 @item bufferp | |
| 1933 @xref{Buffer Basics, bufferp}. | |
| 1934 | |
| 1935 @item button-event-p | |
| 1936 @xref{Event Predicates, button-event-p}. | |
| 1937 | |
| 1938 @item button-press-event-p | |
| 1939 @xref{Event Predicates, button-press-event-p}. | |
| 1940 | |
| 1941 @item button-release-event-p | |
| 1942 @xref{Event Predicates, button-release-event-p}. | |
| 1943 | |
| 1944 @item case-table-p | |
| 1945 @xref{Case Tables, case-table-p}. | |
| 1946 | |
| 1947 @item char-int-p | |
| 1948 @xref{Character Codes, char-int-p}. | |
| 1949 | |
| 1950 @item char-or-char-int-p | |
| 1951 @xref{Character Codes, char-or-char-int-p}. | |
| 1952 | |
| 1953 @item char-or-string-p | |
| 1954 @xref{Predicates for Strings, char-or-string-p}. | |
| 1955 | |
| 1956 @item char-table-p | |
| 1957 @xref{Char Tables, char-table-p}. | |
| 1958 | |
| 1959 @item characterp | |
| 1960 @xref{Predicates for Characters, characterp}. | |
| 1961 | |
| 1962 @item color-instance-p | |
| 1963 @xref{Colors, color-instance-p}. | |
| 1964 | |
| 1965 @item color-pixmap-image-instance-p | |
| 1966 @xref{Image Instance Types, color-pixmap-image-instance-p}. | |
| 1967 | |
| 1968 @item color-specifier-p | |
| 1969 @xref{Specifier Types, color-specifier-p}. | |
| 1970 | |
| 1971 @item commandp | |
| 1972 @xref{Interactive Call, commandp}. | |
| 1973 | |
| 1974 @item compiled-function-p | |
| 1975 @xref{Compiled-Function Type, compiled-function-p}. | |
| 1976 | |
| 1977 @item console-live-p | |
| 1978 @xref{Connecting to a Console or Device, console-live-p}. | |
| 1979 | |
| 1980 @item consolep | |
| 1981 @xref{Consoles and Devices, consolep}. | |
| 1982 | |
| 1983 @item consp | |
| 1984 @xref{List-related Predicates, consp}. | |
| 1985 | |
| 1986 @item database-live-p | |
| 1987 @xref{Connecting to a Database, database-live-p}. | |
| 1988 | |
| 1989 @item databasep | |
| 1990 @xref{Databases, databasep}. | |
| 1991 | |
| 1992 @item device-live-p | |
| 1993 @xref{Connecting to a Console or Device, device-live-p}. | |
| 1994 | |
| 1995 @item device-or-frame-p | |
| 1996 @xref{Basic Device Functions, device-or-frame-p}. | |
| 1997 | |
| 1998 @item devicep | |
| 1999 @xref{Consoles and Devices, devicep}. | |
| 2000 | |
| 2001 @item eval-event-p | |
| 2002 @xref{Event Predicates, eval-event-p}. | |
| 2003 | |
| 2004 @item event-live-p | |
| 2005 @xref{Event Predicates, event-live-p}. | |
| 2006 | |
| 2007 @item eventp | |
| 2008 @xref{Events, eventp}. | |
| 2009 | |
| 2010 @item extent-live-p | |
| 2011 @xref{Creating and Modifying Extents, extent-live-p}. | |
| 2012 | |
| 2013 @item extentp | |
| 2014 @xref{Extents, extentp}. | |
| 2015 | |
| 2016 @item face-boolean-specifier-p | |
| 2017 @xref{Specifier Types, face-boolean-specifier-p}. | |
| 2018 | |
| 2019 @item facep | |
| 2020 @xref{Basic Face Functions, facep}. | |
| 2021 | |
| 2022 @item floatp | |
| 2023 @xref{Predicates on Numbers, floatp}. | |
| 2024 | |
| 2025 @item font-instance-p | |
| 2026 @xref{Fonts, font-instance-p}. | |
| 2027 | |
| 2028 @item font-specifier-p | |
| 2029 @xref{Specifier Types, font-specifier-p}. | |
| 2030 | |
| 2031 @item frame-live-p | |
| 2032 @xref{Deleting Frames, frame-live-p}. | |
| 2033 | |
| 2034 @item framep | |
| 2035 @xref{Frames, framep}. | |
| 2036 | |
| 2037 @item functionp | |
| 2038 (not yet documented) | |
| 2039 | |
| 2040 @item generic-specifier-p | |
| 2041 @xref{Specifier Types, generic-specifier-p}. | |
| 2042 | |
| 2043 @item glyphp | |
| 2044 @xref{Glyphs, glyphp}. | |
| 2045 | |
| 2046 @item hash-table-p | |
| 2047 @xref{Hash Tables, hash-table-p}. | |
| 2048 | |
| 2049 @item icon-glyph-p | |
| 2050 @xref{Glyph Types, icon-glyph-p}. | |
| 2051 | |
| 2052 @item image-instance-p | |
| 2053 @xref{Images, image-instance-p}. | |
| 2054 | |
| 2055 @item image-specifier-p | |
| 2056 @xref{Specifier Types, image-specifier-p}. | |
| 2057 | |
| 2058 @item integer-char-or-marker-p | |
| 2059 @xref{Predicates on Markers, integer-char-or-marker-p}. | |
| 2060 | |
| 2061 @item integer-or-char-p | |
| 2062 @xref{Predicates for Characters, integer-or-char-p}. | |
| 2063 | |
| 2064 @item integer-or-marker-p | |
| 2065 @xref{Predicates on Markers, integer-or-marker-p}. | |
| 2066 | |
| 2067 @item integer-specifier-p | |
| 2068 @xref{Specifier Types, integer-specifier-p}. | |
| 2069 | |
| 2070 @item integerp | |
| 2071 @xref{Predicates on Numbers, integerp}. | |
| 2072 | |
| 2073 @item itimerp | |
| 2074 (not yet documented) | |
| 2075 | |
| 2076 @item key-press-event-p | |
| 2077 @xref{Event Predicates, key-press-event-p}. | |
| 2078 | |
| 2079 @item keymapp | |
| 2080 @xref{Creating Keymaps, keymapp}. | |
| 2081 | |
| 2082 @item keywordp | |
| 2083 (not yet documented) | |
| 2084 | |
| 2085 @item listp | |
| 2086 @xref{List-related Predicates, listp}. | |
| 2087 | |
| 2088 @item markerp | |
| 2089 @xref{Predicates on Markers, markerp}. | |
| 2090 | |
| 2091 @item misc-user-event-p | |
| 2092 @xref{Event Predicates, misc-user-event-p}. | |
| 2093 | |
| 2094 @item mono-pixmap-image-instance-p | |
| 2095 @xref{Image Instance Types, mono-pixmap-image-instance-p}. | |
| 2096 | |
| 2097 @item motion-event-p | |
| 2098 @xref{Event Predicates, motion-event-p}. | |
| 2099 | |
| 2100 @item mouse-event-p | |
| 2101 @xref{Event Predicates, mouse-event-p}. | |
| 2102 | |
| 2103 @item natnum-specifier-p | |
| 2104 @xref{Specifier Types, natnum-specifier-p}. | |
| 2105 | |
| 2106 @item natnump | |
| 2107 @xref{Predicates on Numbers, natnump}. | |
| 2108 | |
| 2109 @item nlistp | |
| 2110 @xref{List-related Predicates, nlistp}. | |
| 2111 | |
| 2112 @item nothing-image-instance-p | |
| 2113 @xref{Image Instance Types, nothing-image-instance-p}. | |
| 2114 | |
| 2115 @item number-char-or-marker-p | |
| 2116 @xref{Predicates on Markers, number-char-or-marker-p}. | |
| 2117 | |
| 2118 @item number-or-marker-p | |
| 2119 @xref{Predicates on Markers, number-or-marker-p}. | |
| 2120 | |
| 2121 @item numberp | |
| 2122 @xref{Predicates on Numbers, numberp}. | |
| 2123 | |
| 2124 @item pointer-glyph-p | |
| 2125 @xref{Glyph Types, pointer-glyph-p}. | |
| 2126 | |
| 2127 @item pointer-image-instance-p | |
| 2128 @xref{Image Instance Types, pointer-image-instance-p}. | |
| 2129 | |
| 2130 @item process-event-p | |
| 2131 @xref{Event Predicates, process-event-p}. | |
| 2132 | |
| 2133 @item processp | |
| 2134 @xref{Processes, processp}. | |
| 2135 | |
| 2136 @item range-table-p | |
| 2137 @xref{Range Tables, range-table-p}. | |
| 2138 | |
| 2139 @item ringp | |
| 2140 (not yet documented) | |
| 2141 | |
| 2142 @item sequencep | |
| 2143 @xref{Sequence Functions, sequencep}. | |
| 2144 | |
| 2145 @item specifierp | |
| 2146 @xref{Specifiers, specifierp}. | |
| 2147 | |
| 2148 @item stringp | |
| 2149 @xref{Predicates for Strings, stringp}. | |
| 2150 | |
| 2151 @item subrp | |
| 2152 @xref{Function Cells, subrp}. | |
| 2153 | |
| 2154 @item subwindow-image-instance-p | |
| 2155 @xref{Image Instance Types, subwindow-image-instance-p}. | |
| 2156 | |
| 2157 @item subwindowp | |
| 2158 @xref{Subwindows, subwindowp}. | |
| 2159 | |
| 2160 @item symbolp | |
| 2161 @xref{Symbols, symbolp}. | |
| 2162 | |
| 2163 @item syntax-table-p | |
| 2164 @xref{Syntax Tables, syntax-table-p}. | |
| 2165 | |
| 2166 @item text-image-instance-p | |
| 2167 @xref{Image Instance Types, text-image-instance-p}. | |
| 2168 | |
| 2169 @item timeout-event-p | |
| 2170 @xref{Event Predicates, timeout-event-p}. | |
| 2171 | |
| 2172 @item toolbar-button-p | |
| 2173 @xref{Toolbar, toolbar-button-p}. | |
| 2174 | |
| 2175 @item toolbar-specifier-p | |
| 2176 @xref{Toolbar, toolbar-specifier-p}. | |
| 2177 | |
| 2178 @item user-variable-p | |
| 2179 @xref{Defining Variables, user-variable-p}. | |
| 2180 | |
| 2181 @item vectorp | |
| 2182 @xref{Vectors, vectorp}. | |
| 2183 | |
| 2184 @item weak-list-p | |
| 2185 @xref{Weak Lists, weak-list-p}. | |
| 2186 | |
| 2187 @ignore | |
| 2188 @item wholenump | |
| 2189 @xref{Predicates on Numbers, wholenump}. | |
| 2190 @end ignore | |
| 2191 | |
| 2192 @item window-configuration-p | |
| 2193 @xref{Window Configurations, window-configuration-p}. | |
| 2194 | |
| 2195 @item window-live-p | |
| 2196 @xref{Deleting Windows, window-live-p}. | |
| 2197 | |
| 2198 @item windowp | |
| 2199 @xref{Basic Windows, windowp}. | |
| 2200 @end table | |
| 2201 | |
| 2202 The most general way to check the type of an object is to call the | |
| 2203 function @code{type-of}. Recall that each object belongs to one and | |
| 2204 only one primitive type; @code{type-of} tells you which one (@pxref{Lisp | |
| 2205 Data Types}). But @code{type-of} knows nothing about non-primitive | |
| 2206 types. In most cases, it is more convenient to use type predicates than | |
| 2207 @code{type-of}. | |
| 2208 | |
| 2209 @defun type-of object | |
| 2210 This function returns a symbol naming the primitive type of | |
| 2211 @var{object}. The value is one of @code{bit-vector}, @code{buffer}, | |
| 2212 @code{char-table}, @code{character}, @code{charset}, | |
| 2213 @code{coding-system}, @code{cons}, @code{color-instance}, | |
| 2214 @code{compiled-function}, @code{console}, @code{database}, | |
| 2215 @code{device}, @code{event}, @code{extent}, @code{face}, @code{float}, | |
| 2216 @code{font-instance}, @code{frame}, @code{glyph}, @code{hash-table}, | |
| 2217 @code{image-instance}, @code{integer}, @code{keymap}, @code{marker}, | |
| 2218 @code{process}, @code{range-table}, @code{specifier}, @code{string}, | |
| 2219 @code{subr}, @code{subwindow}, @code{symbol}, @code{toolbar-button}, | |
| 2220 @code{tooltalk-message}, @code{tooltalk-pattern}, @code{vector}, | |
| 2221 @code{weak-list}, @code{window}, @code{window-configuration}, or | |
| 2222 @code{x-resource}. | |
| 2223 | |
| 2224 @example | |
| 2225 (type-of 1) | |
| 2226 @result{} integer | |
| 2227 (type-of 'nil) | |
| 2228 @result{} symbol | |
| 2229 (type-of '()) ; @r{@code{()} is @code{nil}.} | |
| 2230 @result{} symbol | |
| 2231 (type-of '(x)) | |
| 2232 @result{} cons | |
| 2233 @end example | |
| 2234 @end defun | |
| 2235 | |
| 2236 @node Equality Predicates | |
| 2237 @section Equality Predicates | |
| 2238 @cindex equality | |
| 2239 | |
| 2240 Here we describe two functions that test for equality between any two | |
| 2241 objects. Other functions test equality between objects of specific | |
| 2242 types, e.g., strings. For these predicates, see the appropriate chapter | |
| 2243 describing the data type. | |
| 2244 | |
| 2245 @defun eq object1 object2 | |
| 2246 This function returns @code{t} if @var{object1} and @var{object2} are | |
| 2247 the same object, @code{nil} otherwise. The ``same object'' means that a | |
| 2248 change in one will be reflected by the same change in the other. | |
| 2249 | |
| 2250 @code{eq} returns @code{t} if @var{object1} and @var{object2} are | |
|
4885
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4820
diff
changeset
|
2251 fixnums with the same value. It is preferable to use @code{=} or |
|
4472
a99eb40f0b5b
Correct an omitted word, expand on bignum equality in the lispref.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4471
diff
changeset
|
2252 @code{eql} in many contexts for numeric comparison, especially since |
|
a99eb40f0b5b
Correct an omitted word, expand on bignum equality in the lispref.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4471
diff
changeset
|
2253 bignums (integers with values that would have otherwise overflowed, only |
|
a99eb40f0b5b
Correct an omitted word, expand on bignum equality in the lispref.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4471
diff
changeset
|
2254 available on some builds) with the same value are not @code{eq}; |
|
a99eb40f0b5b
Correct an omitted word, expand on bignum equality in the lispref.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4471
diff
changeset
|
2255 @pxref{Comparison of Numbers}. @code{eq} also returns @code{t} if |
|
a99eb40f0b5b
Correct an omitted word, expand on bignum equality in the lispref.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4471
diff
changeset
|
2256 @var{object1} and @var{object2} are identical characters, though in this |
|
a99eb40f0b5b
Correct an omitted word, expand on bignum equality in the lispref.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4471
diff
changeset
|
2257 case you may prefer to use @code{char=}. |
|
4471
2d39535e1f9d
Say explicitly that eq is useful for chars; xref number comparison, lispref
Aidan Kehoe <kehoea@parhasard.net>
parents:
4265
diff
changeset
|
2258 |
|
2d39535e1f9d
Say explicitly that eq is useful for chars; xref number comparison, lispref
Aidan Kehoe <kehoea@parhasard.net>
parents:
4265
diff
changeset
|
2259 Also, since symbol names are normally unique, if the arguments are |
|
2d39535e1f9d
Say explicitly that eq is useful for chars; xref number comparison, lispref
Aidan Kehoe <kehoea@parhasard.net>
parents:
4265
diff
changeset
|
2260 symbols with the same name, they are @code{eq}. For other types (e.g., |
|
2d39535e1f9d
Say explicitly that eq is useful for chars; xref number comparison, lispref
Aidan Kehoe <kehoea@parhasard.net>
parents:
4265
diff
changeset
|
2261 lists, vectors, strings), two arguments with the same contents or |
|
2d39535e1f9d
Say explicitly that eq is useful for chars; xref number comparison, lispref
Aidan Kehoe <kehoea@parhasard.net>
parents:
4265
diff
changeset
|
2262 elements are not necessarily @code{eq} to each other: they are @code{eq} |
|
2d39535e1f9d
Say explicitly that eq is useful for chars; xref number comparison, lispref
Aidan Kehoe <kehoea@parhasard.net>
parents:
4265
diff
changeset
|
2263 only if they are the same object. |
| 428 | 2264 |
| 2265 (The @code{make-symbol} function returns an uninterned symbol that is | |
| 2266 not interned in the standard @code{obarray}. When uninterned symbols | |
| 2267 are in use, symbol names are no longer unique. Distinct symbols with | |
| 2268 the same name are not @code{eq}. @xref{Creating Symbols}.) | |
| 2269 | |
| 2270 NOTE: Under XEmacs 19, characters are really just integers, and thus | |
|
4472
a99eb40f0b5b
Correct an omitted word, expand on bignum equality in the lispref.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4471
diff
changeset
|
2271 characters and integers with the same numeric code are @code{eq}. Under |
|
4471
2d39535e1f9d
Say explicitly that eq is useful for chars; xref number comparison, lispref
Aidan Kehoe <kehoea@parhasard.net>
parents:
4265
diff
changeset
|
2272 XEmacs 20, it was necessary to preserve remnants of this in function |
|
2d39535e1f9d
Say explicitly that eq is useful for chars; xref number comparison, lispref
Aidan Kehoe <kehoea@parhasard.net>
parents:
4265
diff
changeset
|
2273 such as @code{old-eq} in order to maintain byte-code compatibility. |
|
2d39535e1f9d
Say explicitly that eq is useful for chars; xref number comparison, lispref
Aidan Kehoe <kehoea@parhasard.net>
parents:
4265
diff
changeset
|
2274 Byte code compiled under any Emacs 19 will automatically have calls to |
|
2d39535e1f9d
Say explicitly that eq is useful for chars; xref number comparison, lispref
Aidan Kehoe <kehoea@parhasard.net>
parents:
4265
diff
changeset
|
2275 @code{eq} mapped to @code{old-eq} when executed under XEmacs 20. |
| 428 | 2276 |
| 2277 @example | |
| 2278 @group | |
| 2279 (eq 'foo 'foo) | |
| 2280 @result{} t | |
| 2281 @end group | |
| 2282 | |
| 2283 @group | |
| 2284 (eq 456 456) | |
| 2285 @result{} t | |
| 2286 @end group | |
| 2287 | |
| 2288 @group | |
| 2289 (eq "asdf" "asdf") | |
| 2290 @result{} nil | |
| 2291 @end group | |
| 2292 | |
| 2293 @group | |
| 2294 (eq '(1 (2 (3))) '(1 (2 (3)))) | |
| 2295 @result{} nil | |
| 2296 @end group | |
| 2297 | |
| 2298 @group | |
| 2299 (setq foo '(1 (2 (3)))) | |
| 2300 @result{} (1 (2 (3))) | |
| 2301 (eq foo foo) | |
| 2302 @result{} t | |
| 2303 (eq foo '(1 (2 (3)))) | |
| 2304 @result{} nil | |
| 2305 @end group | |
| 2306 | |
| 2307 @group | |
| 2308 (eq [(1 2) 3] [(1 2) 3]) | |
| 2309 @result{} nil | |
| 2310 @end group | |
| 2311 | |
| 2312 @group | |
| 2313 (eq (point-marker) (point-marker)) | |
| 2314 @result{} nil | |
| 2315 @end group | |
| 2316 @end example | |
| 2317 | |
| 2318 @end defun | |
| 2319 | |
| 444 | 2320 @defun old-eq object1 object2 |
| 428 | 2321 This function exists under XEmacs 20 and is exactly like @code{eq} |
| 2322 except that it suffers from the char-int confoundance disease. | |
| 2323 In other words, it returns @code{t} if given a character and the | |
| 2324 equivalent integer, even though the objects are of different types! | |
| 2325 You should @emph{not} ever call this function explicitly in your | |
| 2326 code. However, be aware that all calls to @code{eq} in byte code | |
| 2327 compiled under version 19 map to @code{old-eq} in XEmacs 20. | |
| 2328 (Likewise for @code{old-equal}, @code{old-memq}, @code{old-member}, | |
| 2329 @code{old-assq} and @code{old-assoc}.) | |
| 2330 | |
| 2331 @example | |
| 2332 @group | |
| 2333 ;; @r{Remember, this does not apply under XEmacs 19.} | |
| 2334 ?A | |
| 2335 @result{} ?A | |
| 2336 (char-int ?A) | |
| 2337 @result{} 65 | |
| 2338 (old-eq ?A 65) | |
| 2339 @result{} t ; @r{Eek, we've been infected.} | |
| 2340 (eq ?A 65) | |
| 2341 @result{} nil ; @r{We are still healthy.} | |
| 2342 @end group | |
| 2343 @end example | |
| 2344 @end defun | |
| 2345 | |
| 2346 @defun equal object1 object2 | |
| 2347 This function returns @code{t} if @var{object1} and @var{object2} have | |
| 2348 equal components, @code{nil} otherwise. Whereas @code{eq} tests if its | |
| 2349 arguments are the same object, @code{equal} looks inside nonidentical | |
| 2350 arguments to see if their elements are the same. So, if two objects are | |
| 2351 @code{eq}, they are @code{equal}, but the converse is not always true. | |
| 2352 | |
| 2353 @example | |
| 2354 @group | |
| 2355 (equal 'foo 'foo) | |
| 2356 @result{} t | |
| 2357 @end group | |
| 2358 | |
| 2359 @group | |
| 2360 (equal 456 456) | |
| 2361 @result{} t | |
| 2362 @end group | |
| 2363 | |
| 2364 @group | |
| 2365 (equal "asdf" "asdf") | |
| 2366 @result{} t | |
| 2367 @end group | |
| 2368 @group | |
| 2369 (eq "asdf" "asdf") | |
| 2370 @result{} nil | |
| 2371 @end group | |
| 2372 | |
| 2373 @group | |
| 2374 (equal '(1 (2 (3))) '(1 (2 (3)))) | |
| 2375 @result{} t | |
| 2376 @end group | |
| 2377 @group | |
| 2378 (eq '(1 (2 (3))) '(1 (2 (3)))) | |
| 2379 @result{} nil | |
| 2380 @end group | |
| 2381 | |
| 2382 @group | |
| 2383 (equal [(1 2) 3] [(1 2) 3]) | |
| 2384 @result{} t | |
| 2385 @end group | |
| 2386 @group | |
| 2387 (eq [(1 2) 3] [(1 2) 3]) | |
| 2388 @result{} nil | |
| 2389 @end group | |
| 2390 | |
| 2391 @group | |
| 2392 (equal (point-marker) (point-marker)) | |
| 2393 @result{} t | |
| 2394 @end group | |
| 2395 | |
| 2396 @group | |
| 2397 (eq (point-marker) (point-marker)) | |
| 2398 @result{} nil | |
| 2399 @end group | |
| 2400 @end example | |
| 2401 | |
| 2402 Comparison of strings is case-sensitive. | |
| 2403 | |
| 2404 Note that in FSF GNU Emacs, comparison of strings takes into account | |
| 2405 their text properties, and you have to use @code{string-equal} if you | |
| 2406 want only the strings themselves compared. This difference does not | |
| 2407 exist in XEmacs; @code{equal} and @code{string-equal} always return | |
| 2408 the same value on the same strings. | |
| 2409 | |
| 2410 @ignore @c Not true in XEmacs | |
| 2411 Comparison of strings is case-sensitive and takes account of text | |
| 2412 properties as well as the characters in the strings. To compare | |
| 2413 two strings' characters without comparing their text properties, | |
| 2414 use @code{string=} (@pxref{Text Comparison}). | |
| 2415 @end ignore | |
| 2416 | |
| 2417 @example | |
| 2418 @group | |
| 2419 (equal "asdf" "ASDF") | |
| 2420 @result{} nil | |
| 2421 @end group | |
| 2422 @end example | |
| 2423 | |
| 2424 Two distinct buffers are never @code{equal}, even if their contents | |
| 2425 are the same. | |
| 2426 @end defun | |
| 2427 | |
| 2428 The test for equality is implemented recursively, and circular lists may | |
| 2429 therefore cause infinite recursion (leading to an error). | |
|
4792
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2430 |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2431 @defun equalp object1 object2 |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2432 This function is like @code{equal}, but compares characters and strings |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2433 case-insensitively; numbers are compared using @code{=}; arrays (that |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2434 is, strings, bit-vectors and vectors) are regarded as being |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2435 @code{equalp} if their contents are @code{equalp}; and |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2436 @code{hash-tables} are @code{equalp} if their values are @code{equalp} |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2437 and they would otherwise be @code{equal}. |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2438 |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2439 @code{equalp} is recursive with vectors, lists and hash-tables, but not |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2440 with other complex types. For types without a defined @code{equalp} |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2441 behavior, @code{equalp} behaves as @code{equal} does. |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2442 |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2443 @example |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2444 @group |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2445 (equalp "asdf" "ASDF") |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2446 @result{} t |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2447 @end group |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2448 @group |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2449 (equalp "asdf" [?a ?s ?D ?F]) |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2450 @result{} t |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2451 @end group |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2452 @group |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2453 (equalp "asdf" [?a ?s ?D ?F ?g]) |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2454 @result{} nil |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2455 @end group |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2456 @group |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2457 (equalp "" (bit-vector)) |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2458 @result{} t |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2459 @end group |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2460 @group |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2461 (equalp #s(hash-table) (make-hash-table)) |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2462 @result{} t |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2463 @end group |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2464 @group |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2465 (equalp #s(hash-table data (t "hi there")) |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2466 (let ((ht (make-hash-table))) |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2467 (puthash t "HI THERE" ht) |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2468 ht)) |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2469 @result{} t |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2470 @group |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2471 @end group |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2472 (equalp #s(hash-table test eq data (1.0 "hi there")) |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2473 (let ((ht (make-hash-table :test 'eql))) |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2474 (puthash 1.0 "HI THERE" ht) |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2475 ht)) |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2476 @result{} nil |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2477 @end group |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2478 @end example |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2479 @end defun |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2480 |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2481 @code{equalp} can also provoke an error if handed a circular structure, |
|
95b04754ea8c
Make #'equalp more compatible with CL; add a compiler macro, test & doc it.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4486
diff
changeset
|
2482 as with @code{equal}. |