* net/soap-client.el:
[bpt/emacs.git] / src / print.c
CommitLineData
38010d50 1/* Lisp object printing and output streams.
95df8112
GM
2
3Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2011
4 Free Software Foundation, Inc.
38010d50
JB
5
6This file is part of GNU Emacs.
7
9ec0b715 8GNU Emacs is free software: you can redistribute it and/or modify
38010d50 9it under the terms of the GNU General Public License as published by
9ec0b715
GM
10the Free Software Foundation, either version 3 of the License, or
11(at your option) any later version.
38010d50
JB
12
13GNU Emacs is distributed in the hope that it will be useful,
14but WITHOUT ANY WARRANTY; without even the implied warranty of
15MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16GNU General Public License for more details.
17
18You should have received a copy of the GNU General Public License
9ec0b715 19along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
38010d50
JB
20
21
18160b98 22#include <config.h>
38010d50 23#include <stdio.h>
d7306fe6 24#include <setjmp.h>
38010d50 25#include "lisp.h"
38010d50 26#include "buffer.h"
8b4b4467 27#include "character.h"
71ea13cb 28#include "charset.h"
2538fae4 29#include "keyboard.h"
0137dbf7 30#include "frame.h"
38010d50
JB
31#include "window.h"
32#include "process.h"
33#include "dispextern.h"
34#include "termchar.h"
7651e1f5 35#include "intervals.h"
f9467be3 36#include "blockinput.h"
f76c8b1e 37#include "termhooks.h" /* For struct terminal. */
2a7b7982 38#include "font.h"
7651e1f5 39
29208e82 40Lisp_Object Qstandard_output;
38010d50 41
d9c21094
RS
42Lisp_Object Qtemp_buffer_setup_hook;
43
2f100b5c 44/* These are used to print like we read. */
2f100b5c 45
29208e82 46Lisp_Object Qfloat_output_format;
f356c3fb 47
f356c3fb
PE
48#include <math.h>
49
50#if STDC_HEADERS
51#include <float.h>
f356c3fb 52#endif
fa2c4f56 53#include <ftoastr.h>
f356c3fb
PE
54
55/* Default to values appropriate for IEEE floating point. */
f356c3fb
PE
56#ifndef DBL_DIG
57#define DBL_DIG 15
58#endif
f356c3fb 59
38010d50
JB
60/* Avoid actual stack overflow in print. */
61int print_depth;
62
a22dec27
SM
63/* Level of nesting inside outputting backquote in new style. */
64int new_backquote_output;
0330bb60 65
ec838c39
RS
66/* Detect most circularities to print finite output. */
67#define PRINT_CIRCLE 200
68Lisp_Object being_printed[PRINT_CIRCLE];
69
6fec5601
RS
70/* When printing into a buffer, first we put the text in this
71 block, then insert it all at once. */
72char *print_buffer;
73
74/* Size allocated in print_buffer. */
db063399 75EMACS_INT print_buffer_size;
dc2a0b79 76/* Chars stored in print_buffer. */
db063399 77EMACS_INT print_buffer_pos;
dc2a0b79 78/* Bytes stored in print_buffer. */
db063399 79EMACS_INT print_buffer_pos_byte;
6fec5601 80
835d0be6
RS
81Lisp_Object Qprint_escape_newlines;
82Lisp_Object Qprint_escape_multibyte, Qprint_escape_nonascii;
83
a65b85b5
SM
84/* Vprint_number_table is a table, that keeps objects that are going to
85 be printed, to allow use of #n= and #n# to express sharing.
86 For any given object, the table can give the following values:
87 t the object will be printed only once.
88 -N the object will be printed several times and will take number N.
89 N the object has been printed so we can refer to it as #N#.
90 print_number_index holds the largest N already used.
91 N has to be striclty larger than 0 since we need to distinguish -N. */
0f25ecc6 92int print_number_index;
971de7fb 93void print_interval (INTERVAL interval, Lisp_Object printcharfun);
38010d50 94
945b0111 95/* GDB resets this to zero on W32 to disable OutputDebugString calls. */
42c8bc9b 96int print_output_debug_flag EXTERNALLY_VISIBLE = 1;
945b0111 97
38010d50 98\f
eb8c3be9 99/* Low level output routines for characters and strings */
38010d50
JB
100
101/* Lisp functions to do output using a stream
081e0581
EN
102 must have the stream in a variable called printcharfun
103 and must start with PRINTPREPARE, end with PRINTFINISH,
104 and use PRINTDECLARE to declare common variables.
105 Use PRINTCHAR to output one character,
177c0ea7 106 or call strout to output a block of characters. */
0788646c
GM
107
108#define PRINTDECLARE \
109 struct buffer *old = current_buffer; \
db063399
LMI
110 EMACS_INT old_point = -1, start_point = -1; \
111 EMACS_INT old_point_byte = -1, start_point_byte = -1; \
aed13378 112 int specpdl_count = SPECPDL_INDEX (); \
0788646c 113 int free_print_buffer = 0; \
5d8ea120 114 int multibyte = !NILP (B_ (current_buffer, enable_multibyte_characters)); \
081e0581
EN
115 Lisp_Object original
116
0788646c
GM
117#define PRINTPREPARE \
118 original = printcharfun; \
119 if (NILP (printcharfun)) printcharfun = Qt; \
120 if (BUFFERP (printcharfun)) \
121 { \
122 if (XBUFFER (printcharfun) != current_buffer) \
123 Fset_buffer (printcharfun); \
124 printcharfun = Qnil; \
125 } \
126 if (MARKERP (printcharfun)) \
127 { \
1cf21850 128 EMACS_INT marker_pos; \
cd3587c1 129 if (! XMARKER (printcharfun)->buffer) \
0788646c 130 error ("Marker does not point anywhere"); \
1cf21850
LK
131 if (XMARKER (printcharfun)->buffer != current_buffer) \
132 set_buffer_internal (XMARKER (printcharfun)->buffer); \
133 marker_pos = marker_position (printcharfun); \
134 if (marker_pos < BEGV || marker_pos > ZV) \
135 error ("Marker is outside the accessible part of the buffer"); \
0788646c
GM
136 old_point = PT; \
137 old_point_byte = PT_BYTE; \
1cf21850 138 SET_PT_BOTH (marker_pos, \
0788646c
GM
139 marker_byte_position (printcharfun)); \
140 start_point = PT; \
141 start_point_byte = PT_BYTE; \
142 printcharfun = Qnil; \
143 } \
144 if (NILP (printcharfun)) \
145 { \
146 Lisp_Object string; \
5d8ea120 147 if (NILP (B_ (current_buffer, enable_multibyte_characters)) \
0788646c
GM
148 && ! print_escape_multibyte) \
149 specbind (Qprint_escape_multibyte, Qt); \
5d8ea120 150 if (! NILP (B_ (current_buffer, enable_multibyte_characters)) \
d39f07c2
RS
151 && ! print_escape_nonascii) \
152 specbind (Qprint_escape_nonascii, Qt); \
0788646c
GM
153 if (print_buffer != 0) \
154 { \
155 string = make_string_from_bytes (print_buffer, \
156 print_buffer_pos, \
157 print_buffer_pos_byte); \
158 record_unwind_protect (print_unwind, string); \
159 } \
160 else \
161 { \
162 print_buffer_size = 1000; \
163 print_buffer = (char *) xmalloc (print_buffer_size); \
164 free_print_buffer = 1; \
165 } \
166 print_buffer_pos = 0; \
167 print_buffer_pos_byte = 0; \
168 } \
5494b50f 169 if (EQ (printcharfun, Qt) && ! noninteractive) \
0f25ecc6 170 setup_echo_area_for_printing (multibyte);
38010d50 171
8a2ab0c6
RS
172#define PRINTFINISH \
173 if (NILP (printcharfun)) \
174 { \
175 if (print_buffer_pos != print_buffer_pos_byte \
5d8ea120 176 && NILP (B_ (current_buffer, enable_multibyte_characters))) \
8a2ab0c6
RS
177 { \
178 unsigned char *temp \
179 = (unsigned char *) alloca (print_buffer_pos + 1); \
09125ef8
PE
180 copy_text ((unsigned char *) print_buffer, temp, \
181 print_buffer_pos_byte, 1, 0); \
b68864e5 182 insert_1_both ((char *) temp, print_buffer_pos, \
8a2ab0c6
RS
183 print_buffer_pos, 0, 1, 0); \
184 } \
185 else \
186 insert_1_both (print_buffer, print_buffer_pos, \
187 print_buffer_pos_byte, 0, 1, 0); \
570fab6c 188 signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
8a2ab0c6
RS
189 } \
190 if (free_print_buffer) \
191 { \
192 xfree (print_buffer); \
193 print_buffer = 0; \
194 } \
195 unbind_to (specpdl_count, Qnil); \
196 if (MARKERP (original)) \
197 set_marker_both (original, Qnil, PT, PT_BYTE); \
198 if (old_point >= 0) \
199 SET_PT_BOTH (old_point + (old_point >= start_point \
200 ? PT - start_point : 0), \
6ddd6eee 201 old_point_byte + (old_point_byte >= start_point_byte \
cd3587c1 202 ? PT_BYTE - start_point_byte : 0)); \
8a2ab0c6 203 if (old != current_buffer) \
0f25ecc6 204 set_buffer_internal (old);
38010d50
JB
205
206#define PRINTCHAR(ch) printchar (ch, printcharfun)
207
08e8d297
RS
208/* This is used to restore the saved contents of print_buffer
209 when there is a recursive call to print. */
0788646c 210
08e8d297 211static Lisp_Object
971de7fb 212print_unwind (Lisp_Object saved_text)
08e8d297 213{
72af86bd 214 memcpy (print_buffer, SDATA (saved_text), SCHARS (saved_text));
ee5263af 215 return Qnil;
08e8d297
RS
216}
217
0788646c
GM
218
219/* Print character CH using method FUN. FUN nil means print to
220 print_buffer. FUN t means print to echo area or stdout if
221 non-interactive. If FUN is neither nil nor t, call FUN with CH as
222 argument. */
38010d50
JB
223
224static void
971de7fb 225printchar (unsigned int ch, Lisp_Object fun)
38010d50 226{
0788646c
GM
227 if (!NILP (fun) && !EQ (fun, Qt))
228 call1 (fun, make_number (ch));
229 else
38010d50 230 {
19a86a03
KH
231 unsigned char str[MAX_MULTIBYTE_LENGTH];
232 int len = CHAR_STRING (ch, str);
233
09eddb56 234 QUIT;
177c0ea7 235
0788646c 236 if (NILP (fun))
9a4d01d8 237 {
0788646c
GM
238 if (print_buffer_pos_byte + len >= print_buffer_size)
239 print_buffer = (char *) xrealloc (print_buffer,
240 print_buffer_size *= 2);
72af86bd 241 memcpy (print_buffer + print_buffer_pos_byte, str, len);
0788646c
GM
242 print_buffer_pos += 1;
243 print_buffer_pos_byte += len;
9a4d01d8 244 }
0788646c 245 else if (noninteractive)
1134b854 246 {
0788646c
GM
247 fwrite (str, 1, len, stdout);
248 noninteractive_need_newline = 1;
1134b854 249 }
0788646c 250 else
d366d2e4 251 {
0788646c 252 int multibyte_p
5d8ea120 253 = !NILP (B_ (current_buffer, enable_multibyte_characters));
177c0ea7 254
eb7b678b 255 setup_echo_area_for_printing (multibyte_p);
0788646c 256 insert_char (ch);
09125ef8 257 message_dolog ((char *) str, len, 0, multibyte_p);
d366d2e4 258 }
38010d50 259 }
38010d50
JB
260}
261
0788646c
GM
262
263/* Output SIZE characters, SIZE_BYTE bytes from string PTR using
264 method PRINTCHARFUN. If SIZE < 0, use the string length of PTR for
265 both SIZE and SIZE_BYTE. PRINTCHARFUN nil means output to
266 print_buffer. PRINTCHARFUN t means output to the echo area or to
267 stdout if non-interactive. If neither nil nor t, call Lisp
268 function PRINTCHARFUN for each character printed. MULTIBYTE
efb15f96
RS
269 non-zero means PTR contains multibyte characters.
270
271 In the case where PRINTCHARFUN is nil, it is safe for PTR to point
272 to data in a Lisp string. Otherwise that is not safe. */
0788646c 273
38010d50 274static void
db063399
LMI
275strout (const char *ptr, EMACS_INT size, EMACS_INT size_byte,
276 Lisp_Object printcharfun, int multibyte)
38010d50 277{
087e3c46 278 if (size < 0)
dc2a0b79 279 size_byte = size = strlen (ptr);
087e3c46 280
0788646c 281 if (NILP (printcharfun))
38010d50 282 {
dc2a0b79 283 if (print_buffer_pos_byte + size_byte > print_buffer_size)
6fec5601 284 {
dc2a0b79 285 print_buffer_size = print_buffer_size * 2 + size_byte;
6fec5601
RS
286 print_buffer = (char *) xrealloc (print_buffer,
287 print_buffer_size);
288 }
72af86bd 289 memcpy (print_buffer + print_buffer_pos_byte, ptr, size_byte);
6fec5601 290 print_buffer_pos += size;
dc2a0b79 291 print_buffer_pos_byte += size_byte;
38010d50 292 }
7b0cb8a0 293 else if (noninteractive && EQ (printcharfun, Qt))
38010d50 294 {
0788646c
GM
295 fwrite (ptr, 1, size_byte, stdout);
296 noninteractive_need_newline = 1;
297 }
298 else if (EQ (printcharfun, Qt))
299 {
300 /* Output to echo area. We're trying to avoid a little overhead
301 here, that's the reason we don't call printchar to do the
302 job. */
303 int i;
304 int multibyte_p
5d8ea120 305 = !NILP (B_ (current_buffer, enable_multibyte_characters));
177c0ea7 306
eb7b678b 307 setup_echo_area_for_printing (multibyte_p);
0788646c 308 message_dolog (ptr, size_byte, 0, multibyte_p);
177c0ea7 309
0788646c 310 if (size == size_byte)
38010d50 311 {
0788646c 312 for (i = 0; i < size; ++i)
bcdbfd36 313 insert_char ((unsigned char) *ptr++);
38010d50 314 }
0788646c 315 else
38010d50 316 {
0788646c
GM
317 int len;
318 for (i = 0; i < size_byte; i += len)
aec2b95b 319 {
09125ef8
PE
320 int ch = STRING_CHAR_AND_LENGTH ((const unsigned char *) ptr + i,
321 len);
0788646c 322 insert_char (ch);
aec2b95b 323 }
38010d50 324 }
0788646c
GM
325 }
326 else
327 {
328 /* PRINTCHARFUN is a Lisp function. */
da43f021 329 EMACS_INT i = 0;
38010d50 330
0788646c 331 if (size == size_byte)
4ad8bb20 332 {
0788646c 333 while (i < size_byte)
4ad8bb20 334 {
0788646c
GM
335 int ch = ptr[i++];
336 PRINTCHAR (ch);
4ad8bb20 337 }
4ad8bb20 338 }
0788646c 339 else
087e3c46 340 {
0788646c
GM
341 while (i < size_byte)
342 {
343 /* Here, we must convert each multi-byte form to the
344 corresponding character code before handing it to
345 PRINTCHAR. */
346 int len;
09125ef8
PE
347 int ch = STRING_CHAR_AND_LENGTH ((const unsigned char *) ptr + i,
348 len);
0788646c
GM
349 PRINTCHAR (ch);
350 i += len;
351 }
087e3c46 352 }
38010d50 353 }
38010d50
JB
354}
355
356/* Print the contents of a string STRING using PRINTCHARFUN.
ed2c35ef
RS
357 It isn't safe to use strout in many cases,
358 because printing one char can relocate. */
38010d50 359
dc2a0b79 360static void
971de7fb 361print_string (Lisp_Object string, Lisp_Object printcharfun)
38010d50 362{
6fec5601 363 if (EQ (printcharfun, Qt) || NILP (printcharfun))
375fcc09 364 {
db063399 365 EMACS_INT chars;
375fcc09 366
8b4b4467
KH
367 if (print_escape_nonascii)
368 string = string_escape_byte8 (string);
369
375fcc09 370 if (STRING_MULTIBYTE (string))
d5db4077 371 chars = SCHARS (string);
8b4b4467
KH
372 else if (! print_escape_nonascii
373 && (EQ (printcharfun, Qt)
5d8ea120
TT
374 ? ! NILP (B_ (&buffer_defaults, enable_multibyte_characters))
375 : ! NILP (B_ (current_buffer, enable_multibyte_characters))))
a76ef35d
KH
376 {
377 /* If unibyte string STRING contains 8-bit codes, we must
378 convert STRING to a multibyte string containing the same
379 character codes. */
380 Lisp_Object newstr;
db063399 381 EMACS_INT bytes;
a76ef35d 382
d5db4077
KR
383 chars = SBYTES (string);
384 bytes = parse_str_to_multibyte (SDATA (string), chars);
a76ef35d
KH
385 if (chars < bytes)
386 {
387 newstr = make_uninit_multibyte_string (chars, bytes);
72af86bd 388 memcpy (SDATA (newstr), SDATA (string), chars);
d5db4077 389 str_to_multibyte (SDATA (newstr), bytes, chars);
a76ef35d
KH
390 string = newstr;
391 }
392 }
375fcc09 393 else
d5db4077 394 chars = SBYTES (string);
375fcc09 395
efb15f96
RS
396 if (EQ (printcharfun, Qt))
397 {
398 /* Output to echo area. */
db063399 399 EMACS_INT nbytes = SBYTES (string);
efb15f96
RS
400 char *buffer;
401
402 /* Copy the string contents so that relocation of STRING by
403 GC does not cause trouble. */
404 USE_SAFE_ALLOCA;
405
406 SAFE_ALLOCA (buffer, char *, nbytes);
72af86bd 407 memcpy (buffer, SDATA (string), nbytes);
efb15f96
RS
408
409 strout (buffer, chars, SBYTES (string),
410 printcharfun, STRING_MULTIBYTE (string));
411
412 SAFE_FREE ();
413 }
414 else
415 /* No need to copy, since output to print_buffer can't GC. */
42a5b22f 416 strout (SSDATA (string),
efb15f96
RS
417 chars, SBYTES (string),
418 printcharfun, STRING_MULTIBYTE (string));
375fcc09 419 }
38010d50
JB
420 else
421 {
dc2a0b79
RS
422 /* Otherwise, string may be relocated by printing one char.
423 So re-fetch the string address for each character. */
da43f021 424 EMACS_INT i;
db063399
LMI
425 EMACS_INT size = SCHARS (string);
426 EMACS_INT size_byte = SBYTES (string);
38010d50
JB
427 struct gcpro gcpro1;
428 GCPRO1 (string);
dc2a0b79
RS
429 if (size == size_byte)
430 for (i = 0; i < size; i++)
d5db4077 431 PRINTCHAR (SREF (string, i));
dc2a0b79 432 else
6b61353c 433 for (i = 0; i < size_byte; )
dc2a0b79
RS
434 {
435 /* Here, we must convert each multi-byte form to the
436 corresponding character code before handing it to PRINTCHAR. */
437 int len;
62a6e103 438 int ch = STRING_CHAR_AND_LENGTH (SDATA (string) + i, len);
dc2a0b79
RS
439 PRINTCHAR (ch);
440 i += len;
441 }
38010d50
JB
442 UNGCPRO;
443 }
444}
445\f
446DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
8c1a1077
PJ
447 doc: /* Output character CHARACTER to stream PRINTCHARFUN.
448PRINTCHARFUN defaults to the value of `standard-output' (which see). */)
5842a27b 449 (Lisp_Object character, Lisp_Object printcharfun)
38010d50 450{
081e0581 451 PRINTDECLARE;
38010d50 452
10eebdbb 453 if (NILP (printcharfun))
38010d50 454 printcharfun = Vstandard_output;
b7826503 455 CHECK_NUMBER (character);
38010d50 456 PRINTPREPARE;
3738a371 457 PRINTCHAR (XINT (character));
38010d50 458 PRINTFINISH;
3738a371 459 return character;
38010d50
JB
460}
461
dc2a0b79
RS
462/* Used from outside of print.c to print a block of SIZE
463 single-byte chars at DATA on the default output stream.
38010d50
JB
464 Do not use this on the contents of a Lisp string. */
465
dc22f25e 466void
a8fe7202 467write_string (const char *data, int size)
38010d50 468{
081e0581 469 PRINTDECLARE;
38010d50 470 Lisp_Object printcharfun;
38010d50
JB
471
472 printcharfun = Vstandard_output;
473
474 PRINTPREPARE;
dc2a0b79 475 strout (data, size, size, printcharfun, 0);
38010d50
JB
476 PRINTFINISH;
477}
478
2f7c71a1
AS
479/* Used to print a block of SIZE single-byte chars at DATA on a
480 specified stream PRINTCHARFUN.
38010d50
JB
481 Do not use this on the contents of a Lisp string. */
482
2f7c71a1 483static void
a8fe7202 484write_string_1 (const char *data, int size, Lisp_Object printcharfun)
38010d50 485{
081e0581 486 PRINTDECLARE;
38010d50
JB
487
488 PRINTPREPARE;
dc2a0b79 489 strout (data, size, size, printcharfun, 0);
38010d50
JB
490 PRINTFINISH;
491}
492
493
38010d50 494void
971de7fb 495temp_output_buffer_setup (const char *bufname)
38010d50 496{
aed13378 497 int count = SPECPDL_INDEX ();
38010d50
JB
498 register struct buffer *old = current_buffer;
499 register Lisp_Object buf;
500
d9c21094
RS
501 record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
502
38010d50
JB
503 Fset_buffer (Fget_buffer_create (build_string (bufname)));
504
9756ea0f 505 Fkill_all_local_variables ();
fd531951 506 delete_all_overlays (current_buffer);
5d8ea120
TT
507 B_ (current_buffer, directory) = B_ (old, directory);
508 B_ (current_buffer, read_only) = Qnil;
509 B_ (current_buffer, filename) = Qnil;
510 B_ (current_buffer, undo_list) = Qt;
b3f6010e
SM
511 eassert (current_buffer->overlays_before == NULL);
512 eassert (current_buffer->overlays_after == NULL);
5d8ea120
TT
513 B_ (current_buffer, enable_multibyte_characters)
514 = B_ (&buffer_defaults, enable_multibyte_characters);
d28eab19
KH
515 specbind (Qinhibit_read_only, Qt);
516 specbind (Qinhibit_modification_hooks, Qt);
38010d50 517 Ferase_buffer ();
633307b5 518 XSETBUFFER (buf, current_buffer);
38010d50 519
98040cf1 520 Frun_hooks (1, &Qtemp_buffer_setup_hook);
d9c21094
RS
521
522 unbind_to (count, Qnil);
523
524 specbind (Qstandard_output, buf);
38010d50
JB
525}
526
527Lisp_Object
971de7fb 528internal_with_output_to_temp_buffer (const char *bufname, Lisp_Object (*function) (Lisp_Object), Lisp_Object args)
38010d50 529{
aed13378 530 int count = SPECPDL_INDEX ();
38010d50 531 Lisp_Object buf, val;
0ab39c81 532 struct gcpro gcpro1;
38010d50 533
0ab39c81 534 GCPRO1 (args);
38010d50
JB
535 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
536 temp_output_buffer_setup (bufname);
537 buf = Vstandard_output;
0ab39c81 538 UNGCPRO;
38010d50
JB
539
540 val = (*function) (args);
541
0ab39c81 542 GCPRO1 (val);
38010d50 543 temp_output_buffer_show (buf);
0ab39c81 544 UNGCPRO;
38010d50
JB
545
546 return unbind_to (count, val);
547}
548
ab9ffd19
MB
549DEFUN ("with-output-to-temp-buffer",
550 Fwith_output_to_temp_buffer, Swith_output_to_temp_buffer,
38010d50 551 1, UNEVALLED, 0,
8c1a1077 552 doc: /* Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
80281b01
RS
553
554This construct makes buffer BUFNAME empty before running BODY.
555It does not make the buffer current for BODY.
556Instead it binds `standard-output' to that buffer, so that output
557generated with `prin1' and similar functions in BODY goes into
558the buffer.
559
560At the end of BODY, this marks buffer BUFNAME unmodifed and displays
561it in a window, but does not select it. The normal way to do this is
562by calling `display-buffer', then running `temp-buffer-show-hook'.
563However, if `temp-buffer-show-function' is non-nil, it calls that
564function instead (and does not run `temp-buffer-show-hook'). The
565function gets one argument, the buffer to display.
566
567The return value of `with-output-to-temp-buffer' is the value of the
568last form in BODY. If BODY does not finish normally, the buffer
569BUFNAME is not displayed.
570
571This runs the hook `temp-buffer-setup-hook' before BODY,
572with the buffer BUFNAME temporarily current. It runs the hook
573`temp-buffer-show-hook' after displaying buffer BUFNAME, with that
574buffer temporarily current, and the window that was used to display it
575temporarily selected. But it doesn't run `temp-buffer-show-hook'
576if it uses `temp-buffer-show-function'.
ab9ffd19 577
f0005db5 578usage: (with-output-to-temp-buffer BUFNAME BODY...) */)
5842a27b 579 (Lisp_Object args)
38010d50
JB
580{
581 struct gcpro gcpro1;
582 Lisp_Object name;
aed13378 583 int count = SPECPDL_INDEX ();
38010d50
JB
584 Lisp_Object buf, val;
585
586 GCPRO1(args);
587 name = Feval (Fcar (args));
b7826503 588 CHECK_STRING (name);
42a5b22f 589 temp_output_buffer_setup (SSDATA (name));
38010d50 590 buf = Vstandard_output;
8bbfc258 591 UNGCPRO;
38010d50 592
8bbfc258 593 val = Fprogn (XCDR (args));
38010d50 594
8bbfc258 595 GCPRO1 (val);
38010d50 596 temp_output_buffer_show (buf);
8bbfc258 597 UNGCPRO;
38010d50
JB
598
599 return unbind_to (count, val);
600}
0788646c 601
38010d50 602\f
971de7fb
DN
603static void print (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag);
604static void print_preprocess (Lisp_Object obj);
605static void print_preprocess_string (INTERVAL interval, Lisp_Object arg);
606static void print_object (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag);
38010d50
JB
607
608DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
8c1a1077
PJ
609 doc: /* Output a newline to stream PRINTCHARFUN.
610If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used. */)
5842a27b 611 (Lisp_Object printcharfun)
38010d50 612{
081e0581 613 PRINTDECLARE;
38010d50 614
10eebdbb 615 if (NILP (printcharfun))
38010d50
JB
616 printcharfun = Vstandard_output;
617 PRINTPREPARE;
618 PRINTCHAR ('\n');
619 PRINTFINISH;
620 return Qt;
621}
622
623DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
8c1a1077
PJ
624 doc: /* Output the printed representation of OBJECT, any Lisp object.
625Quoting characters are printed when needed to make output that `read'
9474c847 626can handle, whenever this is possible. For complex objects, the behavior
7fab9223 627is controlled by `print-level' and `print-length', which see.
8c1a1077
PJ
628
629OBJECT is any of the Lisp data types: a number, a string, a symbol,
630a list, a buffer, a window, a frame, etc.
631
632A printed representation of an object is text which describes that object.
633
634Optional argument PRINTCHARFUN is the output stream, which can be one
635of these:
636
637 - a buffer, in which case output is inserted into that buffer at point;
638 - a marker, in which case output is inserted at marker's position;
639 - a function, in which case that function is called once for each
640 character of OBJECT's printed representation;
641 - a symbol, in which case that symbol's function definition is called; or
642 - t, in which case the output is displayed in the echo area.
643
644If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
645is used instead. */)
5842a27b 646 (Lisp_Object object, Lisp_Object printcharfun)
38010d50 647{
081e0581 648 PRINTDECLARE;
38010d50 649
10eebdbb 650 if (NILP (printcharfun))
38010d50
JB
651 printcharfun = Vstandard_output;
652 PRINTPREPARE;
3738a371 653 print (object, printcharfun, 1);
38010d50 654 PRINTFINISH;
3738a371 655 return object;
38010d50
JB
656}
657
658/* a buffer which is used to hold output being built by prin1-to-string */
659Lisp_Object Vprin1_to_string_buffer;
660
661DEFUN ("prin1-to-string", Fprin1_to_string, Sprin1_to_string, 1, 2, 0,
fd4d156b
RS
662 doc: /* Return a string containing the printed representation of OBJECT.
663OBJECT can be any Lisp object. This function outputs quoting characters
cf393f9b 664when necessary to make output that `read' can handle, whenever possible,
a2612656
EZ
665unless the optional second argument NOESCAPE is non-nil. For complex objects,
666the behavior is controlled by `print-level' and `print-length', which see.
8c1a1077
PJ
667
668OBJECT is any of the Lisp data types: a number, a string, a symbol,
669a list, a buffer, a window, a frame, etc.
670
671A printed representation of an object is text which describes that object. */)
5842a27b 672 (Lisp_Object object, Lisp_Object noescape)
38010d50 673{
081e0581 674 Lisp_Object printcharfun;
ca2de342
RS
675 /* struct gcpro gcpro1, gcpro2; */
676 Lisp_Object save_deactivate_mark;
1a7de17e 677 int count = SPECPDL_INDEX ();
6b61353c 678 struct buffer *previous;
ca2de342
RS
679
680 specbind (Qinhibit_modification_hooks, Qt);
2a42e8f6 681
6b61353c
KH
682 {
683 PRINTDECLARE;
684
685 /* Save and restore this--we are altering a buffer
686 but we don't want to deactivate the mark just for that.
687 No need for specbind, since errors deactivate the mark. */
688 save_deactivate_mark = Vdeactivate_mark;
689 /* GCPRO2 (object, save_deactivate_mark); */
690 abort_on_gc++;
691
692 printcharfun = Vprin1_to_string_buffer;
693 PRINTPREPARE;
694 print (object, printcharfun, NILP (noescape));
695 /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
696 PRINTFINISH;
697 }
38010d50 698
6b61353c 699 previous = current_buffer;
38010d50 700 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
3738a371 701 object = Fbuffer_string ();
b51ee131
SM
702 if (SBYTES (object) == SCHARS (object))
703 STRING_SET_UNIBYTE (object);
38010d50 704
28b8f740 705 /* Note that this won't make prepare_to_modify_buffer call
6b61353c
KH
706 ask-user-about-supersession-threat because this buffer
707 does not visit a file. */
38010d50 708 Ferase_buffer ();
6b61353c 709 set_buffer_internal (previous);
2a42e8f6 710
ca2de342
RS
711 Vdeactivate_mark = save_deactivate_mark;
712 /* UNGCPRO; */
38010d50 713
ca2de342
RS
714 abort_on_gc--;
715 return unbind_to (count, object);
38010d50
JB
716}
717
718DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
8c1a1077
PJ
719 doc: /* Output the printed representation of OBJECT, any Lisp object.
720No quoting characters are used; no delimiters are printed around
721the contents of strings.
722
723OBJECT is any of the Lisp data types: a number, a string, a symbol,
724a list, a buffer, a window, a frame, etc.
725
726A printed representation of an object is text which describes that object.
727
728Optional argument PRINTCHARFUN is the output stream, which can be one
729of these:
730
731 - a buffer, in which case output is inserted into that buffer at point;
732 - a marker, in which case output is inserted at marker's position;
733 - a function, in which case that function is called once for each
734 character of OBJECT's printed representation;
735 - a symbol, in which case that symbol's function definition is called; or
736 - t, in which case the output is displayed in the echo area.
737
738If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
739is used instead. */)
5842a27b 740 (Lisp_Object object, Lisp_Object printcharfun)
38010d50 741{
081e0581 742 PRINTDECLARE;
38010d50 743
10eebdbb 744 if (NILP (printcharfun))
38010d50
JB
745 printcharfun = Vstandard_output;
746 PRINTPREPARE;
3738a371 747 print (object, printcharfun, 0);
38010d50 748 PRINTFINISH;
3738a371 749 return object;
38010d50
JB
750}
751
752DEFUN ("print", Fprint, Sprint, 1, 2, 0,
8c1a1077
PJ
753 doc: /* Output the printed representation of OBJECT, with newlines around it.
754Quoting characters are printed when needed to make output that `read'
9474c847 755can handle, whenever this is possible. For complex objects, the behavior
7fab9223 756is controlled by `print-level' and `print-length', which see.
8c1a1077
PJ
757
758OBJECT is any of the Lisp data types: a number, a string, a symbol,
759a list, a buffer, a window, a frame, etc.
760
761A printed representation of an object is text which describes that object.
762
763Optional argument PRINTCHARFUN is the output stream, which can be one
764of these:
765
766 - a buffer, in which case output is inserted into that buffer at point;
767 - a marker, in which case output is inserted at marker's position;
768 - a function, in which case that function is called once for each
769 character of OBJECT's printed representation;
770 - a symbol, in which case that symbol's function definition is called; or
771 - t, in which case the output is displayed in the echo area.
772
773If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
774is used instead. */)
5842a27b 775 (Lisp_Object object, Lisp_Object printcharfun)
38010d50 776{
081e0581 777 PRINTDECLARE;
38010d50
JB
778 struct gcpro gcpro1;
779
10eebdbb 780 if (NILP (printcharfun))
38010d50 781 printcharfun = Vstandard_output;
3738a371 782 GCPRO1 (object);
38010d50 783 PRINTPREPARE;
38010d50 784 PRINTCHAR ('\n');
3738a371 785 print (object, printcharfun, 1);
38010d50
JB
786 PRINTCHAR ('\n');
787 PRINTFINISH;
38010d50 788 UNGCPRO;
3738a371 789 return object;
38010d50
JB
790}
791
792/* The subroutine object for external-debugging-output is kept here
793 for the convenience of the debugger. */
794Lisp_Object Qexternal_debugging_output;
795
4746118a 796DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
8c1a1077
PJ
797 doc: /* Write CHARACTER to stderr.
798You can call print while debugging emacs, and pass it this function
799to make it write to the debugging output. */)
5842a27b 800 (Lisp_Object character)
38010d50 801{
b7826503 802 CHECK_NUMBER (character);
db063399 803 putc ((int) XINT (character), stderr);
cd22039d
RS
804
805#ifdef WINDOWSNT
806 /* Send the output to a debugger (nothing happens if there isn't one). */
945b0111
EZ
807 if (print_output_debug_flag)
808 {
809 char buf[2] = {(char) XINT (character), '\0'};
810 OutputDebugString (buf);
811 }
cd22039d
RS
812#endif
813
38010d50
JB
814 return character;
815}
cf1bb91b 816
c33f8948
RS
817/* This function is never called. Its purpose is to prevent
818 print_output_debug_flag from being optimized away. */
819
dae581bf 820void
971de7fb 821debug_output_compilation_hack (int x)
c33f8948
RS
822{
823 print_output_debug_flag = x;
824}
6b61353c 825
cd3587c1 826#if defined (GNU_LINUX)
6b61353c
KH
827
828/* This functionality is not vitally important in general, so we rely on
829 non-portable ability to use stderr as lvalue. */
830
831#define WITH_REDIRECT_DEBUGGING_OUTPUT 1
832
833FILE *initial_stderr_stream = NULL;
834
835DEFUN ("redirect-debugging-output", Fredirect_debugging_output, Sredirect_debugging_output,
836 1, 2,
837 "FDebug output file: \nP",
838 doc: /* Redirect debugging output (stderr stream) to file FILE.
839If FILE is nil, reset target to the initial stderr stream.
840Optional arg APPEND non-nil (interactively, with prefix arg) means
28b8f740 841append to existing target file. */)
5842a27b 842 (Lisp_Object file, Lisp_Object append)
6b61353c
KH
843{
844 if (initial_stderr_stream != NULL)
f9467be3
YM
845 {
846 BLOCK_INPUT;
847 fclose (stderr);
848 UNBLOCK_INPUT;
849 }
6b61353c
KH
850 stderr = initial_stderr_stream;
851 initial_stderr_stream = NULL;
852
853 if (STRINGP (file))
854 {
855 file = Fexpand_file_name (file, Qnil);
856 initial_stderr_stream = stderr;
cd3587c1 857 stderr = fopen (SDATA (file), NILP (append) ? "w" : "a");
6b61353c
KH
858 if (stderr == NULL)
859 {
860 stderr = initial_stderr_stream;
861 initial_stderr_stream = NULL;
862 report_file_error ("Cannot open debugging output stream",
863 Fcons (file, Qnil));
864 }
865 }
866 return Qnil;
867}
868#endif /* GNU_LINUX */
869
870
cf1bb91b
RS
871/* This is the interface for debugging printing. */
872
873void
971de7fb 874debug_print (Lisp_Object arg)
cf1bb91b
RS
875{
876 Fprin1 (arg, Qexternal_debugging_output);
3684eb78 877 fprintf (stderr, "\r\n");
cf1bb91b 878}
bd90dcd0
KS
879
880void
971de7fb 881safe_debug_print (Lisp_Object arg)
bd90dcd0
KS
882{
883 int valid = valid_lisp_object_p (arg);
884
885 if (valid > 0)
886 debug_print (arg);
887 else
888 fprintf (stderr, "#<%s_LISP_OBJECT 0x%08lx>\r\n",
889 !valid ? "INVALID" : "SOME",
4c37a414 890 (unsigned long) XHASH (arg)
bd90dcd0
KS
891 );
892}
893
38010d50 894\f
113620cc
KH
895DEFUN ("error-message-string", Ferror_message_string, Serror_message_string,
896 1, 1, 0,
6b61353c
KH
897 doc: /* Convert an error value (ERROR-SYMBOL . DATA) to an error message.
898See Info anchor `(elisp)Definition of signal' for some details on how this
899error message is constructed. */)
5842a27b 900 (Lisp_Object obj)
113620cc
KH
901{
902 struct buffer *old = current_buffer;
63fbf4ff 903 Lisp_Object value;
113620cc
KH
904 struct gcpro gcpro1;
905
0872e11f
RS
906 /* If OBJ is (error STRING), just return STRING.
907 That is not only faster, it also avoids the need to allocate
908 space here when the error is due to memory full. */
94b342ce
KR
909 if (CONSP (obj) && EQ (XCAR (obj), Qerror)
910 && CONSP (XCDR (obj))
911 && STRINGP (XCAR (XCDR (obj)))
912 && NILP (XCDR (XCDR (obj))))
913 return XCAR (XCDR (obj));
0872e11f 914
240e806c 915 print_error_message (obj, Vprin1_to_string_buffer, 0, Qnil);
113620cc
KH
916
917 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
918 value = Fbuffer_string ();
919
920 GCPRO1 (value);
921 Ferase_buffer ();
922 set_buffer_internal (old);
923 UNGCPRO;
924
925 return value;
926}
927
c02279de 928/* Print an error message for the error DATA onto Lisp output stream
7ab56fea
RS
929 STREAM (suitable for the print functions).
930 CONTEXT is a C string describing the context of the error.
931 CALLER is the Lisp function inside which the error was signaled. */
113620cc 932
dc22f25e 933void
a8fe7202
AS
934print_error_message (Lisp_Object data, Lisp_Object stream, const char *context,
935 Lisp_Object caller)
113620cc
KH
936{
937 Lisp_Object errname, errmsg, file_error, tail;
938 struct gcpro gcpro1;
939 int i;
940
240e806c
RS
941 if (context != 0)
942 write_string_1 (context, -1, stream);
943
944 /* If we know from where the error was signaled, show it in
945 *Messages*. */
946 if (!NILP (caller) && SYMBOLP (caller))
947 {
11fb15d5
KS
948 Lisp_Object cname = SYMBOL_NAME (caller);
949 char *name = alloca (SBYTES (cname));
72af86bd 950 memcpy (name, SDATA (cname), SBYTES (cname));
826256dd 951 message_dolog (name, SBYTES (cname), 0, 0);
240e806c
RS
952 message_dolog (": ", 2, 0, 0);
953 }
954
113620cc
KH
955 errname = Fcar (data);
956
957 if (EQ (errname, Qerror))
958 {
959 data = Fcdr (data);
c02279de
GM
960 if (!CONSP (data))
961 data = Qnil;
113620cc
KH
962 errmsg = Fcar (data);
963 file_error = Qnil;
964 }
965 else
966 {
c02279de 967 Lisp_Object error_conditions;
113620cc 968 errmsg = Fget (errname, Qerror_message);
c02279de
GM
969 error_conditions = Fget (errname, Qerror_conditions);
970 file_error = Fmemq (Qfile_error, error_conditions);
113620cc
KH
971 }
972
973 /* Print an error message including the data items. */
974
975 tail = Fcdr_safe (data);
976 GCPRO1 (tail);
977
978 /* For file-error, make error message by concatenating
979 all the data items. They are all strings. */
8c29413d 980 if (!NILP (file_error) && CONSP (tail))
94b342ce 981 errmsg = XCAR (tail), tail = XCDR (tail);
113620cc
KH
982
983 if (STRINGP (errmsg))
984 Fprinc (errmsg, stream);
985 else
986 write_string_1 ("peculiar error", -1, stream);
987
c02279de 988 for (i = 0; CONSP (tail); tail = XCDR (tail), i++)
113620cc 989 {
c02279de
GM
990 Lisp_Object obj;
991
113620cc 992 write_string_1 (i ? ", " : ": ", 2, stream);
c02279de
GM
993 obj = XCAR (tail);
994 if (!NILP (file_error) || EQ (errname, Qend_of_file))
995 Fprinc (obj, stream);
113620cc 996 else
c02279de 997 Fprin1 (obj, stream);
113620cc 998 }
177c0ea7 999
113620cc
KH
1000 UNGCPRO;
1001}
38010d50 1002
c02279de
GM
1003
1004\f
38010d50 1005/*
edb2a707 1006 * The buffer should be at least as large as the max string size of the
8e6208c5 1007 * largest float, printed in the biggest notation. This is undoubtedly
38010d50
JB
1008 * 20d float_output_format, with the negative of the C-constant "HUGE"
1009 * from <math.h>.
177c0ea7 1010 *
38010d50 1011 * On the vax the worst case is -1e38 in 20d format which takes 61 bytes.
177c0ea7 1012 *
38010d50
JB
1013 * I assume that IEEE-754 format numbers can take 329 bytes for the worst
1014 * case of -1e307 in 20d float_output_format. What is one to do (short of
1015 * re-writing _doprnt to be more sane)?
1016 * -wsr
6e8e6bf2 1017 * Given the above, the buffer must be least FLOAT_TO_STRING_BUFSIZE bytes.
38010d50 1018 */
edb2a707
RS
1019
1020void
57ace6d0 1021float_to_string (char *buf, double data)
38010d50 1022{
57ace6d0 1023 char *cp;
322890c4 1024 int width;
177c0ea7 1025
7f45de2d
RS
1026 /* Check for plus infinity in a way that won't lose
1027 if there is no plus infinity. */
1028 if (data == data / 2 && data > 1.0)
1029 {
1030 strcpy (buf, "1.0e+INF");
1031 return;
1032 }
1033 /* Likewise for minus infinity. */
1034 if (data == data / 2 && data < -1.0)
1035 {
1036 strcpy (buf, "-1.0e+INF");
1037 return;
1038 }
1039 /* Check for NaN in a way that won't fail if there are no NaNs. */
1040 if (! (data * 0.0 >= 0.0))
1041 {
68c45bf0
PE
1042 /* Prepend "-" if the NaN's sign bit is negative.
1043 The sign bit of a double is the bit that is 1 in -0.0. */
1044 int i;
1045 union { double d; char c[sizeof (double)]; } u_data, u_minus_zero;
1046 u_data.d = data;
1047 u_minus_zero.d = - 0.0;
1048 for (i = 0; i < sizeof (double); i++)
1049 if (u_data.c[i] & u_minus_zero.c[i])
1050 {
1051 *buf++ = '-';
1052 break;
1053 }
177c0ea7 1054
7f45de2d
RS
1055 strcpy (buf, "0.0e+NaN");
1056 return;
1057 }
1058
10eebdbb 1059 if (NILP (Vfloat_output_format)
d4ae1f7e 1060 || !STRINGP (Vfloat_output_format))
38010d50 1061 lose:
322890c4 1062 {
f356c3fb 1063 /* Generate the fewest number of digits that represent the
6e8e6bf2 1064 floating point value without losing information. */
75b43359
MWD
1065 dtoastr (buf, FLOAT_TO_STRING_BUFSIZE - 2, 0, 0, data);
1066 /* The decimal point must be printed, or the byte compiler can
1067 get confused (Bug#8033). */
1068 width = 1;
322890c4 1069 }
38010d50
JB
1070 else /* oink oink */
1071 {
1072 /* Check that the spec we have is fully valid.
1073 This means not only valid for printf,
1074 but meant for floats, and reasonable. */
57ace6d0 1075 cp = SSDATA (Vfloat_output_format);
38010d50
JB
1076
1077 if (cp[0] != '%')
1078 goto lose;
1079 if (cp[1] != '.')
1080 goto lose;
1081
1082 cp += 2;
c7b14277
JB
1083
1084 /* Check the width specification. */
322890c4 1085 width = -1;
c7b14277 1086 if ('0' <= *cp && *cp <= '9')
381cd4bb
KH
1087 {
1088 width = 0;
1089 do
1090 width = (width * 10) + (*cp++ - '0');
1091 while (*cp >= '0' && *cp <= '9');
1092
1093 /* A precision of zero is valid only for %f. */
1094 if (width > DBL_DIG
1095 || (width == 0 && *cp != 'f'))
1096 goto lose;
1097 }
38010d50
JB
1098
1099 if (*cp != 'e' && *cp != 'f' && *cp != 'g')
1100 goto lose;
1101
38010d50
JB
1102 if (cp[1] != 0)
1103 goto lose;
1104
42a5b22f 1105 sprintf (buf, SSDATA (Vfloat_output_format), data);
38010d50 1106 }
edb2a707 1107
c7b14277
JB
1108 /* Make sure there is a decimal point with digit after, or an
1109 exponent, so that the value is readable as a float. But don't do
322890c4
RS
1110 this with "%.0f"; it's valid for that not to produce a decimal
1111 point. Note that width can be 0 only for %.0f. */
1112 if (width != 0)
0601fd3d 1113 {
c7b14277
JB
1114 for (cp = buf; *cp; cp++)
1115 if ((*cp < '0' || *cp > '9') && *cp != '-')
1116 break;
0601fd3d 1117
c7b14277
JB
1118 if (*cp == '.' && cp[1] == 0)
1119 {
1120 cp[1] = '0';
1121 cp[2] = 0;
1122 }
75b43359 1123 else if (*cp == 0)
c7b14277
JB
1124 {
1125 *cp++ = '.';
1126 *cp++ = '0';
1127 *cp++ = 0;
1128 }
edb2a707 1129 }
38010d50 1130}
cc94f3b2 1131
38010d50
JB
1132\f
1133static void
971de7fb 1134print (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag)
38010d50 1135{
a22dec27 1136 new_backquote_output = 0;
38010d50 1137
0f25ecc6
RS
1138 /* Reset print_number_index and Vprint_number_table only when
1139 the variable Vprint_continuous_numbering is nil. Otherwise,
1140 the values of these variables will be kept between several
1141 print functions. */
e026eb89
KS
1142 if (NILP (Vprint_continuous_numbering)
1143 || NILP (Vprint_number_table))
0f25ecc6
RS
1144 {
1145 print_number_index = 0;
1146 Vprint_number_table = Qnil;
1147 }
38010d50 1148
0f25ecc6
RS
1149 /* Construct Vprint_number_table for print-gensym and print-circle. */
1150 if (!NILP (Vprint_gensym) || !NILP (Vprint_circle))
ec838c39 1151 {
e6d4cddd
RS
1152 /* Construct Vprint_number_table.
1153 This increments print_number_index for the objects added. */
9a6a4c40 1154 print_depth = 0;
0f25ecc6 1155 print_preprocess (obj);
e6d4cddd 1156
a65b85b5
SM
1157 if (HASH_TABLE_P (Vprint_number_table))
1158 { /* Remove unnecessary objects, which appear only once in OBJ;
1159 that is, whose status is Qt.
1160 Maybe a better way to do that is to copy elements to
1161 a new hash table. */
1162 struct Lisp_Hash_Table *h = XHASH_TABLE (Vprint_number_table);
1163 int i;
e6d4cddd 1164
a65b85b5
SM
1165 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1166 if (!NILP (HASH_HASH (h, i))
1167 && EQ (HASH_VALUE (h, i), Qt))
1168 Fremhash (HASH_KEY (h, i), Vprint_number_table);
1169 }
0f25ecc6
RS
1170 }
1171
9a6a4c40 1172 print_depth = 0;
0f25ecc6
RS
1173 print_object (obj, printcharfun, escapeflag);
1174}
1175
1176/* Construct Vprint_number_table according to the structure of OBJ.
1177 OBJ itself and all its elements will be added to Vprint_number_table
1178 recursively if it is a list, vector, compiled function, char-table,
1179 string (its text properties will be traced), or a symbol that has
1180 no obarray (this is for the print-gensym feature).
1181 The status fields of Vprint_number_table mean whether each object appears
1182 more than once in OBJ: Qnil at the first time, and Qt after that . */
1183static void
971de7fb 1184print_preprocess (Lisp_Object obj)
0f25ecc6 1185{
6b61353c
KH
1186 int i;
1187 EMACS_INT size;
c1132671
RS
1188 int loop_count = 0;
1189 Lisp_Object halftail;
1190
15479e8b
RS
1191 /* Give up if we go so deep that print_object will get an error. */
1192 /* See similar code in print_object. */
1193 if (print_depth >= PRINT_CIRCLE)
6b8dfbf7 1194 error ("Apparently circular structure being printed");
15479e8b 1195
c1132671
RS
1196 /* Avoid infinite recursion for circular nested structure
1197 in the case where Vprint_circle is nil. */
1198 if (NILP (Vprint_circle))
1199 {
1200 for (i = 0; i < print_depth; i++)
1201 if (EQ (obj, being_printed[i]))
1202 return;
1203 being_printed[print_depth] = obj;
1204 }
1205
c1132671
RS
1206 print_depth++;
1207 halftail = obj;
0f25ecc6
RS
1208
1209 loop:
1210 if (STRINGP (obj) || CONSP (obj) || VECTORP (obj)
6d77fa95 1211 || COMPILEDP (obj) || CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj)
f19a0f5b 1212 || HASH_TABLE_P (obj)
0f25ecc6 1213 || (! NILP (Vprint_gensym)
bf9f2aab
GM
1214 && SYMBOLP (obj)
1215 && !SYMBOL_INTERNED_P (obj)))
0f25ecc6 1216 {
a65b85b5
SM
1217 if (!HASH_TABLE_P (Vprint_number_table))
1218 {
1219 Lisp_Object args[2];
1220 args[0] = QCtest;
1221 args[1] = Qeq;
1222 Vprint_number_table = Fmake_hash_table (2, args);
1223 }
1224
aca2020b
KH
1225 /* In case print-circle is nil and print-gensym is t,
1226 add OBJ to Vprint_number_table only when OBJ is a symbol. */
1227 if (! NILP (Vprint_circle) || SYMBOLP (obj))
0f25ecc6 1228 {
a65b85b5
SM
1229 Lisp_Object num = Fgethash (obj, Vprint_number_table, Qnil);
1230 if (!NILP (num)
1231 /* If Vprint_continuous_numbering is non-nil and OBJ is a gensym,
1232 always print the gensym with a number. This is a special for
1233 the lisp function byte-compile-output-docform. */
1234 || (!NILP (Vprint_continuous_numbering)
1235 && SYMBOLP (obj)
1236 && !SYMBOL_INTERNED_P (obj)))
1237 { /* OBJ appears more than once. Let's remember that. */
17870c01 1238 if (!INTEGERP (num))
aca2020b 1239 {
a65b85b5
SM
1240 print_number_index++;
1241 /* Negative number indicates it hasn't been printed yet. */
1242 Fputhash (obj, make_number (- print_number_index),
1243 Vprint_number_table);
aca2020b 1244 }
a65b85b5
SM
1245 print_depth--;
1246 return;
0f25ecc6 1247 }
a65b85b5
SM
1248 else
1249 /* OBJ is not yet recorded. Let's add to the table. */
1250 Fputhash (obj, Qt, Vprint_number_table);
0f25ecc6 1251 }
0f25ecc6 1252
8e50cc2d 1253 switch (XTYPE (obj))
0f25ecc6
RS
1254 {
1255 case Lisp_String:
0f25ecc6 1256 /* A string may have text properties, which can be circular. */
d5db4077 1257 traverse_intervals_noorder (STRING_INTERVALS (obj),
8bbfc258 1258 print_preprocess_string, Qnil);
0f25ecc6
RS
1259 break;
1260
1261 case Lisp_Cons:
c1132671
RS
1262 /* Use HALFTAIL and LOOP_COUNT to detect circular lists,
1263 just as in print_object. */
1264 if (loop_count && EQ (obj, halftail))
1265 break;
0f25ecc6
RS
1266 print_preprocess (XCAR (obj));
1267 obj = XCDR (obj);
c1132671
RS
1268 loop_count++;
1269 if (!(loop_count & 1))
1270 halftail = XCDR (halftail);
0f25ecc6
RS
1271 goto loop;
1272
1273 case Lisp_Vectorlike:
6b61353c
KH
1274 size = XVECTOR (obj)->size;
1275 if (size & PSEUDOVECTOR_FLAG)
1276 size &= PSEUDOVECTOR_SIZE_MASK;
0f25ecc6
RS
1277 for (i = 0; i < size; i++)
1278 print_preprocess (XVECTOR (obj)->contents[i]);
3e0de07f
SM
1279 if (HASH_TABLE_P (obj))
1280 { /* For hash tables, the key_and_value slot is past
a65b85b5
SM
1281 `size' because it needs to be marked specially in case
1282 the table is weak. */
3e0de07f
SM
1283 struct Lisp_Hash_Table *h = XHASH_TABLE (obj);
1284 print_preprocess (h->key_and_value);
1285 }
ee5263af
GM
1286 break;
1287
1288 default:
1289 break;
0f25ecc6
RS
1290 }
1291 }
c1132671 1292 print_depth--;
0f25ecc6
RS
1293}
1294
0f25ecc6 1295static void
971de7fb 1296print_preprocess_string (INTERVAL interval, Lisp_Object arg)
0f25ecc6
RS
1297{
1298 print_preprocess (interval->plist);
1299}
0f25ecc6 1300
971de7fb 1301static void print_check_string_charset_prop (INTERVAL interval, Lisp_Object string);
71ea13cb
KH
1302
1303#define PRINT_STRING_NON_CHARSET_FOUND 1
1304#define PRINT_STRING_UNSAFE_CHARSET_FOUND 2
1305
51e4f4a8 1306/* Bitwise or of the above macros. */
71ea13cb
KH
1307static int print_check_string_result;
1308
1309static void
971de7fb 1310print_check_string_charset_prop (INTERVAL interval, Lisp_Object string)
71ea13cb
KH
1311{
1312 Lisp_Object val;
1313
1314 if (NILP (interval->plist)
1315 || (print_check_string_result == (PRINT_STRING_NON_CHARSET_FOUND
1316 | PRINT_STRING_UNSAFE_CHARSET_FOUND)))
1317 return;
1318 for (val = interval->plist; CONSP (val) && ! EQ (XCAR (val), Qcharset);
1319 val = XCDR (XCDR (val)));
1320 if (! CONSP (val))
1321 {
1322 print_check_string_result |= PRINT_STRING_NON_CHARSET_FOUND;
1323 return;
1324 }
1325 if (! (print_check_string_result & PRINT_STRING_NON_CHARSET_FOUND))
1326 {
1327 if (! EQ (val, interval->plist)
1328 || CONSP (XCDR (XCDR (val))))
1329 print_check_string_result |= PRINT_STRING_NON_CHARSET_FOUND;
1330 }
1331 if (NILP (Vprint_charset_text_property)
1332 || ! (print_check_string_result & PRINT_STRING_UNSAFE_CHARSET_FOUND))
1333 {
1334 int i, c;
db063399
LMI
1335 EMACS_INT charpos = interval->position;
1336 EMACS_INT bytepos = string_char_to_byte (string, charpos);
71ea13cb
KH
1337 Lisp_Object charset;
1338
1339 charset = XCAR (XCDR (val));
1340 for (i = 0; i < LENGTH (interval); i++)
1341 {
1342 FETCH_STRING_CHAR_ADVANCE (c, string, charpos, bytepos);
c80bcdbc
KH
1343 if (! ASCII_CHAR_P (c)
1344 && ! EQ (CHARSET_NAME (CHAR_CHARSET (c)), charset))
71ea13cb
KH
1345 {
1346 print_check_string_result |= PRINT_STRING_UNSAFE_CHARSET_FOUND;
1347 break;
1348 }
1349 }
1350 }
1351}
1352
1353/* The value is (charset . nil). */
1354static Lisp_Object print_prune_charset_plist;
1355
1356static Lisp_Object
971de7fb 1357print_prune_string_charset (Lisp_Object string)
71ea13cb
KH
1358{
1359 print_check_string_result = 0;
1360 traverse_intervals (STRING_INTERVALS (string), 0,
1361 print_check_string_charset_prop, string);
1362 if (! (print_check_string_result & PRINT_STRING_UNSAFE_CHARSET_FOUND))
1363 {
1364 string = Fcopy_sequence (string);
1365 if (print_check_string_result & PRINT_STRING_NON_CHARSET_FOUND)
1366 {
1367 if (NILP (print_prune_charset_plist))
1368 print_prune_charset_plist = Fcons (Qcharset, Qnil);
eabe04c0
KH
1369 Fremove_text_properties (make_number (0),
1370 make_number (SCHARS (string)),
71ea13cb
KH
1371 print_prune_charset_plist, string);
1372 }
1373 else
eabe04c0
KH
1374 Fset_text_properties (make_number (0), make_number (SCHARS (string)),
1375 Qnil, string);
71ea13cb
KH
1376 }
1377 return string;
1378}
1379
0f25ecc6 1380static void
971de7fb 1381print_object (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag)
0f25ecc6 1382{
28b8f740 1383 char buf[40];
0f25ecc6
RS
1384
1385 QUIT;
1386
76afdf7e 1387 /* See similar code in print_preprocess. */
51dc79f8 1388 if (print_depth >= PRINT_CIRCLE)
76afdf7e
CY
1389 error ("Apparently circular structure being printed");
1390
0f25ecc6
RS
1391 /* Detect circularities and truncate them. */
1392 if (STRINGP (obj) || CONSP (obj) || VECTORP (obj)
dec47cc3 1393 || COMPILEDP (obj) || CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj)
f19a0f5b 1394 || HASH_TABLE_P (obj)
0f25ecc6 1395 || (! NILP (Vprint_gensym)
bf9f2aab
GM
1396 && SYMBOLP (obj)
1397 && !SYMBOL_INTERNED_P (obj)))
0f25ecc6
RS
1398 {
1399 if (NILP (Vprint_circle) && NILP (Vprint_gensym))
1400 {
1401 /* Simple but incomplete way. */
1402 int i;
1403 for (i = 0; i < print_depth; i++)
1404 if (EQ (obj, being_printed[i]))
1405 {
1406 sprintf (buf, "#%d", i);
1407 strout (buf, -1, -1, printcharfun, 0);
1408 return;
1409 }
1410 being_printed[print_depth] = obj;
1411 }
1412 else
1413 {
1414 /* With the print-circle feature. */
a65b85b5
SM
1415 Lisp_Object num = Fgethash (obj, Vprint_number_table, Qnil);
1416 if (INTEGERP (num))
1417 {
1418 int n = XINT (num);
1419 if (n < 0)
1420 { /* Add a prefix #n= if OBJ has not yet been printed;
1421 that is, its status field is nil. */
1422 sprintf (buf, "#%d=", -n);
1423 strout (buf, -1, -1, printcharfun, 0);
1424 /* OBJ is going to be printed. Remember that fact. */
1425 Fputhash (obj, make_number (- n), Vprint_number_table);
1426 }
1427 else
1428 {
1429 /* Just print #n# if OBJ has already been printed. */
1430 sprintf (buf, "#%d#", n);
1431 strout (buf, -1, -1, printcharfun, 0);
1432 return;
1433 }
1434 }
0f25ecc6 1435 }
ec838c39 1436 }
ec838c39 1437
38010d50
JB
1438 print_depth++;
1439
8e50cc2d 1440 switch (XTYPE (obj))
38010d50 1441 {
2de9f71c 1442 case_Lisp_Int:
b8180922 1443 if (sizeof (int) == sizeof (EMACS_INT))
6af1696d 1444 sprintf (buf, "%d", (int) XINT (obj));
b8180922 1445 else if (sizeof (long) == sizeof (EMACS_INT))
63fbf4ff 1446 sprintf (buf, "%ld", (long) XINT (obj));
b8180922
RS
1447 else
1448 abort ();
dc2a0b79 1449 strout (buf, -1, -1, printcharfun, 0);
ca0569ad
RS
1450 break;
1451
ca0569ad
RS
1452 case Lisp_Float:
1453 {
6e8e6bf2 1454 char pigbuf[FLOAT_TO_STRING_BUFSIZE];
38010d50 1455
94b342ce 1456 float_to_string (pigbuf, XFLOAT_DATA (obj));
dc2a0b79 1457 strout (pigbuf, -1, -1, printcharfun, 0);
ca0569ad
RS
1458 }
1459 break;
ca0569ad
RS
1460
1461 case Lisp_String:
38010d50
JB
1462 if (!escapeflag)
1463 print_string (obj, printcharfun);
1464 else
1465 {
da43f021 1466 register EMACS_INT i, i_byte;
38010d50 1467 struct gcpro gcpro1;
872a36d2 1468 unsigned char *str;
db063399 1469 EMACS_INT size_byte;
453fa987
RS
1470 /* 1 means we must ensure that the next character we output
1471 cannot be taken as part of a hex character escape. */
1472 int need_nonhex = 0;
db300f59 1473 int multibyte = STRING_MULTIBYTE (obj);
38010d50 1474
7651e1f5
RS
1475 GCPRO1 (obj);
1476
71ea13cb
KH
1477 if (! EQ (Vprint_charset_text_property, Qt))
1478 obj = print_prune_string_charset (obj);
1479
d5db4077 1480 if (!NULL_INTERVAL_P (STRING_INTERVALS (obj)))
7651e1f5
RS
1481 {
1482 PRINTCHAR ('#');
1483 PRINTCHAR ('(');
1484 }
38010d50
JB
1485
1486 PRINTCHAR ('\"');
d5db4077
KR
1487 str = SDATA (obj);
1488 size_byte = SBYTES (obj);
dc2a0b79
RS
1489
1490 for (i = 0, i_byte = 0; i_byte < size_byte;)
38010d50 1491 {
6ddd6eee
RS
1492 /* Here, we must convert each multi-byte form to the
1493 corresponding character code before handing it to PRINTCHAR. */
1494 int len;
dc2a0b79
RS
1495 int c;
1496
db300f59 1497 if (multibyte)
872a36d2 1498 {
62a6e103 1499 c = STRING_CHAR_AND_LENGTH (str + i_byte, len);
8b4b4467 1500 i_byte += len;
872a36d2 1501 }
dc2a0b79 1502 else
872a36d2 1503 c = str[i_byte++];
dc2a0b79 1504
38010d50 1505 QUIT;
6ddd6eee 1506
38010d50
JB
1507 if (c == '\n' && print_escape_newlines)
1508 {
1509 PRINTCHAR ('\\');
1510 PRINTCHAR ('n');
1511 }
c6f7982f
RM
1512 else if (c == '\f' && print_escape_newlines)
1513 {
1514 PRINTCHAR ('\\');
1515 PRINTCHAR ('f');
1516 }
ae7367d3 1517 else if (multibyte
42a5b22f 1518 && (CHAR_BYTE8_P (c)
73af357a 1519 || (! ASCII_CHAR_P (c) && print_escape_multibyte)))
dc2a0b79
RS
1520 {
1521 /* When multibyte is disabled,
ae7367d3
RS
1522 print multibyte string chars using hex escapes.
1523 For a char code that could be in a unibyte string,
1524 when found in a multibyte string, always use a hex escape
1525 so it reads back as multibyte. */
09125ef8 1526 char outbuf[50];
8b4b4467
KH
1527
1528 if (CHAR_BYTE8_P (c))
1529 sprintf (outbuf, "\\%03o", CHAR_TO_BYTE8 (c));
1530 else
8f924df7
KH
1531 {
1532 sprintf (outbuf, "\\x%04x", c);
1533 need_nonhex = 1;
1534 }
dc2a0b79
RS
1535 strout (outbuf, -1, -1, printcharfun, 0);
1536 }
db300f59
RS
1537 else if (! multibyte
1538 && SINGLE_BYTE_CHAR_P (c) && ! ASCII_BYTE_P (c)
835d0be6 1539 && print_escape_nonascii)
974a6ff5 1540 {
835d0be6
RS
1541 /* When printing in a multibyte buffer
1542 or when explicitly requested,
974a6ff5
KH
1543 print single-byte non-ASCII string chars
1544 using octal escapes. */
09125ef8 1545 char outbuf[5];
974a6ff5
KH
1546 sprintf (outbuf, "\\%03o", c);
1547 strout (outbuf, -1, -1, printcharfun, 0);
1548 }
38010d50
JB
1549 else
1550 {
453fa987
RS
1551 /* If we just had a hex escape, and this character
1552 could be taken as part of it,
1553 output `\ ' to prevent that. */
1b62edd6
KH
1554 if (need_nonhex)
1555 {
1556 need_nonhex = 0;
1557 if ((c >= 'a' && c <= 'f')
453fa987 1558 || (c >= 'A' && c <= 'F')
1b62edd6
KH
1559 || (c >= '0' && c <= '9'))
1560 strout ("\\ ", -1, -1, printcharfun, 0);
1561 }
453fa987 1562
38010d50
JB
1563 if (c == '\"' || c == '\\')
1564 PRINTCHAR ('\\');
1565 PRINTCHAR (c);
1566 }
1567 }
1568 PRINTCHAR ('\"');
7651e1f5 1569
d5db4077 1570 if (!NULL_INTERVAL_P (STRING_INTERVALS (obj)))
7651e1f5 1571 {
d5db4077 1572 traverse_intervals (STRING_INTERVALS (obj),
8bbfc258 1573 0, print_interval, printcharfun);
7651e1f5
RS
1574 PRINTCHAR (')');
1575 }
7651e1f5 1576
38010d50
JB
1577 UNGCPRO;
1578 }
ca0569ad 1579 break;
38010d50 1580
ca0569ad
RS
1581 case Lisp_Symbol:
1582 {
1583 register int confusing;
d5db4077
KR
1584 register unsigned char *p = SDATA (SYMBOL_NAME (obj));
1585 register unsigned char *end = p + SBYTES (SYMBOL_NAME (obj));
2190a05e 1586 register int c;
db063399
LMI
1587 int i, i_byte;
1588 EMACS_INT size_byte;
dc2a0b79
RS
1589 Lisp_Object name;
1590
76d0b3ae 1591 name = SYMBOL_NAME (obj);
ca0569ad
RS
1592
1593 if (p != end && (*p == '-' || *p == '+')) p++;
1594 if (p == end)
1595 confusing = 0;
d27497e3
RS
1596 /* If symbol name begins with a digit, and ends with a digit,
1597 and contains nothing but digits and `e', it could be treated
1598 as a number. So set CONFUSING.
1599
1600 Symbols that contain periods could also be taken as numbers,
1601 but periods are always escaped, so we don't have to worry
1602 about them here. */
1603 else if (*p >= '0' && *p <= '9'
1604 && end[-1] >= '0' && end[-1] <= '9')
ca0569ad 1605 {
e837058b
RS
1606 while (p != end && ((*p >= '0' && *p <= '9')
1607 /* Needed for \2e10. */
01a8d3fa 1608 || *p == 'e' || *p == 'E'))
ca0569ad
RS
1609 p++;
1610 confusing = (end == p);
1611 }
d27497e3
RS
1612 else
1613 confusing = 0;
ca0569ad 1614
bf9f2aab 1615 if (! NILP (Vprint_gensym) && !SYMBOL_INTERNED_P (obj))
081e0581 1616 {
081e0581
EN
1617 PRINTCHAR ('#');
1618 PRINTCHAR (':');
1619 }
1620
d5db4077 1621 size_byte = SBYTES (name);
dc2a0b79
RS
1622
1623 for (i = 0, i_byte = 0; i_byte < size_byte;)
ca0569ad 1624 {
6ddd6eee
RS
1625 /* Here, we must convert each multi-byte form to the
1626 corresponding character code before handing it to PRINTCHAR. */
eba90784 1627 FETCH_STRING_CHAR_ADVANCE (c, name, i, i_byte);
ca0569ad 1628 QUIT;
09eddb56 1629
ca0569ad
RS
1630 if (escapeflag)
1631 {
09eddb56
RS
1632 if (c == '\"' || c == '\\' || c == '\''
1633 || c == ';' || c == '#' || c == '(' || c == ')'
1634 || c == ',' || c =='.' || c == '`'
1635 || c == '[' || c == ']' || c == '?' || c <= 040
1636 || confusing)
ca0569ad
RS
1637 PRINTCHAR ('\\'), confusing = 0;
1638 }
1639 PRINTCHAR (c);
1640 }
1641 }
1642 break;
1643
1644 case Lisp_Cons:
38010d50 1645 /* If deeper than spec'd depth, print placeholder. */
d4ae1f7e 1646 if (INTEGERP (Vprint_level)
38010d50 1647 && print_depth > XINT (Vprint_level))
dc2a0b79 1648 strout ("...", -1, -1, printcharfun, 0);
2f100b5c
EN
1649 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1650 && (EQ (XCAR (obj), Qquote)))
1651 {
1652 PRINTCHAR ('\'');
0f25ecc6 1653 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
2f100b5c
EN
1654 }
1655 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1656 && (EQ (XCAR (obj), Qfunction)))
1657 {
1658 PRINTCHAR ('#');
1659 PRINTCHAR ('\'');
0f25ecc6 1660 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
2f100b5c
EN
1661 }
1662 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
a22dec27
SM
1663 && ((EQ (XCAR (obj), Qbackquote))))
1664 {
1665 print_object (XCAR (obj), printcharfun, 0);
1666 new_backquote_output++;
1667 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1668 new_backquote_output--;
1669 }
1670 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1671 && new_backquote_output
2f100b5c
EN
1672 && ((EQ (XCAR (obj), Qbackquote)
1673 || EQ (XCAR (obj), Qcomma)
1674 || EQ (XCAR (obj), Qcomma_at)
1675 || EQ (XCAR (obj), Qcomma_dot))))
1676 {
0f25ecc6 1677 print_object (XCAR (obj), printcharfun, 0);
a22dec27 1678 new_backquote_output--;
0f25ecc6 1679 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
a22dec27 1680 new_backquote_output++;
2f100b5c 1681 }
e0f93814 1682 else
38010d50 1683 {
e0f93814 1684 PRINTCHAR ('(');
177c0ea7 1685
0330bb60
RS
1686 /* If the first element is a backquote form,
1687 print it old-style so it won't be misunderstood. */
1688 if (print_quoted && CONSP (XCAR (obj))
1689 && CONSP (XCDR (XCAR (obj)))
1690 && NILP (XCDR (XCDR (XCAR (obj))))
1691 && EQ (XCAR (XCAR (obj)), Qbackquote))
1692 {
1693 Lisp_Object tem;
1694 tem = XCAR (obj);
1695 PRINTCHAR ('(');
1696
1697 print_object (Qbackquote, printcharfun, 0);
1698 PRINTCHAR (' ');
1699
0330bb60 1700 print_object (XCAR (XCDR (tem)), printcharfun, 0);
0330bb60
RS
1701 PRINTCHAR (')');
1702
1703 obj = XCDR (obj);
1704 }
1705
38010d50 1706 {
db063399
LMI
1707 EMACS_INT print_length;
1708 int i;
1eab22b5 1709 Lisp_Object halftail = obj;
e0f93814 1710
9ab8560d 1711 /* Negative values of print-length are invalid in CL.
42ac1ed4
GM
1712 Treat them like nil, as CMUCL does. */
1713 if (NATNUMP (Vprint_length))
1714 print_length = XFASTINT (Vprint_length);
1715 else
1716 print_length = 0;
1717
1718 i = 0;
e0f93814 1719 while (CONSP (obj))
38010d50 1720 {
1eab22b5 1721 /* Detect circular list. */
0f25ecc6 1722 if (NILP (Vprint_circle))
1eab22b5 1723 {
0f25ecc6
RS
1724 /* Simple but imcomplete way. */
1725 if (i != 0 && EQ (obj, halftail))
1726 {
1727 sprintf (buf, " . #%d", i / 2);
1728 strout (buf, -1, -1, printcharfun, 0);
1729 goto end_of_list;
1730 }
1731 }
1732 else
1733 {
1734 /* With the print-circle feature. */
1735 if (i != 0)
1736 {
a65b85b5
SM
1737 Lisp_Object num = Fgethash (obj, Vprint_number_table, Qnil);
1738 if (INTEGERP (num))
36de6a04
AS
1739 {
1740 strout (" . ", 3, 3, printcharfun, 0);
1741 print_object (obj, printcharfun, escapeflag);
1742 goto end_of_list;
1743 }
0f25ecc6 1744 }
1eab22b5 1745 }
177c0ea7 1746
e0f93814
KH
1747 if (i++)
1748 PRINTCHAR (' ');
177c0ea7 1749
f4fe72d5 1750 if (print_length && i > print_length)
e0f93814 1751 {
dc2a0b79 1752 strout ("...", 3, 3, printcharfun, 0);
0f25ecc6 1753 goto end_of_list;
e0f93814 1754 }
177c0ea7 1755
0f25ecc6 1756 print_object (XCAR (obj), printcharfun, escapeflag);
177c0ea7 1757
2f100b5c 1758 obj = XCDR (obj);
1eab22b5
RS
1759 if (!(i & 1))
1760 halftail = XCDR (halftail);
38010d50 1761 }
38010d50 1762 }
42ac1ed4
GM
1763
1764 /* OBJ non-nil here means it's the end of a dotted list. */
2f100b5c 1765 if (!NILP (obj))
e0f93814 1766 {
dc2a0b79 1767 strout (" . ", 3, 3, printcharfun, 0);
0f25ecc6 1768 print_object (obj, printcharfun, escapeflag);
e0f93814 1769 }
177c0ea7 1770
0f25ecc6 1771 end_of_list:
e0f93814 1772 PRINTCHAR (')');
38010d50 1773 }
ca0569ad
RS
1774 break;
1775
1776 case Lisp_Vectorlike:
1777 if (PROCESSP (obj))
1778 {
1779 if (escapeflag)
1780 {
dc2a0b79 1781 strout ("#<process ", -1, -1, printcharfun, 0);
ca0569ad
RS
1782 print_string (XPROCESS (obj)->name, printcharfun);
1783 PRINTCHAR ('>');
1784 }
1785 else
1786 print_string (XPROCESS (obj)->name, printcharfun);
1787 }
ed2c35ef
RS
1788 else if (BOOL_VECTOR_P (obj))
1789 {
1790 register int i;
1791 register unsigned char c;
1792 struct gcpro gcpro1;
db063399 1793 EMACS_INT size_in_chars
4b5af5e4
AS
1794 = ((XBOOL_VECTOR (obj)->size + BOOL_VECTOR_BITS_PER_CHAR - 1)
1795 / BOOL_VECTOR_BITS_PER_CHAR);
ed2c35ef
RS
1796
1797 GCPRO1 (obj);
1798
1799 PRINTCHAR ('#');
1800 PRINTCHAR ('&');
474f84d9 1801 sprintf (buf, "%ld", (long) XBOOL_VECTOR (obj)->size);
dc2a0b79 1802 strout (buf, -1, -1, printcharfun, 0);
ed2c35ef 1803 PRINTCHAR ('\"');
a40384bc 1804
42ac1ed4 1805 /* Don't print more characters than the specified maximum.
9ab8560d 1806 Negative values of print-length are invalid. Treat them
42ac1ed4
GM
1807 like a print-length of nil. */
1808 if (NATNUMP (Vprint_length)
1809 && XFASTINT (Vprint_length) < size_in_chars)
1810 size_in_chars = XFASTINT (Vprint_length);
a40384bc 1811
ed2c35ef
RS
1812 for (i = 0; i < size_in_chars; i++)
1813 {
1814 QUIT;
1815 c = XBOOL_VECTOR (obj)->data[i];
f10fdbfd 1816 if (c == '\n' && print_escape_newlines)
ed2c35ef
RS
1817 {
1818 PRINTCHAR ('\\');
1819 PRINTCHAR ('n');
1820 }
1821 else if (c == '\f' && print_escape_newlines)
1822 {
1823 PRINTCHAR ('\\');
1824 PRINTCHAR ('f');
1825 }
4b5af5e4
AS
1826 else if (c > '\177')
1827 {
1828 /* Use octal escapes to avoid encoding issues. */
1829 PRINTCHAR ('\\');
1830 PRINTCHAR ('0' + ((c >> 6) & 3));
1831 PRINTCHAR ('0' + ((c >> 3) & 7));
1832 PRINTCHAR ('0' + (c & 7));
1833 }
ed2c35ef
RS
1834 else
1835 {
1836 if (c == '\"' || c == '\\')
1837 PRINTCHAR ('\\');
1838 PRINTCHAR (c);
1839 }
1840 }
1841 PRINTCHAR ('\"');
1842
1843 UNGCPRO;
1844 }
ca0569ad
RS
1845 else if (SUBRP (obj))
1846 {
dc2a0b79
RS
1847 strout ("#<subr ", -1, -1, printcharfun, 0);
1848 strout (XSUBR (obj)->symbol_name, -1, -1, printcharfun, 0);
ca0569ad
RS
1849 PRINTCHAR ('>');
1850 }
ca0569ad
RS
1851 else if (WINDOWP (obj))
1852 {
dc2a0b79 1853 strout ("#<window ", -1, -1, printcharfun, 0);
474f84d9 1854 sprintf (buf, "%ld", (long) XFASTINT (XWINDOW (obj)->sequence_number));
dc2a0b79 1855 strout (buf, -1, -1, printcharfun, 0);
ca0569ad
RS
1856 if (!NILP (XWINDOW (obj)->buffer))
1857 {
dc2a0b79 1858 strout (" on ", -1, -1, printcharfun, 0);
5d8ea120 1859 print_string (B_ (XBUFFER (XWINDOW (obj)->buffer), name), printcharfun);
ca0569ad
RS
1860 }
1861 PRINTCHAR ('>');
1862 }
f76c8b1e
SM
1863 else if (TERMINALP (obj))
1864 {
1865 struct terminal *t = XTERMINAL (obj);
1866 strout ("#<terminal ", -1, -1, printcharfun, 0);
1867 sprintf (buf, "%d", t->id);
1868 strout (buf, -1, -1, printcharfun, 0);
1869 if (t->name)
1870 {
1871 strout (" on ", -1, -1, printcharfun, 0);
1872 strout (t->name, -1, -1, printcharfun, 0);
1873 }
1874 PRINTCHAR ('>');
1875 }
7eb03302
GM
1876 else if (HASH_TABLE_P (obj))
1877 {
1878 struct Lisp_Hash_Table *h = XHASH_TABLE (obj);
db063399
LMI
1879 int i;
1880 EMACS_INT real_size, size;
f19a0f5b 1881#if 0
7eb03302
GM
1882 strout ("#<hash-table", -1, -1, printcharfun, 0);
1883 if (SYMBOLP (h->test))
1884 {
1885 PRINTCHAR (' ');
1886 PRINTCHAR ('\'');
d5db4077 1887 strout (SDATA (SYMBOL_NAME (h->test)), -1, -1, printcharfun, 0);
7eb03302 1888 PRINTCHAR (' ');
d5db4077 1889 strout (SDATA (SYMBOL_NAME (h->weak)), -1, -1, printcharfun, 0);
7eb03302 1890 PRINTCHAR (' ');
878f97ff 1891 sprintf (buf, "%ld/%ld", (long) h->count,
474f84d9 1892 (long) XVECTOR (h->next)->size);
7eb03302
GM
1893 strout (buf, -1, -1, printcharfun, 0);
1894 }
1895 sprintf (buf, " 0x%lx", (unsigned long) h);
1896 strout (buf, -1, -1, printcharfun, 0);
1897 PRINTCHAR ('>');
f19a0f5b
TZ
1898#endif
1899 /* Implement a readable output, e.g.:
1900 #s(hash-table size 2 test equal data (k1 v1 k2 v2)) */
1901 /* Always print the size. */
1902 sprintf (buf, "#s(hash-table size %ld",
1903 (long) XVECTOR (h->next)->size);
1904 strout (buf, -1, -1, printcharfun, 0);
1905
1906 if (!NILP (h->test))
1907 {
1908 strout (" test ", -1, -1, printcharfun, 0);
1909 print_object (h->test, printcharfun, 0);
1910 }
1911
1912 if (!NILP (h->weak))
1913 {
1914 strout (" weakness ", -1, -1, printcharfun, 0);
1915 print_object (h->weak, printcharfun, 0);
1916 }
1917
1918 if (!NILP (h->rehash_size))
1919 {
1920 strout (" rehash-size ", -1, -1, printcharfun, 0);
1921 print_object (h->rehash_size, printcharfun, 0);
1922 }
1923
1924 if (!NILP (h->rehash_threshold))
1925 {
1926 strout (" rehash-threshold ", -1, -1, printcharfun, 0);
1927 print_object (h->rehash_threshold, printcharfun, 0);
1928 }
1929
1930 strout (" data ", -1, -1, printcharfun, 0);
1931
1932 /* Print the data here as a plist. */
b0ca0f33
DN
1933 real_size = HASH_TABLE_SIZE (h);
1934 size = real_size;
f19a0f5b
TZ
1935
1936 /* Don't print more elements than the specified maximum. */
1937 if (NATNUMP (Vprint_length)
1938 && XFASTINT (Vprint_length) < size)
1939 size = XFASTINT (Vprint_length);
42a5b22f 1940
f19a0f5b
TZ
1941 PRINTCHAR ('(');
1942 for (i = 0; i < size; i++)
1943 if (!NILP (HASH_HASH (h, i)))
1944 {
1945 if (i) PRINTCHAR (' ');
3ed8bbdc 1946 print_object (HASH_KEY (h, i), printcharfun, 1);
f19a0f5b 1947 PRINTCHAR (' ');
3ed8bbdc 1948 print_object (HASH_VALUE (h, i), printcharfun, 1);
f19a0f5b
TZ
1949 }
1950
1951 if (size < real_size)
1952 strout (" ...", 4, 4, printcharfun, 0);
1953
1954 PRINTCHAR (')');
1955 PRINTCHAR (')');
1956
7eb03302 1957 }
908b0ae5
RS
1958 else if (BUFFERP (obj))
1959 {
5d8ea120 1960 if (NILP (B_ (XBUFFER (obj), name)))
dc2a0b79 1961 strout ("#<killed buffer>", -1, -1, printcharfun, 0);
908b0ae5
RS
1962 else if (escapeflag)
1963 {
dc2a0b79 1964 strout ("#<buffer ", -1, -1, printcharfun, 0);
5d8ea120 1965 print_string (B_ (XBUFFER (obj), name), printcharfun);
908b0ae5
RS
1966 PRINTCHAR ('>');
1967 }
1968 else
5d8ea120 1969 print_string (B_ (XBUFFER (obj), name), printcharfun);
908b0ae5 1970 }
ca0569ad
RS
1971 else if (WINDOW_CONFIGURATIONP (obj))
1972 {
dc2a0b79 1973 strout ("#<window-configuration>", -1, -1, printcharfun, 0);
ca0569ad 1974 }
ca0569ad
RS
1975 else if (FRAMEP (obj))
1976 {
1977 strout ((FRAME_LIVE_P (XFRAME (obj))
1978 ? "#<frame " : "#<dead frame "),
dc2a0b79 1979 -1, -1, printcharfun, 0);
ca0569ad 1980 print_string (XFRAME (obj)->name, printcharfun);
aab3aa14 1981 sprintf (buf, " 0x%lx", (unsigned long) (XFRAME (obj)));
dc2a0b79 1982 strout (buf, -1, -1, printcharfun, 0);
ca0569ad
RS
1983 PRINTCHAR ('>');
1984 }
2a7b7982
KH
1985 else if (FONTP (obj))
1986 {
1987 EMACS_INT i;
1988
1989 if (! FONT_OBJECT_P (obj))
1990 {
1991 if (FONT_SPEC_P (obj))
1992 strout ("#<font-spec", -1, -1, printcharfun, 0);
1993 else
1994 strout ("#<font-entity", -1, -1, printcharfun, 0);
1995 for (i = 0; i < FONT_SPEC_MAX; i++)
1996 {
1997 PRINTCHAR (' ');
1998 if (i < FONT_WEIGHT_INDEX || i > FONT_WIDTH_INDEX)
1999 print_object (AREF (obj, i), printcharfun, escapeflag);
2000 else
2001 print_object (font_style_symbolic (obj, i, 0),
2002 printcharfun, escapeflag);
2003 }
2004 }
2005 else
2006 {
2007 strout ("#<font-object ", -1, -1, printcharfun, 0);
2008 print_object (AREF (obj, FONT_NAME_INDEX), printcharfun,
2009 escapeflag);
2010 }
2011 PRINTCHAR ('>');
2012 }
ca0569ad
RS
2013 else
2014 {
6b61353c 2015 EMACS_INT size = XVECTOR (obj)->size;
ca0569ad
RS
2016 if (COMPILEDP (obj))
2017 {
2018 PRINTCHAR ('#');
2019 size &= PSEUDOVECTOR_SIZE_MASK;
2020 }
8b4b4467 2021 if (CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj))
ed2c35ef
RS
2022 {
2023 /* We print a char-table as if it were a vector,
2024 lumping the parent and default slots in with the
2025 character slots. But we add #^ as a prefix. */
223509a3
KH
2026
2027 /* Make each lowest sub_char_table start a new line.
2028 Otherwise we'll make a line extremely long, which
2029 results in slow redisplay. */
2030 if (SUB_CHAR_TABLE_P (obj)
2031 && XINT (XSUB_CHAR_TABLE (obj)->depth) == 3)
2032 PRINTCHAR ('\n');
ed2c35ef
RS
2033 PRINTCHAR ('#');
2034 PRINTCHAR ('^');
3701b5de
KH
2035 if (SUB_CHAR_TABLE_P (obj))
2036 PRINTCHAR ('^');
ed2c35ef
RS
2037 size &= PSEUDOVECTOR_SIZE_MASK;
2038 }
00d76abc
KH
2039 if (size & PSEUDOVECTOR_FLAG)
2040 goto badtype;
ca0569ad
RS
2041
2042 PRINTCHAR ('[');
38010d50 2043 {
ca0569ad
RS
2044 register int i;
2045 register Lisp_Object tem;
db063399 2046 EMACS_INT real_size = size;
a40384bc
RS
2047
2048 /* Don't print more elements than the specified maximum. */
42ac1ed4
GM
2049 if (NATNUMP (Vprint_length)
2050 && XFASTINT (Vprint_length) < size)
2051 size = XFASTINT (Vprint_length);
a40384bc 2052
ca0569ad
RS
2053 for (i = 0; i < size; i++)
2054 {
2055 if (i) PRINTCHAR (' ');
2056 tem = XVECTOR (obj)->contents[i];
0f25ecc6 2057 print_object (tem, printcharfun, escapeflag);
ca0569ad 2058 }
d6ac884e
KH
2059 if (size < real_size)
2060 strout (" ...", 4, 4, printcharfun, 0);
38010d50 2061 }
ca0569ad
RS
2062 PRINTCHAR (']');
2063 }
2064 break;
2065
ca0569ad 2066 case Lisp_Misc:
5db20f08 2067 switch (XMISCTYPE (obj))
38010d50 2068 {
00d76abc 2069 case Lisp_Misc_Marker:
dc2a0b79 2070 strout ("#<marker ", -1, -1, printcharfun, 0);
087e3c46
KH
2071 /* Do you think this is necessary? */
2072 if (XMARKER (obj)->insertion_type != 0)
210ebd3d 2073 strout ("(moves after insertion) ", -1, -1, printcharfun, 0);
cd3587c1 2074 if (! XMARKER (obj)->buffer)
dc2a0b79 2075 strout ("in no buffer", -1, -1, printcharfun, 0);
ca0569ad
RS
2076 else
2077 {
d585695f 2078 sprintf (buf, "at %ld", (long)marker_position (obj));
dc2a0b79
RS
2079 strout (buf, -1, -1, printcharfun, 0);
2080 strout (" in ", -1, -1, printcharfun, 0);
5d8ea120 2081 print_string (B_ (XMARKER (obj)->buffer, name), printcharfun);
ca0569ad 2082 }
38010d50 2083 PRINTCHAR ('>');
908b0ae5 2084 break;
00d76abc
KH
2085
2086 case Lisp_Misc_Overlay:
dc2a0b79 2087 strout ("#<overlay ", -1, -1, printcharfun, 0);
cd3587c1 2088 if (! XMARKER (OVERLAY_START (obj))->buffer)
dc2a0b79 2089 strout ("in no buffer", -1, -1, printcharfun, 0);
ca0569ad
RS
2090 else
2091 {
d585695f
EZ
2092 sprintf (buf, "from %ld to %ld in ",
2093 (long)marker_position (OVERLAY_START (obj)),
2094 (long)marker_position (OVERLAY_END (obj)));
dc2a0b79 2095 strout (buf, -1, -1, printcharfun, 0);
5d8ea120 2096 print_string (B_ (XMARKER (OVERLAY_START (obj))->buffer, name),
ca0569ad
RS
2097 printcharfun);
2098 }
2099 PRINTCHAR ('>');
908b0ae5 2100 break;
00d76abc
KH
2101
2102 /* Remaining cases shouldn't happen in normal usage, but let's print
2103 them anyway for the benefit of the debugger. */
2104 case Lisp_Misc_Free:
dc2a0b79 2105 strout ("#<misc free cell>", -1, -1, printcharfun, 0);
00d76abc
KH
2106 break;
2107
c069fee4
KS
2108 case Lisp_Misc_Save_Value:
2109 strout ("#<save_value ", -1, -1, printcharfun, 0);
44455197 2110 sprintf(buf, "ptr=0x%08lx int=%d",
c069fee4
KS
2111 (unsigned long) XSAVE_VALUE (obj)->pointer,
2112 XSAVE_VALUE (obj)->integer);
2113 strout (buf, -1, -1, printcharfun, 0);
2114 PRINTCHAR ('>');
2115 break;
2116
00d76abc
KH
2117 default:
2118 goto badtype;
e0f93814 2119 }
00d76abc 2120 break;
ca0569ad
RS
2121
2122 default:
00d76abc 2123 badtype:
ca0569ad
RS
2124 {
2125 /* We're in trouble if this happens!
2126 Probably should just abort () */
dc2a0b79 2127 strout ("#<EMACS BUG: INVALID DATATYPE ", -1, -1, printcharfun, 0);
00d76abc 2128 if (MISCP (obj))
5db20f08 2129 sprintf (buf, "(MISC 0x%04x)", (int) XMISCTYPE (obj));
00d76abc
KH
2130 else if (VECTORLIKEP (obj))
2131 sprintf (buf, "(PVEC 0x%08x)", (int) XVECTOR (obj)->size);
2132 else
2133 sprintf (buf, "(0x%02x)", (int) XTYPE (obj));
dc2a0b79 2134 strout (buf, -1, -1, printcharfun, 0);
ca0569ad 2135 strout (" Save your buffers immediately and please report this bug>",
dc2a0b79 2136 -1, -1, printcharfun, 0);
ca0569ad 2137 }
38010d50
JB
2138 }
2139
2140 print_depth--;
2141}
2142\f
7651e1f5
RS
2143
2144/* Print a description of INTERVAL using PRINTCHARFUN.
2145 This is part of printing a string that has text properties. */
2146
2147void
971de7fb 2148print_interval (INTERVAL interval, Lisp_Object printcharfun)
7651e1f5 2149{
71ea13cb
KH
2150 if (NILP (interval->plist))
2151 return;
30503c0b 2152 PRINTCHAR (' ');
0f25ecc6 2153 print_object (make_number (interval->position), printcharfun, 1);
7651e1f5 2154 PRINTCHAR (' ');
0f25ecc6 2155 print_object (make_number (interval->position + LENGTH (interval)),
cd3587c1 2156 printcharfun, 1);
7651e1f5 2157 PRINTCHAR (' ');
0f25ecc6 2158 print_object (interval->plist, printcharfun, 1);
7651e1f5
RS
2159}
2160
7651e1f5 2161\f
38010d50 2162void
971de7fb 2163syms_of_print (void)
38010d50 2164{
d67b4f80 2165 Qtemp_buffer_setup_hook = intern_c_string ("temp-buffer-setup-hook");
d9c21094
RS
2166 staticpro (&Qtemp_buffer_setup_hook);
2167
29208e82 2168 DEFVAR_LISP ("standard-output", Vstandard_output,
8c1a1077
PJ
2169 doc: /* Output stream `print' uses by default for outputting a character.
2170This may be any function of one argument.
2171It may also be a buffer (output is inserted before point)
2172or a marker (output is inserted and the marker is advanced)
2173or the symbol t (output appears in the echo area). */);
38010d50 2174 Vstandard_output = Qt;
d67b4f80 2175 Qstandard_output = intern_c_string ("standard-output");
38010d50
JB
2176 staticpro (&Qstandard_output);
2177
29208e82 2178 DEFVAR_LISP ("float-output-format", Vfloat_output_format,
8c1a1077
PJ
2179 doc: /* The format descriptor string used to print floats.
2180This is a %-spec like those accepted by `printf' in C,
2181but with some restrictions. It must start with the two characters `%.'.
2182After that comes an integer precision specification,
2183and then a letter which controls the format.
2184The letters allowed are `e', `f' and `g'.
2185Use `e' for exponential notation \"DIG.DIGITSeEXPT\"
2186Use `f' for decimal point notation \"DIGITS.DIGITS\".
2187Use `g' to choose the shorter of those two formats for the number at hand.
2188The precision in any of these cases is the number of digits following
2189the decimal point. With `f', a precision of 0 means to omit the
2190decimal point. 0 is not allowed with `e' or `g'.
2191
2192A value of nil means to use the shortest notation
2193that represents the number without losing information. */);
38010d50 2194 Vfloat_output_format = Qnil;
d67b4f80 2195 Qfloat_output_format = intern_c_string ("float-output-format");
38010d50 2196 staticpro (&Qfloat_output_format);
38010d50 2197
29208e82 2198 DEFVAR_LISP ("print-length", Vprint_length,
8c1a1077
PJ
2199 doc: /* Maximum length of list to print before abbreviating.
2200A value of nil means no limit. See also `eval-expression-print-length'. */);
38010d50
JB
2201 Vprint_length = Qnil;
2202
29208e82 2203 DEFVAR_LISP ("print-level", Vprint_level,
8c1a1077
PJ
2204 doc: /* Maximum depth of list nesting to print before abbreviating.
2205A value of nil means no limit. See also `eval-expression-print-level'. */);
38010d50
JB
2206 Vprint_level = Qnil;
2207
29208e82 2208 DEFVAR_BOOL ("print-escape-newlines", print_escape_newlines,
8c1a1077
PJ
2209 doc: /* Non-nil means print newlines in strings as `\\n'.
2210Also print formfeeds as `\\f'. */);
38010d50
JB
2211 print_escape_newlines = 0;
2212
29208e82 2213 DEFVAR_BOOL ("print-escape-nonascii", print_escape_nonascii,
8c1a1077
PJ
2214 doc: /* Non-nil means print unibyte non-ASCII chars in strings as \\OOO.
2215\(OOO is the octal representation of the character code.)
249c0f71
RS
2216Only single-byte characters are affected, and only in `prin1'.
2217When the output goes in a multibyte buffer, this feature is
2218enabled regardless of the value of the variable. */);
38940e93
RS
2219 print_escape_nonascii = 0;
2220
29208e82 2221 DEFVAR_BOOL ("print-escape-multibyte", print_escape_multibyte,
8c1a1077
PJ
2222 doc: /* Non-nil means print multibyte characters in strings as \\xXXXX.
2223\(XXXX is the hex representation of the character code.)
2224This affects only `prin1'. */);
835d0be6
RS
2225 print_escape_multibyte = 0;
2226
29208e82 2227 DEFVAR_BOOL ("print-quoted", print_quoted,
8c1a1077 2228 doc: /* Non-nil means print quoted forms with reader syntax.
db75cb5f 2229I.e., (quote foo) prints as 'foo, (function foo) as #'foo. */);
2f100b5c
EN
2230 print_quoted = 0;
2231
29208e82 2232 DEFVAR_LISP ("print-gensym", Vprint_gensym,
8c1a1077
PJ
2233 doc: /* Non-nil means print uninterned symbols so they will read as uninterned.
2234I.e., the value of (make-symbol \"foobar\") prints as #:foobar.
2235When the uninterned symbol appears within a recursive data structure,
2236and the symbol appears more than once, in addition use the #N# and #N=
2237constructs as needed, so that multiple references to the same symbol are
2238shared once again when the text is read back. */);
e0f69431
RS
2239 Vprint_gensym = Qnil;
2240
29208e82 2241 DEFVAR_LISP ("print-circle", Vprint_circle,
8c1a1077
PJ
2242 doc: /* *Non-nil means print recursive structures using #N= and #N# syntax.
2243If nil, printing proceeds recursively and may lead to
2244`max-lisp-eval-depth' being exceeded or an error may occur:
2245\"Apparently circular structure being printed.\" Also see
2246`print-length' and `print-level'.
2247If non-nil, shared substructures anywhere in the structure are printed
2248with `#N=' before the first occurrence (in the order of the print
2249representation) and `#N#' in place of each subsequent occurrence,
2250where N is a positive decimal integer. */);
0f25ecc6
RS
2251 Vprint_circle = Qnil;
2252
29208e82 2253 DEFVAR_LISP ("print-continuous-numbering", Vprint_continuous_numbering,
8c1a1077
PJ
2254 doc: /* *Non-nil means number continuously across print calls.
2255This affects the numbers printed for #N= labels and #M# references.
2256See also `print-circle', `print-gensym', and `print-number-table'.
2257This variable should not be set with `setq'; bind it with a `let' instead. */);
0f25ecc6
RS
2258 Vprint_continuous_numbering = Qnil;
2259
29208e82 2260 DEFVAR_LISP ("print-number-table", Vprint_number_table,
8c1a1077
PJ
2261 doc: /* A vector used internally to produce `#N=' labels and `#N#' references.
2262The Lisp printer uses this vector to detect Lisp objects referenced more
e6d4cddd
RS
2263than once.
2264
2265When you bind `print-continuous-numbering' to t, you should probably
2266also bind `print-number-table' to nil. This ensures that the value of
2267`print-number-table' can be garbage-collected once the printing is
2268done. If all elements of `print-number-table' are nil, it means that
2269the printing done so far has not found any shared structure or objects
2270that need to be recorded in the table. */);
0f25ecc6 2271 Vprint_number_table = Qnil;
081e0581 2272
29208e82 2273 DEFVAR_LISP ("print-charset-text-property", Vprint_charset_text_property,
71ea13cb
KH
2274 doc: /* A flag to control printing of `charset' text property on printing a string.
2275The value must be nil, t, or `default'.
2276
2277If the value is nil, don't print the text property `charset'.
2278
2279If the value is t, always print the text property `charset'.
2280
2281If the value is `default', print the text property `charset' only when
2282the value is different from what is guessed in the current charset
dedbd91c 2283priorities. */);
71ea13cb
KH
2284 Vprint_charset_text_property = Qdefault;
2285
38010d50
JB
2286 /* prin1_to_string_buffer initialized in init_buffer_once in buffer.c */
2287 staticpro (&Vprin1_to_string_buffer);
2288
2289 defsubr (&Sprin1);
2290 defsubr (&Sprin1_to_string);
113620cc 2291 defsubr (&Serror_message_string);
38010d50
JB
2292 defsubr (&Sprinc);
2293 defsubr (&Sprint);
2294 defsubr (&Sterpri);
2295 defsubr (&Swrite_char);
2296 defsubr (&Sexternal_debugging_output);
6b61353c
KH
2297#ifdef WITH_REDIRECT_DEBUGGING_OUTPUT
2298 defsubr (&Sredirect_debugging_output);
2299#endif
38010d50 2300
d67b4f80 2301 Qexternal_debugging_output = intern_c_string ("external-debugging-output");
38010d50
JB
2302 staticpro (&Qexternal_debugging_output);
2303
d67b4f80 2304 Qprint_escape_newlines = intern_c_string ("print-escape-newlines");
2f100b5c
EN
2305 staticpro (&Qprint_escape_newlines);
2306
d67b4f80 2307 Qprint_escape_multibyte = intern_c_string ("print-escape-multibyte");
835d0be6
RS
2308 staticpro (&Qprint_escape_multibyte);
2309
d67b4f80 2310 Qprint_escape_nonascii = intern_c_string ("print-escape-nonascii");
835d0be6
RS
2311 staticpro (&Qprint_escape_nonascii);
2312
71ea13cb
KH
2313 print_prune_charset_plist = Qnil;
2314 staticpro (&print_prune_charset_plist);
2315
38010d50 2316 defsubr (&Swith_output_to_temp_buffer);
38010d50 2317}