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