Mercurial > emacs
annotate lispref/streams.texi @ 18429:8326843eefd9
(widget-edit-hook): New variable.
(widget-field-action, widget-choice-action): Run that hook
instead of displaying an echo area message.
(widget-toggle-action): Likewise.
(group-visibility, widget-group-visibility-create):
Moved to cus-edit.el and renamed.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 24 Jun 1997 03:17:34 +0000 |
parents | 18c0e05d1bff |
children | 66d807bdc5b4 |
rev | line source |
---|---|
6381 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc. | |
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 | |
41 object---converting the object to its printed representation. Printing | |
42 the cons cell described above produces the text @samp{(a .@: 5)}. | |
43 | |
44 Reading and printing are more or less inverse operations: printing the | |
45 object that results from reading a given piece of text often produces | |
46 the same text, and reading the text that results from printing an object | |
47 usually produces a similar-looking object. For example, printing the | |
48 symbol @code{foo} produces the text @samp{foo}, and reading that text | |
49 returns the symbol @code{foo}. Printing a list whose elements are | |
50 @code{a} and @code{b} produces the text @samp{(a b)}, and reading that | |
7219 | 51 text produces a list (but not the same list) with elements @code{a} |
6381 | 52 and @code{b}. |
53 | |
54 However, these two operations are not precisely inverses. There are | |
12098 | 55 three kinds of exceptions: |
6381 | 56 |
57 @itemize @bullet | |
58 @item | |
59 Printing can produce text that cannot be read. For example, buffers, | |
60 windows, frames, subprocesses and markers print into text that starts | |
61 with @samp{#}; if you try to read this text, you get an error. There is | |
62 no way to read those data types. | |
63 | |
64 @item | |
65 One object can have multiple textual representations. For example, | |
66 @samp{1} and @samp{01} represent the same integer, and @samp{(a b)} and | |
67 @samp{(a .@: (b))} represent the same list. Reading will accept any of | |
68 the alternatives, but printing must choose one of them. | |
12098 | 69 |
70 @item | |
71 Comments can appear at certain points in the middle of an object's | |
72 read sequence without affecting the result of reading it. | |
6381 | 73 @end itemize |
74 | |
75 @node Input Streams | |
76 @section Input Streams | |
77 @cindex stream (for reading) | |
78 @cindex input stream | |
79 | |
80 Most of the Lisp functions for reading text take an @dfn{input stream} | |
81 as an argument. The input stream specifies where or how to get the | |
82 characters of the text to be read. Here are the possible types of input | |
83 stream: | |
84 | |
85 @table @asis | |
86 @item @var{buffer} | |
87 @cindex buffer input stream | |
88 The input characters are read from @var{buffer}, starting with the | |
89 character directly after point. Point advances as characters are read. | |
90 | |
91 @item @var{marker} | |
92 @cindex marker input stream | |
93 The input characters are read from the buffer that @var{marker} is in, | |
94 starting with the character directly after the marker. The marker | |
95 position advances as characters are read. The value of point in the | |
96 buffer has no effect when the stream is a marker. | |
97 | |
98 @item @var{string} | |
99 @cindex string input stream | |
100 The input characters are taken from @var{string}, starting at the first | |
101 character in the string and using as many characters as required. | |
102 | |
103 @item @var{function} | |
104 @cindex function input stream | |
105 The input characters are generated by @var{function}, one character per | |
106 call. Normally @var{function} is called with no arguments, and should | |
107 return a character. | |
108 | |
109 @cindex unreading | |
110 Occasionally @var{function} is called with one argument (always a | |
111 character). When that happens, @var{function} should save the argument | |
112 and arrange to return it on the next call. This is called | |
113 @dfn{unreading} the character; it happens when the Lisp reader reads one | |
114 character too many and wants to ``put it back where it came from''. | |
115 | |
116 @item @code{t} | |
117 @cindex @code{t} input stream | |
118 @code{t} used as a stream means that the input is read from the | |
119 minibuffer. In fact, the minibuffer is invoked once and the text | |
120 given by the user is made into a string that is then used as the | |
121 input stream. | |
122 | |
123 @item @code{nil} | |
124 @cindex @code{nil} input stream | |
125 @code{nil} supplied as an input stream means to use the value of | |
126 @code{standard-input} instead; that value is the @dfn{default input | |
127 stream}, and must be a non-@code{nil} input stream. | |
128 | |
129 @item @var{symbol} | |
130 A symbol as input stream is equivalent to the symbol's function | |
131 definition (if any). | |
132 @end table | |
133 | |
7219 | 134 Here is an example of reading from a stream that is a buffer, showing |
6381 | 135 where point is located before and after: |
136 | |
137 @example | |
138 @group | |
139 ---------- Buffer: foo ---------- | |
140 This@point{} is the contents of foo. | |
141 ---------- Buffer: foo ---------- | |
142 @end group | |
143 | |
144 @group | |
145 (read (get-buffer "foo")) | |
146 @result{} is | |
147 @end group | |
148 @group | |
149 (read (get-buffer "foo")) | |
150 @result{} the | |
151 @end group | |
152 | |
153 @group | |
154 ---------- Buffer: foo ---------- | |
155 This is the@point{} contents of foo. | |
156 ---------- Buffer: foo ---------- | |
157 @end group | |
158 @end example | |
159 | |
160 @noindent | |
7219 | 161 Note that the first read skips a space. Reading skips any amount of |
162 whitespace preceding the significant text. | |
6381 | 163 |
164 In Emacs 18, reading a symbol discarded the delimiter terminating the | |
165 symbol. Thus, point would end up at the beginning of @samp{contents} | |
166 rather than after @samp{the}. The Emacs 19 behavior is superior because | |
12098 | 167 it correctly handles input such as @samp{bar(foo)}, where the |
168 open-parenthesis that ends one object is needed as the beginning of | |
169 another object. | |
6381 | 170 |
171 Here is an example of reading from a stream that is a marker, | |
7219 | 172 initially positioned at the beginning of the buffer shown. The value |
6381 | 173 read is the symbol @code{This}. |
174 | |
175 @example | |
176 @group | |
177 | |
178 ---------- Buffer: foo ---------- | |
179 This is the contents of foo. | |
180 ---------- Buffer: foo ---------- | |
181 @end group | |
182 | |
183 @group | |
184 (setq m (set-marker (make-marker) 1 (get-buffer "foo"))) | |
185 @result{} #<marker at 1 in foo> | |
186 @end group | |
187 @group | |
188 (read m) | |
189 @result{} This | |
190 @end group | |
191 @group | |
192 m | |
7219 | 193 @result{} #<marker at 5 in foo> ;; @r{Before the first space.} |
6381 | 194 @end group |
195 @end example | |
196 | |
197 Here we read from the contents of a string: | |
198 | |
199 @example | |
200 @group | |
201 (read "(When in) the course") | |
202 @result{} (When in) | |
203 @end group | |
204 @end example | |
205 | |
206 The following example reads from the minibuffer. The | |
207 prompt is: @w{@samp{Lisp expression: }}. (That is always the prompt | |
208 used when you read from the stream @code{t}.) The user's input is shown | |
209 following the prompt. | |
210 | |
211 @example | |
212 @group | |
213 (read t) | |
214 @result{} 23 | |
215 ---------- Buffer: Minibuffer ---------- | |
216 Lisp expression: @kbd{23 @key{RET}} | |
217 ---------- Buffer: Minibuffer ---------- | |
218 @end group | |
219 @end example | |
220 | |
221 Finally, here is an example of a stream that is a function, named | |
222 @code{useless-stream}. Before we use the stream, we initialize the | |
223 variable @code{useless-list} to a list of characters. Then each call to | |
7219 | 224 the function @code{useless-stream} obtains the next character in the list |
6381 | 225 or unreads a character by adding it to the front of the list. |
226 | |
227 @example | |
228 @group | |
229 (setq useless-list (append "XY()" nil)) | |
230 @result{} (88 89 40 41) | |
231 @end group | |
232 | |
233 @group | |
234 (defun useless-stream (&optional unread) | |
235 (if unread | |
236 (setq useless-list (cons unread useless-list)) | |
237 (prog1 (car useless-list) | |
238 (setq useless-list (cdr useless-list))))) | |
239 @result{} useless-stream | |
240 @end group | |
241 @end example | |
242 | |
243 @noindent | |
244 Now we read using the stream thus constructed: | |
245 | |
246 @example | |
247 @group | |
248 (read 'useless-stream) | |
249 @result{} XY | |
250 @end group | |
251 | |
252 @group | |
253 useless-list | |
7219 | 254 @result{} (40 41) |
6381 | 255 @end group |
256 @end example | |
257 | |
258 @noindent | |
7219 | 259 Note that the open and close parentheses remains in the list. The Lisp |
260 reader encountered the open parenthesis, decided that it ended the | |
261 input, and unread it. Another attempt to read from the stream at this | |
262 point would read @samp{()} and return @code{nil}. | |
6381 | 263 |
264 @defun get-file-char | |
265 This function is used internally as an input stream to read from the | |
266 input file opened by the function @code{load}. Don't use this function | |
267 yourself. | |
268 @end defun | |
269 | |
270 @node Input Functions | |
271 @section Input Functions | |
272 | |
273 This section describes the Lisp functions and variables that pertain | |
274 to reading. | |
275 | |
276 In the functions below, @var{stream} stands for an input stream (see | |
277 the previous section). If @var{stream} is @code{nil} or omitted, it | |
278 defaults to the value of @code{standard-input}. | |
279 | |
280 @kindex end-of-file | |
281 An @code{end-of-file} error is signaled if reading encounters an | |
7219 | 282 unterminated list, vector, or string. |
6381 | 283 |
284 @defun read &optional stream | |
285 This function reads one textual Lisp expression from @var{stream}, | |
286 returning it as a Lisp object. This is the basic Lisp input function. | |
287 @end defun | |
288 | |
289 @defun read-from-string string &optional start end | |
290 @cindex string to object | |
291 This function reads the first textual Lisp expression from the text in | |
292 @var{string}. It returns a cons cell whose @sc{car} is that expression, | |
293 and whose @sc{cdr} is an integer giving the position of the next | |
294 remaining character in the string (i.e., the first one not read). | |
295 | |
7219 | 296 If @var{start} is supplied, then reading begins at index @var{start} in |
297 the string (where the first character is at index 0). If @var{end} is | |
298 also supplied, then reading stops just before that index, as if the rest | |
299 of the string were not there. | |
6381 | 300 |
301 For example: | |
302 | |
303 @example | |
304 @group | |
305 (read-from-string "(setq x 55) (setq y 5)") | |
306 @result{} ((setq x 55) . 11) | |
307 @end group | |
308 @group | |
309 (read-from-string "\"A short string\"") | |
310 @result{} ("A short string" . 16) | |
311 @end group | |
312 | |
313 @group | |
314 ;; @r{Read starting at the first character.} | |
315 (read-from-string "(list 112)" 0) | |
316 @result{} ((list 112) . 10) | |
317 @end group | |
318 @group | |
319 ;; @r{Read starting at the second character.} | |
320 (read-from-string "(list 112)" 1) | |
7219 | 321 @result{} (list . 5) |
6381 | 322 @end group |
323 @group | |
324 ;; @r{Read starting at the seventh character,} | |
325 ;; @r{and stopping at the ninth.} | |
326 (read-from-string "(list 112)" 6 8) | |
327 @result{} (11 . 8) | |
328 @end group | |
329 @end example | |
330 @end defun | |
331 | |
332 @defvar standard-input | |
333 This variable holds the default input stream---the stream that | |
334 @code{read} uses when the @var{stream} argument is @code{nil}. | |
335 @end defvar | |
336 | |
337 @node Output Streams | |
338 @section Output Streams | |
339 @cindex stream (for printing) | |
340 @cindex output stream | |
341 | |
342 An output stream specifies what to do with the characters produced | |
343 by printing. Most print functions accept an output stream as an | |
344 optional argument. Here are the possible types of output stream: | |
345 | |
346 @table @asis | |
347 @item @var{buffer} | |
348 @cindex buffer output stream | |
349 The output characters are inserted into @var{buffer} at point. | |
350 Point advances as characters are inserted. | |
351 | |
352 @item @var{marker} | |
353 @cindex marker output stream | |
354 The output characters are inserted into the buffer that @var{marker} | |
7219 | 355 points into, at the marker position. The marker position advances as |
6381 | 356 characters are inserted. The value of point in the buffer has no effect |
357 on printing when the stream is a marker. | |
358 | |
359 @item @var{function} | |
360 @cindex function output stream | |
361 The output characters are passed to @var{function}, which is responsible | |
362 for storing them away. It is called with a single character as | |
363 argument, as many times as there are characters to be output, and is | |
364 free to do anything at all with the characters it receives. | |
365 | |
366 @item @code{t} | |
367 @cindex @code{t} output stream | |
368 The output characters are displayed in the echo area. | |
369 | |
370 @item @code{nil} | |
371 @cindex @code{nil} output stream | |
372 @code{nil} specified as an output stream means to the value of | |
373 @code{standard-output} instead; that value is the @dfn{default output | |
374 stream}, and must be a non-@code{nil} output stream. | |
375 | |
376 @item @var{symbol} | |
377 A symbol as output stream is equivalent to the symbol's function | |
378 definition (if any). | |
379 @end table | |
380 | |
7219 | 381 Many of the valid output streams are also valid as input streams. The |
382 difference between input and output streams is therefore mostly one of | |
383 how you use a Lisp object, not a distinction of types of object. | |
384 | |
6381 | 385 Here is an example of a buffer used as an output stream. Point is |
386 initially located as shown immediately before the @samp{h} in | |
387 @samp{the}. At the end, point is located directly before that same | |
388 @samp{h}. | |
389 | |
390 @cindex print example | |
391 @example | |
392 @group | |
15800
18c0e05d1bff
Make examples in Output Streams stand on their own.
Richard M. Stallman <rms@gnu.org>
parents:
15763
diff
changeset
|
393 (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
|
394 @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
|
395 @end group |
18c0e05d1bff
Make examples in Output Streams stand on their own.
Richard M. Stallman <rms@gnu.org>
parents:
15763
diff
changeset
|
396 |
18c0e05d1bff
Make examples in Output Streams stand on their own.
Richard M. Stallman <rms@gnu.org>
parents:
15763
diff
changeset
|
397 @group |
6381 | 398 ---------- Buffer: foo ---------- |
399 This is t@point{}he contents of foo. | |
400 ---------- Buffer: foo ---------- | |
401 @end group | |
402 | |
403 (print "This is the output" (get-buffer "foo")) | |
404 @result{} "This is the output" | |
405 | |
406 @group | |
15800
18c0e05d1bff
Make examples in Output Streams stand on their own.
Richard M. Stallman <rms@gnu.org>
parents:
15763
diff
changeset
|
407 m |
18c0e05d1bff
Make examples in Output Streams stand on their own.
Richard M. Stallman <rms@gnu.org>
parents:
15763
diff
changeset
|
408 @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
|
409 @end group |
18c0e05d1bff
Make examples in Output Streams stand on their own.
Richard M. Stallman <rms@gnu.org>
parents:
15763
diff
changeset
|
410 @group |
6381 | 411 ---------- Buffer: foo ---------- |
412 This is t | |
413 "This is the output" | |
414 @point{}he contents of foo. | |
415 ---------- Buffer: foo ---------- | |
416 @end group | |
417 @end example | |
418 | |
419 Now we show a use of a marker as an output stream. Initially, the | |
7219 | 420 marker is in buffer @code{foo}, between the @samp{t} and the @samp{h} in |
421 the word @samp{the}. At the end, the marker has advanced over the | |
422 inserted text so that it remains positioned before the same @samp{h}. | |
423 Note that the location of point, shown in the usual fashion, has no | |
424 effect. | |
6381 | 425 |
426 @example | |
427 @group | |
428 ---------- Buffer: foo ---------- | |
429 "This is the @point{}output" | |
430 ---------- Buffer: foo ---------- | |
431 @end group | |
432 | |
433 @group | |
434 m | |
435 @result{} #<marker at 11 in foo> | |
436 @end group | |
437 | |
438 @group | |
439 (print "More output for foo." m) | |
440 @result{} "More output for foo." | |
441 @end group | |
442 | |
443 @group | |
444 ---------- Buffer: foo ---------- | |
445 "This is t | |
446 "More output for foo." | |
447 he @point{}output" | |
448 ---------- Buffer: foo ---------- | |
449 @end group | |
450 | |
451 @group | |
452 m | |
453 @result{} #<marker at 35 in foo> | |
454 @end group | |
455 @end example | |
456 | |
457 The following example shows output to the echo area: | |
458 | |
459 @example | |
460 @group | |
461 (print "Echo Area output" t) | |
462 @result{} "Echo Area output" | |
463 ---------- Echo Area ---------- | |
464 "Echo Area output" | |
465 ---------- Echo Area ---------- | |
466 @end group | |
467 @end example | |
468 | |
469 Finally, we show the use of a function as an output stream. The | |
470 function @code{eat-output} takes each character that it is given and | |
471 conses it onto the front of the list @code{last-output} (@pxref{Building | |
472 Lists}). At the end, the list contains all the characters output, but | |
473 in reverse order. | |
474 | |
475 @example | |
476 @group | |
477 (setq last-output nil) | |
478 @result{} nil | |
479 @end group | |
480 | |
481 @group | |
482 (defun eat-output (c) | |
483 (setq last-output (cons c last-output))) | |
484 @result{} eat-output | |
485 @end group | |
486 | |
487 @group | |
488 (print "This is the output" 'eat-output) | |
489 @result{} "This is the output" | |
490 @end group | |
491 | |
492 @group | |
493 last-output | |
494 @result{} (10 34 116 117 112 116 117 111 32 101 104 | |
495 116 32 115 105 32 115 105 104 84 34 10) | |
496 @end group | |
497 @end example | |
498 | |
499 @noindent | |
500 Now we can put the output in the proper order by reversing the list: | |
501 | |
502 @example | |
503 @group | |
504 (concat (nreverse last-output)) | |
505 @result{} " | |
506 \"This is the output\" | |
507 " | |
508 @end group | |
509 @end example | |
510 | |
7219 | 511 @noindent |
512 Calling @code{concat} converts the list to a string so you can see its | |
513 contents more clearly. | |
514 | |
6381 | 515 @node Output Functions |
516 @section Output Functions | |
517 | |
518 This section describes the Lisp functions for printing Lisp objects. | |
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 |
532 If the text is to be read back into Lisp, then it is best to print | |
533 with quoting characters to avoid ambiguity. Likewise, if the purpose is | |
534 to describe a Lisp object clearly for a Lisp programmer. However, if | |
535 the purpose of the output is to look nice for humans, then it is better | |
536 to print without quoting. | |
537 | |
538 Printing a self-referent Lisp object requires an infinite amount of | |
539 text. In certain cases, trying to produce this text leads to a stack | |
540 overflow. Emacs detects such recursion and prints @samp{#@var{level}} | |
541 instead of recursively printing an object already being printed. For | |
542 example, here @samp{#0} indicates a recursive reference to the object at | |
543 level 0 of the current print operation: | |
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 | |
664 @node Output Variables | |
665 @section Variables Affecting Output | |
666 | |
667 @defvar standard-output | |
668 The value of this variable is the default output stream---the stream | |
669 that print functions use when the @var{stream} argument is @code{nil}. | |
670 @end defvar | |
671 | |
672 @defvar print-escape-newlines | |
673 @cindex @samp{\n} in print | |
674 @cindex escape characters | |
675 If this variable is non-@code{nil}, then newline characters in strings | |
676 are printed as @samp{\n} and formfeeds are printed as @samp{\f}. | |
677 Normally these characters are printed as actual newlines and formfeeds. | |
678 | |
679 This variable affects the print functions @code{prin1} and @code{print}, | |
680 as well as everything that uses them. It does not affect @code{princ}. | |
681 Here is an example using @code{prin1}: | |
682 | |
683 @example | |
684 @group | |
685 (prin1 "a\nb") | |
686 @print{} "a | |
687 @print{} b" | |
688 @result{} "a | |
689 b" | |
690 @end group | |
691 | |
692 @group | |
693 (let ((print-escape-newlines t)) | |
694 (prin1 "a\nb")) | |
695 @print{} "a\nb" | |
696 @result{} "a | |
697 b" | |
698 @end group | |
699 @end example | |
700 | |
701 @noindent | |
702 In the second expression, the local binding of | |
703 @code{print-escape-newlines} is in effect during the call to | |
704 @code{prin1}, but not during the printing of the result. | |
705 @end defvar | |
706 | |
707 @defvar print-length | |
708 @cindex printing limits | |
15763
4263612ea038
print-length applies to vectors.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
709 The value of this variable is the maximum number of elements of a list, |
4263612ea038
print-length applies to vectors.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
710 vector or bitvector that will be printed. If an object being printed has |
4263612ea038
print-length applies to vectors.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
711 more than this many elements, it is abbreviated with an ellipsis. |
6381 | 712 |
713 If the value is @code{nil} (the default), then there is no limit. | |
714 | |
715 @example | |
716 @group | |
717 (setq print-length 2) | |
718 @result{} 2 | |
719 @end group | |
720 @group | |
721 (print '(1 2 3 4 5)) | |
722 @print{} (1 2 ...) | |
723 @result{} (1 2 ...) | |
724 @end group | |
725 @end example | |
726 @end defvar | |
727 | |
728 @defvar print-level | |
729 The value of this variable is the maximum depth of nesting of | |
7219 | 730 parentheses and brackets when printed. Any list or vector at a depth |
6381 | 731 exceeding this limit is abbreviated with an ellipsis. A value of |
732 @code{nil} (which is the default) means no limit. | |
733 | |
734 This variable exists in version 19 and later versions. | |
735 @end defvar |