Mercurial > emacs
annotate lispref/streams.texi @ 21811:180afb14ad52
(main): Fix bug report address.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 28 Apr 1998 21:33:28 +0000 |
parents | 90da2489c498 |
children | d4ac295a98b3 |
rev | line source |
---|---|
6381 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1998 Free Software Foundation, Inc. |
6381 | 4 @c See the file elisp.texi for copying conditions. |
5 @setfilename ../info/streams | |
7115
9a9e88e65617
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6381
diff
changeset
|
6 @node Read and Print, Minibuffers, Debugging, Top |
6381 | 7 @comment node-name, next, previous, up |
8 @chapter Reading and Printing Lisp Objects | |
9 | |
10 @dfn{Printing} and @dfn{reading} are the operations of converting Lisp | |
11 objects to textual form and vice versa. They use the printed | |
7115
9a9e88e65617
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6381
diff
changeset
|
12 representations and read syntax described in @ref{Lisp Data Types}. |
6381 | 13 |
14 This chapter describes the Lisp functions for reading and printing. | |
15 It also describes @dfn{streams}, which specify where to get the text (if | |
16 reading) or where to put it (if printing). | |
17 | |
18 @menu | |
19 * Streams Intro:: Overview of streams, reading and printing. | |
20 * Input Streams:: Various data types that can be used as input streams. | |
21 * Input Functions:: Functions to read Lisp objects from text. | |
22 * Output Streams:: Various data types that can be used as output streams. | |
23 * Output Functions:: Functions to print Lisp objects as text. | |
24 * Output Variables:: Variables that control what the printing functions do. | |
25 @end menu | |
26 | |
27 @node Streams Intro | |
28 @section Introduction to Reading and Printing | |
29 @cindex Lisp reader | |
30 @cindex printing | |
31 @cindex reading | |
32 | |
33 @dfn{Reading} a Lisp object means parsing a Lisp expression in textual | |
34 form and producing a corresponding Lisp object. This is how Lisp | |
35 programs get into Lisp from files of Lisp code. We call the text the | |
36 @dfn{read syntax} of the object. For example, the text @samp{(a .@: 5)} | |
37 is the read syntax for a cons cell whose @sc{car} is @code{a} and whose | |
38 @sc{cdr} is the number 5. | |
39 | |
40 @dfn{Printing} a Lisp object means producing text that represents that | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
41 object---converting the object to its @dfn{printed representation} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
42 (@pxref{Printed Representation}). Printing the cons cell described |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
43 above produces the text @samp{(a .@: 5)}. |
6381 | 44 |
45 Reading and printing are more or less inverse operations: printing the | |
46 object that results from reading a given piece of text often produces | |
47 the same text, and reading the text that results from printing an object | |
48 usually produces a similar-looking object. For example, printing the | |
49 symbol @code{foo} produces the text @samp{foo}, and reading that text | |
50 returns the symbol @code{foo}. Printing a list whose elements are | |
51 @code{a} and @code{b} produces the text @samp{(a b)}, and reading that | |
7219 | 52 text produces a list (but not the same list) with elements @code{a} |
6381 | 53 and @code{b}. |
54 | |
55 However, these two operations are not precisely inverses. There are | |
12098 | 56 three kinds of exceptions: |
6381 | 57 |
58 @itemize @bullet | |
59 @item | |
60 Printing can produce text that cannot be read. For example, buffers, | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
61 windows, frames, subprocesses and markers print as text that starts |
6381 | 62 with @samp{#}; if you try to read this text, you get an error. There is |
63 no way to read those data types. | |
64 | |
65 @item | |
66 One object can have multiple textual representations. For example, | |
67 @samp{1} and @samp{01} represent the same integer, and @samp{(a b)} and | |
68 @samp{(a .@: (b))} represent the same list. Reading will accept any of | |
69 the alternatives, but printing must choose one of them. | |
12098 | 70 |
71 @item | |
72 Comments can appear at certain points in the middle of an object's | |
73 read sequence without affecting the result of reading it. | |
6381 | 74 @end itemize |
75 | |
76 @node Input Streams | |
77 @section Input Streams | |
78 @cindex stream (for reading) | |
79 @cindex input stream | |
80 | |
81 Most of the Lisp functions for reading text take an @dfn{input stream} | |
82 as an argument. The input stream specifies where or how to get the | |
83 characters of the text to be read. Here are the possible types of input | |
84 stream: | |
85 | |
86 @table @asis | |
87 @item @var{buffer} | |
88 @cindex buffer input stream | |
89 The input characters are read from @var{buffer}, starting with the | |
90 character directly after point. Point advances as characters are read. | |
91 | |
92 @item @var{marker} | |
93 @cindex marker input stream | |
94 The input characters are read from the buffer that @var{marker} is in, | |
95 starting with the character directly after the marker. The marker | |
96 position advances as characters are read. The value of point in the | |
97 buffer has no effect when the stream is a marker. | |
98 | |
99 @item @var{string} | |
100 @cindex string input stream | |
101 The input characters are taken from @var{string}, starting at the first | |
102 character in the string and using as many characters as required. | |
103 | |
104 @item @var{function} | |
105 @cindex function input stream | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
106 The input characters are generated by @var{function}, which must support |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
107 two kinds of calls: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
108 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
109 @itemize @bullet |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
110 @item |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
111 When it is called with no arguments, it should return the next character. |
6381 | 112 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
113 @item |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
114 When it is called with one argument (always a character), @var{function} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
115 should save the argument and arrange to return it on the next call. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
116 This is called @dfn{unreading} the character; it happens when the Lisp |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
117 reader reads one character too many and wants to ``put it back where it |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
118 came from''. In this case, it makes no difference what value |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
119 @var{function} returns. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
120 @end itemize |
6381 | 121 |
122 @item @code{t} | |
123 @cindex @code{t} input stream | |
124 @code{t} used as a stream means that the input is read from the | |
125 minibuffer. In fact, the minibuffer is invoked once and the text | |
126 given by the user is made into a string that is then used as the | |
127 input stream. | |
128 | |
129 @item @code{nil} | |
130 @cindex @code{nil} input stream | |
131 @code{nil} supplied as an input stream means to use the value of | |
132 @code{standard-input} instead; that value is the @dfn{default input | |
133 stream}, and must be a non-@code{nil} input stream. | |
134 | |
135 @item @var{symbol} | |
136 A symbol as input stream is equivalent to the symbol's function | |
137 definition (if any). | |
138 @end table | |
139 | |
7219 | 140 Here is an example of reading from a stream that is a buffer, showing |
6381 | 141 where point is located before and after: |
142 | |
143 @example | |
144 @group | |
145 ---------- Buffer: foo ---------- | |
146 This@point{} is the contents of foo. | |
147 ---------- Buffer: foo ---------- | |
148 @end group | |
149 | |
150 @group | |
151 (read (get-buffer "foo")) | |
152 @result{} is | |
153 @end group | |
154 @group | |
155 (read (get-buffer "foo")) | |
156 @result{} the | |
157 @end group | |
158 | |
159 @group | |
160 ---------- Buffer: foo ---------- | |
161 This is the@point{} contents of foo. | |
162 ---------- Buffer: foo ---------- | |
163 @end group | |
164 @end example | |
165 | |
166 @noindent | |
7219 | 167 Note that the first read skips a space. Reading skips any amount of |
168 whitespace preceding the significant text. | |
6381 | 169 |
170 Here is an example of reading from a stream that is a marker, | |
7219 | 171 initially positioned at the beginning of the buffer shown. The value |
6381 | 172 read is the symbol @code{This}. |
173 | |
174 @example | |
175 @group | |
176 | |
177 ---------- Buffer: foo ---------- | |
178 This is the contents of foo. | |
179 ---------- Buffer: foo ---------- | |
180 @end group | |
181 | |
182 @group | |
183 (setq m (set-marker (make-marker) 1 (get-buffer "foo"))) | |
184 @result{} #<marker at 1 in foo> | |
185 @end group | |
186 @group | |
187 (read m) | |
188 @result{} This | |
189 @end group | |
190 @group | |
191 m | |
7219 | 192 @result{} #<marker at 5 in foo> ;; @r{Before the first space.} |
6381 | 193 @end group |
194 @end example | |
195 | |
196 Here we read from the contents of a string: | |
197 | |
198 @example | |
199 @group | |
200 (read "(When in) the course") | |
201 @result{} (When in) | |
202 @end group | |
203 @end example | |
204 | |
205 The following example reads from the minibuffer. The | |
206 prompt is: @w{@samp{Lisp expression: }}. (That is always the prompt | |
207 used when you read from the stream @code{t}.) The user's input is shown | |
208 following the prompt. | |
209 | |
210 @example | |
211 @group | |
212 (read t) | |
213 @result{} 23 | |
214 ---------- Buffer: Minibuffer ---------- | |
215 Lisp expression: @kbd{23 @key{RET}} | |
216 ---------- Buffer: Minibuffer ---------- | |
217 @end group | |
218 @end example | |
219 | |
220 Finally, here is an example of a stream that is a function, named | |
221 @code{useless-stream}. Before we use the stream, we initialize the | |
222 variable @code{useless-list} to a list of characters. Then each call to | |
7219 | 223 the function @code{useless-stream} obtains the next character in the list |
6381 | 224 or unreads a character by adding it to the front of the list. |
225 | |
226 @example | |
227 @group | |
228 (setq useless-list (append "XY()" nil)) | |
229 @result{} (88 89 40 41) | |
230 @end group | |
231 | |
232 @group | |
233 (defun useless-stream (&optional unread) | |
234 (if unread | |
235 (setq useless-list (cons unread useless-list)) | |
236 (prog1 (car useless-list) | |
237 (setq useless-list (cdr useless-list))))) | |
238 @result{} useless-stream | |
239 @end group | |
240 @end example | |
241 | |
242 @noindent | |
243 Now we read using the stream thus constructed: | |
244 | |
245 @example | |
246 @group | |
247 (read 'useless-stream) | |
248 @result{} XY | |
249 @end group | |
250 | |
251 @group | |
252 useless-list | |
7219 | 253 @result{} (40 41) |
6381 | 254 @end group |
255 @end example | |
256 | |
257 @noindent | |
7219 | 258 Note that the open and close parentheses remains in the list. The Lisp |
259 reader encountered the open parenthesis, decided that it ended the | |
260 input, and unread it. Another attempt to read from the stream at this | |
261 point would read @samp{()} and return @code{nil}. | |
6381 | 262 |
263 @defun get-file-char | |
264 This function is used internally as an input stream to read from the | |
265 input file opened by the function @code{load}. Don't use this function | |
266 yourself. | |
267 @end defun | |
268 | |
269 @node Input Functions | |
270 @section Input Functions | |
271 | |
272 This section describes the Lisp functions and variables that pertain | |
273 to reading. | |
274 | |
275 In the functions below, @var{stream} stands for an input stream (see | |
276 the previous section). If @var{stream} is @code{nil} or omitted, it | |
277 defaults to the value of @code{standard-input}. | |
278 | |
279 @kindex end-of-file | |
280 An @code{end-of-file} error is signaled if reading encounters an | |
7219 | 281 unterminated list, vector, or string. |
6381 | 282 |
283 @defun read &optional stream | |
284 This function reads one textual Lisp expression from @var{stream}, | |
285 returning it as a Lisp object. This is the basic Lisp input function. | |
286 @end defun | |
287 | |
288 @defun read-from-string string &optional start end | |
289 @cindex string to object | |
290 This function reads the first textual Lisp expression from the text in | |
291 @var{string}. It returns a cons cell whose @sc{car} is that expression, | |
292 and whose @sc{cdr} is an integer giving the position of the next | |
293 remaining character in the string (i.e., the first one not read). | |
294 | |
7219 | 295 If @var{start} is supplied, then reading begins at index @var{start} in |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
296 the string (where the first character is at index 0). If you specify |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
297 @var{end}, then reading is forced to stop just before that index, as if |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
298 the rest of the string were not there. |
6381 | 299 |
300 For example: | |
301 | |
302 @example | |
303 @group | |
304 (read-from-string "(setq x 55) (setq y 5)") | |
305 @result{} ((setq x 55) . 11) | |
306 @end group | |
307 @group | |
308 (read-from-string "\"A short string\"") | |
309 @result{} ("A short string" . 16) | |
310 @end group | |
311 | |
312 @group | |
313 ;; @r{Read starting at the first character.} | |
314 (read-from-string "(list 112)" 0) | |
315 @result{} ((list 112) . 10) | |
316 @end group | |
317 @group | |
318 ;; @r{Read starting at the second character.} | |
319 (read-from-string "(list 112)" 1) | |
7219 | 320 @result{} (list . 5) |
6381 | 321 @end group |
322 @group | |
323 ;; @r{Read starting at the seventh character,} | |
324 ;; @r{and stopping at the ninth.} | |
325 (read-from-string "(list 112)" 6 8) | |
326 @result{} (11 . 8) | |
327 @end group | |
328 @end example | |
329 @end defun | |
330 | |
331 @defvar standard-input | |
332 This variable holds the default input stream---the stream that | |
333 @code{read} uses when the @var{stream} argument is @code{nil}. | |
334 @end defvar | |
335 | |
336 @node Output Streams | |
337 @section Output Streams | |
338 @cindex stream (for printing) | |
339 @cindex output stream | |
340 | |
341 An output stream specifies what to do with the characters produced | |
342 by printing. Most print functions accept an output stream as an | |
343 optional argument. Here are the possible types of output stream: | |
344 | |
345 @table @asis | |
346 @item @var{buffer} | |
347 @cindex buffer output stream | |
348 The output characters are inserted into @var{buffer} at point. | |
349 Point advances as characters are inserted. | |
350 | |
351 @item @var{marker} | |
352 @cindex marker output stream | |
353 The output characters are inserted into the buffer that @var{marker} | |
7219 | 354 points into, at the marker position. The marker position advances as |
6381 | 355 characters are inserted. The value of point in the buffer has no effect |
356 on printing when the stream is a marker. | |
357 | |
358 @item @var{function} | |
359 @cindex function output stream | |
360 The output characters are passed to @var{function}, which is responsible | |
361 for storing them away. It is called with a single character as | |
362 argument, as many times as there are characters to be output, and is | |
363 free to do anything at all with the characters it receives. | |
364 | |
365 @item @code{t} | |
366 @cindex @code{t} output stream | |
367 The output characters are displayed in the echo area. | |
368 | |
369 @item @code{nil} | |
370 @cindex @code{nil} output stream | |
371 @code{nil} specified as an output stream means to the value of | |
372 @code{standard-output} instead; that value is the @dfn{default output | |
373 stream}, and must be a non-@code{nil} output stream. | |
374 | |
375 @item @var{symbol} | |
376 A symbol as output stream is equivalent to the symbol's function | |
377 definition (if any). | |
378 @end table | |
379 | |
7219 | 380 Many of the valid output streams are also valid as input streams. The |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
381 difference between input and output streams is therefore more a matter |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
382 of how you use a Lisp object, than of different types of object. |
7219 | 383 |
6381 | 384 Here is an example of a buffer used as an output stream. Point is |
385 initially located as shown immediately before the @samp{h} in | |
386 @samp{the}. At the end, point is located directly before that same | |
387 @samp{h}. | |
388 | |
389 @cindex print example | |
390 @example | |
391 @group | |
15800
18c0e05d1bff
Make examples in Output Streams stand on their own.
Richard M. Stallman <rms@gnu.org>
parents:
15763
diff
changeset
|
392 (setq m (set-marker (make-marker) 10 (get-buffer "foo"))) |
18c0e05d1bff
Make examples in Output Streams stand on their own.
Richard M. Stallman <rms@gnu.org>
parents:
15763
diff
changeset
|
393 @result{} #<marker at 10 in foo> |
18c0e05d1bff
Make examples in Output Streams stand on their own.
Richard M. Stallman <rms@gnu.org>
parents:
15763
diff
changeset
|
394 @end group |
18c0e05d1bff
Make examples in Output Streams stand on their own.
Richard M. Stallman <rms@gnu.org>
parents:
15763
diff
changeset
|
395 |
18c0e05d1bff
Make examples in Output Streams stand on their own.
Richard M. Stallman <rms@gnu.org>
parents:
15763
diff
changeset
|
396 @group |
6381 | 397 ---------- Buffer: foo ---------- |
398 This is t@point{}he contents of foo. | |
399 ---------- Buffer: foo ---------- | |
400 @end group | |
401 | |
402 (print "This is the output" (get-buffer "foo")) | |
403 @result{} "This is the output" | |
404 | |
405 @group | |
15800
18c0e05d1bff
Make examples in Output Streams stand on their own.
Richard M. Stallman <rms@gnu.org>
parents:
15763
diff
changeset
|
406 m |
18c0e05d1bff
Make examples in Output Streams stand on their own.
Richard M. Stallman <rms@gnu.org>
parents:
15763
diff
changeset
|
407 @result{} #<marker at 32 in foo> |
18c0e05d1bff
Make examples in Output Streams stand on their own.
Richard M. Stallman <rms@gnu.org>
parents:
15763
diff
changeset
|
408 @end group |
18c0e05d1bff
Make examples in Output Streams stand on their own.
Richard M. Stallman <rms@gnu.org>
parents:
15763
diff
changeset
|
409 @group |
6381 | 410 ---------- Buffer: foo ---------- |
411 This is t | |
412 "This is the output" | |
413 @point{}he contents of foo. | |
414 ---------- Buffer: foo ---------- | |
415 @end group | |
416 @end example | |
417 | |
418 Now we show a use of a marker as an output stream. Initially, the | |
7219 | 419 marker is in buffer @code{foo}, between the @samp{t} and the @samp{h} in |
420 the word @samp{the}. At the end, the marker has advanced over the | |
421 inserted text so that it remains positioned before the same @samp{h}. | |
422 Note that the location of point, shown in the usual fashion, has no | |
423 effect. | |
6381 | 424 |
425 @example | |
426 @group | |
427 ---------- Buffer: foo ---------- | |
428 "This is the @point{}output" | |
429 ---------- Buffer: foo ---------- | |
430 @end group | |
431 | |
432 @group | |
433 m | |
434 @result{} #<marker at 11 in foo> | |
435 @end group | |
436 | |
437 @group | |
438 (print "More output for foo." m) | |
439 @result{} "More output for foo." | |
440 @end group | |
441 | |
442 @group | |
443 ---------- Buffer: foo ---------- | |
444 "This is t | |
445 "More output for foo." | |
446 he @point{}output" | |
447 ---------- Buffer: foo ---------- | |
448 @end group | |
449 | |
450 @group | |
451 m | |
452 @result{} #<marker at 35 in foo> | |
453 @end group | |
454 @end example | |
455 | |
456 The following example shows output to the echo area: | |
457 | |
458 @example | |
459 @group | |
460 (print "Echo Area output" t) | |
461 @result{} "Echo Area output" | |
462 ---------- Echo Area ---------- | |
463 "Echo Area output" | |
464 ---------- Echo Area ---------- | |
465 @end group | |
466 @end example | |
467 | |
468 Finally, we show the use of a function as an output stream. The | |
469 function @code{eat-output} takes each character that it is given and | |
470 conses it onto the front of the list @code{last-output} (@pxref{Building | |
471 Lists}). At the end, the list contains all the characters output, but | |
472 in reverse order. | |
473 | |
474 @example | |
475 @group | |
476 (setq last-output nil) | |
477 @result{} nil | |
478 @end group | |
479 | |
480 @group | |
481 (defun eat-output (c) | |
482 (setq last-output (cons c last-output))) | |
483 @result{} eat-output | |
484 @end group | |
485 | |
486 @group | |
487 (print "This is the output" 'eat-output) | |
488 @result{} "This is the output" | |
489 @end group | |
490 | |
491 @group | |
492 last-output | |
493 @result{} (10 34 116 117 112 116 117 111 32 101 104 | |
494 116 32 115 105 32 115 105 104 84 34 10) | |
495 @end group | |
496 @end example | |
497 | |
498 @noindent | |
499 Now we can put the output in the proper order by reversing the list: | |
500 | |
501 @example | |
502 @group | |
503 (concat (nreverse last-output)) | |
504 @result{} " | |
505 \"This is the output\" | |
506 " | |
507 @end group | |
508 @end example | |
509 | |
7219 | 510 @noindent |
511 Calling @code{concat} converts the list to a string so you can see its | |
512 contents more clearly. | |
513 | |
6381 | 514 @node Output Functions |
515 @section Output Functions | |
516 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
517 This section describes the Lisp functions for printing Lisp |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
518 objects---converting objects into their printed representation. |
6381 | 519 |
520 @cindex @samp{"} in printing | |
521 @cindex @samp{\} in printing | |
522 @cindex quoting characters in printing | |
523 @cindex escape characters in printing | |
524 Some of the Emacs printing functions add quoting characters to the | |
525 output when necessary so that it can be read properly. The quoting | |
526 characters used are @samp{"} and @samp{\}; they distinguish strings from | |
527 symbols, and prevent punctuation characters in strings and symbols from | |
7219 | 528 being taken as delimiters when reading. @xref{Printed Representation}, |
529 for full details. You specify quoting or no quoting by the choice of | |
530 printing function. | |
6381 | 531 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
532 If the text is to be read back into Lisp, then you should print with |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
533 quoting characters to avoid ambiguity. Likewise, if the purpose is to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
534 describe a Lisp object clearly for a Lisp programmer. However, if the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
535 purpose of the output is to look nice for humans, then it is usually |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
536 better to print without quoting. |
6381 | 537 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
538 Printing a self-referent Lisp object in the normal way would require |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
539 an infinite amount of text, and could even result in stack overflow. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
540 Emacs detects such recursion and prints @samp{#@var{level}} instead of |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
541 recursively printing an object already being printed. For example, here |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
542 @samp{#0} indicates a recursive reference to the object at level 0 of |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
543 the current print operation: |
6381 | 544 |
545 @example | |
546 (setq foo (list nil)) | |
547 @result{} (nil) | |
548 (setcar foo foo) | |
549 @result{} (#0) | |
550 @end example | |
551 | |
552 In the functions below, @var{stream} stands for an output stream. | |
553 (See the previous section for a description of output streams.) If | |
554 @var{stream} is @code{nil} or omitted, it defaults to the value of | |
555 @code{standard-output}. | |
556 | |
557 @defun print object &optional stream | |
558 @cindex Lisp printer | |
559 The @code{print} function is a convenient way of printing. It outputs | |
560 the printed representation of @var{object} to @var{stream}, printing in | |
561 addition one newline before @var{object} and another after it. Quoting | |
562 characters are used. @code{print} returns @var{object}. For example: | |
563 | |
564 @example | |
565 @group | |
566 (progn (print 'The\ cat\ in) | |
567 (print "the hat") | |
568 (print " came back")) | |
569 @print{} | |
570 @print{} The\ cat\ in | |
571 @print{} | |
572 @print{} "the hat" | |
573 @print{} | |
574 @print{} " came back" | |
575 @print{} | |
576 @result{} " came back" | |
577 @end group | |
578 @end example | |
579 @end defun | |
580 | |
581 @defun prin1 object &optional stream | |
582 This function outputs the printed representation of @var{object} to | |
7219 | 583 @var{stream}. It does not print newlines to separate output as |
584 @code{print} does, but it does use quoting characters just like | |
585 @code{print}. It returns @var{object}. | |
6381 | 586 |
587 @example | |
588 @group | |
589 (progn (prin1 'The\ cat\ in) | |
590 (prin1 "the hat") | |
591 (prin1 " came back")) | |
592 @print{} The\ cat\ in"the hat"" came back" | |
593 @result{} " came back" | |
594 @end group | |
595 @end example | |
596 @end defun | |
597 | |
598 @defun princ object &optional stream | |
599 This function outputs the printed representation of @var{object} to | |
600 @var{stream}. It returns @var{object}. | |
601 | |
602 This function is intended to produce output that is readable by people, | |
603 not by @code{read}, so it doesn't insert quoting characters and doesn't | |
604 put double-quotes around the contents of strings. It does not add any | |
605 spacing between calls. | |
606 | |
607 @example | |
608 @group | |
609 (progn | |
610 (princ 'The\ cat) | |
611 (princ " in the \"hat\"")) | |
612 @print{} The cat in the "hat" | |
613 @result{} " in the \"hat\"" | |
614 @end group | |
615 @end example | |
616 @end defun | |
617 | |
618 @defun terpri &optional stream | |
619 @cindex newline in print | |
620 This function outputs a newline to @var{stream}. The name stands | |
621 for ``terminate print''. | |
622 @end defun | |
623 | |
624 @defun write-char character &optional stream | |
625 This function outputs @var{character} to @var{stream}. It returns | |
626 @var{character}. | |
627 @end defun | |
628 | |
629 @defun prin1-to-string object &optional noescape | |
630 @cindex object to string | |
631 This function returns a string containing the text that @code{prin1} | |
632 would have printed for the same argument. | |
633 | |
634 @example | |
635 @group | |
636 (prin1-to-string 'foo) | |
637 @result{} "foo" | |
638 @end group | |
639 @group | |
640 (prin1-to-string (mark-marker)) | |
641 @result{} "#<marker at 2773 in strings.texi>" | |
642 @end group | |
643 @end example | |
644 | |
645 If @var{noescape} is non-@code{nil}, that inhibits use of quoting | |
646 characters in the output. (This argument is supported in Emacs versions | |
647 19 and later.) | |
648 | |
649 @example | |
650 @group | |
651 (prin1-to-string "foo") | |
652 @result{} "\"foo\"" | |
653 @end group | |
654 @group | |
655 (prin1-to-string "foo" t) | |
656 @result{} "foo" | |
657 @end group | |
658 @end example | |
659 | |
660 See @code{format}, in @ref{String Conversion}, for other ways to obtain | |
661 the printed representation of a Lisp object as a string. | |
662 @end defun | |
663 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
664 @tindex with-output-to-string |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
665 @defmac with-output-to-string body... |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
666 This macro executes the @var{body} forms with standard-output set up so |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
667 that all output feeds into a string. Then it returns that string. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
668 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
669 For example, if the current buffer name is @samp{foo}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
670 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
671 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
672 (with-output-to-string |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
673 (princ "The buffer is ") |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
674 (princ (buffer-name))) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
675 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
676 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
677 @noindent |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
678 returns @code{"The buffer is foo"}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
679 @end defmac |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
680 |
6381 | 681 @node Output Variables |
682 @section Variables Affecting Output | |
683 | |
684 @defvar standard-output | |
685 The value of this variable is the default output stream---the stream | |
686 that print functions use when the @var{stream} argument is @code{nil}. | |
687 @end defvar | |
688 | |
689 @defvar print-escape-newlines | |
690 @cindex @samp{\n} in print | |
691 @cindex escape characters | |
692 If this variable is non-@code{nil}, then newline characters in strings | |
693 are printed as @samp{\n} and formfeeds are printed as @samp{\f}. | |
694 Normally these characters are printed as actual newlines and formfeeds. | |
695 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
696 This variable affects the print functions @code{prin1} and @code{print} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
697 that print with quoting. It does not affect @code{princ}. Here is an |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
698 example using @code{prin1}: |
6381 | 699 |
700 @example | |
701 @group | |
702 (prin1 "a\nb") | |
703 @print{} "a | |
704 @print{} b" | |
705 @result{} "a | |
706 b" | |
707 @end group | |
708 | |
709 @group | |
710 (let ((print-escape-newlines t)) | |
711 (prin1 "a\nb")) | |
712 @print{} "a\nb" | |
713 @result{} "a | |
714 b" | |
715 @end group | |
716 @end example | |
717 | |
718 @noindent | |
719 In the second expression, the local binding of | |
720 @code{print-escape-newlines} is in effect during the call to | |
721 @code{prin1}, but not during the printing of the result. | |
722 @end defvar | |
723 | |
724 @defvar print-length | |
725 @cindex printing limits | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
726 The value of this variable is the maximum number of elements to print in |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
727 any list, vector or bool-vector. If an object being printed has more |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15800
diff
changeset
|
728 than this many elements, it is abbreviated with an ellipsis. |
6381 | 729 |
730 If the value is @code{nil} (the default), then there is no limit. | |
731 | |
732 @example | |
733 @group | |
734 (setq print-length 2) | |
735 @result{} 2 | |
736 @end group | |
737 @group | |
738 (print '(1 2 3 4 5)) | |
739 @print{} (1 2 ...) | |
740 @result{} (1 2 ...) | |
741 @end group | |
742 @end example | |
743 @end defvar | |
744 | |
745 @defvar print-level | |
746 The value of this variable is the maximum depth of nesting of | |
7219 | 747 parentheses and brackets when printed. Any list or vector at a depth |
6381 | 748 exceeding this limit is abbreviated with an ellipsis. A value of |
749 @code{nil} (which is the default) means no limit. | |
750 @end defvar |