6381
|
1 @c -*-texinfo-*-
|
|
2 @c This is part of the GNU Emacs Lisp Reference Manual.
|
21007
|
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
|
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
|
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
|
41 object---converting the object to its @dfn{printed representation}
|
|
42 (@pxref{Printed Representation}). Printing the cons cell described
|
|
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
|
25875
|
55 However, these two operations are not precisely inverse to each other.
|
|
56 There are three kinds of exceptions:
|
6381
|
57
|
|
58 @itemize @bullet
|
|
59 @item
|
|
60 Printing can produce text that cannot be read. For example, buffers,
|
21007
|
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
|
106 The input characters are generated by @var{function}, which must support
|
|
107 two kinds of calls:
|
|
108
|
|
109 @itemize @bullet
|
|
110 @item
|
|
111 When it is called with no arguments, it should return the next character.
|
6381
|
112
|
21682
|
113 @item
|
|
114 When it is called with one argument (always a character), @var{function}
|
|
115 should save the argument and arrange to return it on the next call.
|
|
116 This is called @dfn{unreading} the character; it happens when the Lisp
|
|
117 reader reads one character too many and wants to ``put it back where it
|
|
118 came from''. In this case, it makes no difference what value
|
|
119 @var{function} returns.
|
|
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
|
22138
|
258 Note that the open and close parentheses remain in the list. The Lisp
|
7219
|
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
|
296 the string (where the first character is at index 0). If you specify
|
|
297 @var{end}, then reading is forced to stop just before that index, as if
|
|
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
|
22138
|
356 on printing when the stream is a marker, and this kind of printing
|
|
357 does not move point.
|
6381
|
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
|
22138
|
363 argument, as many times as there are characters to be output, and
|
|
364 is responsible for storing the characters wherever you want to put them.
|
6381
|
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
|
22138
|
372 @code{nil} specified as an output stream means to use the value of
|
6381
|
373 @code{standard-output} instead; that value is the @dfn{default output
|
22138
|
374 stream}, and must not be @code{nil}.
|
6381
|
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
|
21682
|
382 difference between input and output streams is therefore more a matter
|
|
383 of how you use a Lisp object, than of different types of object.
|
7219
|
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
|
|
393 ---------- Buffer: foo ----------
|
|
394 This is t@point{}he contents of foo.
|
|
395 ---------- Buffer: foo ----------
|
|
396 @end group
|
|
397
|
|
398 (print "This is the output" (get-buffer "foo"))
|
|
399 @result{} "This is the output"
|
|
400
|
|
401 @group
|
|
402 ---------- Buffer: foo ----------
|
|
403 This is t
|
|
404 "This is the output"
|
|
405 @point{}he contents of foo.
|
|
406 ---------- Buffer: foo ----------
|
|
407 @end group
|
|
408 @end example
|
|
409
|
|
410 Now we show a use of a marker as an output stream. Initially, the
|
7219
|
411 marker is in buffer @code{foo}, between the @samp{t} and the @samp{h} in
|
|
412 the word @samp{the}. At the end, the marker has advanced over the
|
|
413 inserted text so that it remains positioned before the same @samp{h}.
|
|
414 Note that the location of point, shown in the usual fashion, has no
|
|
415 effect.
|
6381
|
416
|
|
417 @example
|
|
418 @group
|
|
419 ---------- Buffer: foo ----------
|
22138
|
420 This is the @point{}output
|
6381
|
421 ---------- Buffer: foo ----------
|
|
422 @end group
|
|
423
|
|
424 @group
|
22252
|
425 (setq m (copy-marker 10))
|
|
426 @result{} #<marker at 10 in foo>
|
6381
|
427 @end group
|
|
428
|
|
429 @group
|
|
430 (print "More output for foo." m)
|
|
431 @result{} "More output for foo."
|
|
432 @end group
|
|
433
|
|
434 @group
|
|
435 ---------- Buffer: foo ----------
|
22138
|
436 This is t
|
6381
|
437 "More output for foo."
|
22138
|
438 he @point{}output
|
6381
|
439 ---------- Buffer: foo ----------
|
|
440 @end group
|
|
441
|
|
442 @group
|
|
443 m
|
22252
|
444 @result{} #<marker at 34 in foo>
|
6381
|
445 @end group
|
|
446 @end example
|
|
447
|
|
448 The following example shows output to the echo area:
|
|
449
|
|
450 @example
|
|
451 @group
|
|
452 (print "Echo Area output" t)
|
|
453 @result{} "Echo Area output"
|
|
454 ---------- Echo Area ----------
|
|
455 "Echo Area output"
|
|
456 ---------- Echo Area ----------
|
|
457 @end group
|
|
458 @end example
|
|
459
|
|
460 Finally, we show the use of a function as an output stream. The
|
|
461 function @code{eat-output} takes each character that it is given and
|
|
462 conses it onto the front of the list @code{last-output} (@pxref{Building
|
|
463 Lists}). At the end, the list contains all the characters output, but
|
|
464 in reverse order.
|
|
465
|
|
466 @example
|
|
467 @group
|
|
468 (setq last-output nil)
|
|
469 @result{} nil
|
|
470 @end group
|
|
471
|
|
472 @group
|
|
473 (defun eat-output (c)
|
|
474 (setq last-output (cons c last-output)))
|
|
475 @result{} eat-output
|
|
476 @end group
|
|
477
|
|
478 @group
|
|
479 (print "This is the output" 'eat-output)
|
|
480 @result{} "This is the output"
|
|
481 @end group
|
|
482
|
|
483 @group
|
|
484 last-output
|
|
485 @result{} (10 34 116 117 112 116 117 111 32 101 104
|
|
486 116 32 115 105 32 115 105 104 84 34 10)
|
|
487 @end group
|
|
488 @end example
|
|
489
|
|
490 @noindent
|
|
491 Now we can put the output in the proper order by reversing the list:
|
|
492
|
|
493 @example
|
|
494 @group
|
|
495 (concat (nreverse last-output))
|
|
496 @result{} "
|
|
497 \"This is the output\"
|
|
498 "
|
|
499 @end group
|
|
500 @end example
|
|
501
|
7219
|
502 @noindent
|
|
503 Calling @code{concat} converts the list to a string so you can see its
|
|
504 contents more clearly.
|
|
505
|
6381
|
506 @node Output Functions
|
|
507 @section Output Functions
|
|
508
|
21007
|
509 This section describes the Lisp functions for printing Lisp
|
|
510 objects---converting objects into their printed representation.
|
6381
|
511
|
|
512 @cindex @samp{"} in printing
|
|
513 @cindex @samp{\} in printing
|
|
514 @cindex quoting characters in printing
|
|
515 @cindex escape characters in printing
|
|
516 Some of the Emacs printing functions add quoting characters to the
|
|
517 output when necessary so that it can be read properly. The quoting
|
|
518 characters used are @samp{"} and @samp{\}; they distinguish strings from
|
|
519 symbols, and prevent punctuation characters in strings and symbols from
|
7219
|
520 being taken as delimiters when reading. @xref{Printed Representation},
|
|
521 for full details. You specify quoting or no quoting by the choice of
|
|
522 printing function.
|
6381
|
523
|
21682
|
524 If the text is to be read back into Lisp, then you should print with
|
|
525 quoting characters to avoid ambiguity. Likewise, if the purpose is to
|
|
526 describe a Lisp object clearly for a Lisp programmer. However, if the
|
|
527 purpose of the output is to look nice for humans, then it is usually
|
|
528 better to print without quoting.
|
6381
|
529
|
22138
|
530 Lisp objects can refer to themselves. Printing a self-referential
|
|
531 object in the normal way would require an infinite amount of text, and
|
|
532 the attempt could cause infinite recursion. Emacs detects such
|
|
533 recursion and prints @samp{#@var{level}} instead of recursively printing
|
|
534 an object already being printed. For example, here @samp{#0} indicates
|
|
535 a recursive reference to the object at level 0 of the current print
|
|
536 operation:
|
6381
|
537
|
|
538 @example
|
|
539 (setq foo (list nil))
|
|
540 @result{} (nil)
|
|
541 (setcar foo foo)
|
|
542 @result{} (#0)
|
|
543 @end example
|
|
544
|
|
545 In the functions below, @var{stream} stands for an output stream.
|
|
546 (See the previous section for a description of output streams.) If
|
|
547 @var{stream} is @code{nil} or omitted, it defaults to the value of
|
|
548 @code{standard-output}.
|
|
549
|
|
550 @defun print object &optional stream
|
|
551 @cindex Lisp printer
|
|
552 The @code{print} function is a convenient way of printing. It outputs
|
|
553 the printed representation of @var{object} to @var{stream}, printing in
|
|
554 addition one newline before @var{object} and another after it. Quoting
|
|
555 characters are used. @code{print} returns @var{object}. For example:
|
|
556
|
|
557 @example
|
|
558 @group
|
|
559 (progn (print 'The\ cat\ in)
|
|
560 (print "the hat")
|
|
561 (print " came back"))
|
|
562 @print{}
|
|
563 @print{} The\ cat\ in
|
|
564 @print{}
|
|
565 @print{} "the hat"
|
|
566 @print{}
|
|
567 @print{} " came back"
|
|
568 @print{}
|
|
569 @result{} " came back"
|
|
570 @end group
|
|
571 @end example
|
|
572 @end defun
|
|
573
|
|
574 @defun prin1 object &optional stream
|
|
575 This function outputs the printed representation of @var{object} to
|
7219
|
576 @var{stream}. It does not print newlines to separate output as
|
|
577 @code{print} does, but it does use quoting characters just like
|
|
578 @code{print}. It returns @var{object}.
|
6381
|
579
|
|
580 @example
|
|
581 @group
|
|
582 (progn (prin1 'The\ cat\ in)
|
|
583 (prin1 "the hat")
|
|
584 (prin1 " came back"))
|
|
585 @print{} The\ cat\ in"the hat"" came back"
|
|
586 @result{} " came back"
|
|
587 @end group
|
|
588 @end example
|
|
589 @end defun
|
|
590
|
|
591 @defun princ object &optional stream
|
|
592 This function outputs the printed representation of @var{object} to
|
|
593 @var{stream}. It returns @var{object}.
|
|
594
|
|
595 This function is intended to produce output that is readable by people,
|
|
596 not by @code{read}, so it doesn't insert quoting characters and doesn't
|
|
597 put double-quotes around the contents of strings. It does not add any
|
|
598 spacing between calls.
|
|
599
|
|
600 @example
|
|
601 @group
|
|
602 (progn
|
|
603 (princ 'The\ cat)
|
|
604 (princ " in the \"hat\""))
|
|
605 @print{} The cat in the "hat"
|
|
606 @result{} " in the \"hat\""
|
|
607 @end group
|
|
608 @end example
|
|
609 @end defun
|
|
610
|
|
611 @defun terpri &optional stream
|
|
612 @cindex newline in print
|
|
613 This function outputs a newline to @var{stream}. The name stands
|
|
614 for ``terminate print''.
|
|
615 @end defun
|
|
616
|
|
617 @defun write-char character &optional stream
|
|
618 This function outputs @var{character} to @var{stream}. It returns
|
|
619 @var{character}.
|
|
620 @end defun
|
|
621
|
|
622 @defun prin1-to-string object &optional noescape
|
|
623 @cindex object to string
|
|
624 This function returns a string containing the text that @code{prin1}
|
|
625 would have printed for the same argument.
|
|
626
|
|
627 @example
|
|
628 @group
|
|
629 (prin1-to-string 'foo)
|
|
630 @result{} "foo"
|
|
631 @end group
|
|
632 @group
|
|
633 (prin1-to-string (mark-marker))
|
|
634 @result{} "#<marker at 2773 in strings.texi>"
|
|
635 @end group
|
|
636 @end example
|
|
637
|
|
638 If @var{noescape} is non-@code{nil}, that inhibits use of quoting
|
|
639 characters in the output. (This argument is supported in Emacs versions
|
|
640 19 and later.)
|
|
641
|
|
642 @example
|
|
643 @group
|
|
644 (prin1-to-string "foo")
|
|
645 @result{} "\"foo\""
|
|
646 @end group
|
|
647 @group
|
|
648 (prin1-to-string "foo" t)
|
|
649 @result{} "foo"
|
|
650 @end group
|
|
651 @end example
|
|
652
|
|
653 See @code{format}, in @ref{String Conversion}, for other ways to obtain
|
|
654 the printed representation of a Lisp object as a string.
|
|
655 @end defun
|
|
656
|
22138
|
657 @defmac with-output-to-string body...
|
21007
|
658 @tindex with-output-to-string
|
22138
|
659 This macro executes the @var{body} forms with @code{standard-output} set
|
|
660 up to feed output into a string. Then it returns that string.
|
21007
|
661
|
|
662 For example, if the current buffer name is @samp{foo},
|
|
663
|
|
664 @example
|
|
665 (with-output-to-string
|
|
666 (princ "The buffer is ")
|
|
667 (princ (buffer-name)))
|
|
668 @end example
|
|
669
|
|
670 @noindent
|
|
671 returns @code{"The buffer is foo"}.
|
|
672 @end defmac
|
|
673
|
6381
|
674 @node Output Variables
|
|
675 @section Variables Affecting Output
|
|
676
|
|
677 @defvar standard-output
|
|
678 The value of this variable is the default output stream---the stream
|
|
679 that print functions use when the @var{stream} argument is @code{nil}.
|
|
680 @end defvar
|
|
681
|
|
682 @defvar print-escape-newlines
|
|
683 @cindex @samp{\n} in print
|
|
684 @cindex escape characters
|
|
685 If this variable is non-@code{nil}, then newline characters in strings
|
|
686 are printed as @samp{\n} and formfeeds are printed as @samp{\f}.
|
|
687 Normally these characters are printed as actual newlines and formfeeds.
|
|
688
|
21682
|
689 This variable affects the print functions @code{prin1} and @code{print}
|
|
690 that print with quoting. It does not affect @code{princ}. Here is an
|
|
691 example using @code{prin1}:
|
6381
|
692
|
|
693 @example
|
|
694 @group
|
|
695 (prin1 "a\nb")
|
|
696 @print{} "a
|
|
697 @print{} b"
|
|
698 @result{} "a
|
|
699 b"
|
|
700 @end group
|
|
701
|
|
702 @group
|
|
703 (let ((print-escape-newlines t))
|
|
704 (prin1 "a\nb"))
|
|
705 @print{} "a\nb"
|
|
706 @result{} "a
|
|
707 b"
|
|
708 @end group
|
|
709 @end example
|
|
710
|
|
711 @noindent
|
|
712 In the second expression, the local binding of
|
|
713 @code{print-escape-newlines} is in effect during the call to
|
|
714 @code{prin1}, but not during the printing of the result.
|
|
715 @end defvar
|
|
716
|
22252
|
717 @tindex print-escape-nonascii
|
|
718 @defvar print-escape-nonascii
|
25751
|
719 If this variable is non-@code{nil}, then unibyte non-@sc{ascii}
|
22252
|
720 characters in strings are unconditionally printed as backslash sequences
|
|
721 by the print functions @code{prin1} and @code{print} that print with
|
|
722 quoting.
|
22829
|
723
|
25751
|
724 Those functions also use backslash sequences for unibyte non-@sc{ascii}
|
22829
|
725 characters, regardless of the value of this variable, when the output
|
|
726 stream is a multibyte buffer or a marker pointing into one.
|
|
727 @end defvar
|
|
728
|
|
729 @tindex print-escape-multibyte
|
|
730 @defvar print-escape-multibyte
|
25751
|
731 If this variable is non-@code{nil}, then multibyte non-@sc{ascii}
|
22829
|
732 characters in strings are unconditionally printed as backslash sequences
|
|
733 by the print functions @code{prin1} and @code{print} that print with
|
|
734 quoting.
|
|
735
|
|
736 Those functions also use backslash sequences for multibyte
|
25751
|
737 non-@sc{ascii} characters, regardless of the value of this variable,
|
22829
|
738 when the output stream is a unibyte buffer or a marker pointing into
|
|
739 one.
|
22252
|
740 @end defvar
|
|
741
|
6381
|
742 @defvar print-length
|
|
743 @cindex printing limits
|
21007
|
744 The value of this variable is the maximum number of elements to print in
|
|
745 any list, vector or bool-vector. If an object being printed has more
|
|
746 than this many elements, it is abbreviated with an ellipsis.
|
6381
|
747
|
|
748 If the value is @code{nil} (the default), then there is no limit.
|
|
749
|
|
750 @example
|
|
751 @group
|
|
752 (setq print-length 2)
|
|
753 @result{} 2
|
|
754 @end group
|
|
755 @group
|
|
756 (print '(1 2 3 4 5))
|
|
757 @print{} (1 2 ...)
|
|
758 @result{} (1 2 ...)
|
|
759 @end group
|
|
760 @end example
|
|
761 @end defvar
|
|
762
|
|
763 @defvar print-level
|
|
764 The value of this variable is the maximum depth of nesting of
|
7219
|
765 parentheses and brackets when printed. Any list or vector at a depth
|
6381
|
766 exceeding this limit is abbreviated with an ellipsis. A value of
|
|
767 @code{nil} (which is the default) means no limit.
|
|
768 @end defvar
|
25751
|
769
|
|
770 These variables are used for detecting and reporting circular
|
|
771 and shared structure---but they are only defined in Emacs 21.
|
|
772
|
|
773 @tindex print-circle
|
|
774 @defvar print-circle
|
|
775 If non-@code{nil}, this variable enables detection of circular
|
|
776 and shared structure in printing.
|
|
777 @end defvar
|
|
778
|
|
779 @tindex print-gensym
|
|
780 @defvar print-gensym
|
|
781 If non-@code{nil}, this variable enables detection of uninterned symbols
|
|
782 (@pxref{Creating Symbols}) in printing. When this is enabled,
|
|
783 uninterned symbols print with the prefix @samp{#:}, which tells the Lisp
|
|
784 reader to produce an uninterned symbol.
|
|
785 @end defvar
|