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