use dynwind_begin and dynwind_end
[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
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; \
9f62b5dd 103 dynwind_begin (); \
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; \
c1ade6f7 156 print_buffer = xmalloc_atomic (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 } \
9f62b5dd 188 dynwind_end (); \
8a2ab0c6
RS
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
JB
480{
481 register struct buffer *old = current_buffer;
482 register Lisp_Object buf;
483
9f62b5dd 484 dynwind_begin ();
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 505
9f62b5dd 506 dynwind_end ();
d9c21094
RS
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;
6b61353c 586 struct buffer *previous;
ca2de342 587
9f62b5dd 588 dynwind_begin ();
ca2de342 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); */
6b61353c
KH
599
600 printcharfun = Vprin1_to_string_buffer;
601 PRINTPREPARE;
602 print (object, printcharfun, NILP (noescape));
6196cffe 603 /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINISH */
6b61353c
KH
604 PRINTFINISH;
605 }
38010d50 606
6b61353c 607 previous = current_buffer;
38010d50 608 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
3738a371 609 object = Fbuffer_string ();
b51ee131
SM
610 if (SBYTES (object) == SCHARS (object))
611 STRING_SET_UNIBYTE (object);
38010d50 612
28b8f740 613 /* Note that this won't make prepare_to_modify_buffer call
6b61353c
KH
614 ask-user-about-supersession-threat because this buffer
615 does not visit a file. */
38010d50 616 Ferase_buffer ();
6b61353c 617 set_buffer_internal (previous);
2a42e8f6 618
ca2de342
RS
619 Vdeactivate_mark = save_deactivate_mark;
620 /* UNGCPRO; */
38010d50 621
9f62b5dd
BT
622 dynwind_end ();
623 return object;
38010d50
JB
624}
625
ad64fc97 626DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
8c1a1077
PJ
627 doc: /* Output the printed representation of OBJECT, any Lisp object.
628No quoting characters are used; no delimiters are printed around
629the contents of strings.
630
631OBJECT is any of the Lisp data types: a number, a string, a symbol,
632a list, a buffer, a window, a frame, etc.
633
634A printed representation of an object is text which describes that object.
635
636Optional argument PRINTCHARFUN is the output stream, which can be one
637of these:
638
639 - a buffer, in which case output is inserted into that buffer at point;
640 - a marker, in which case output is inserted at marker's position;
641 - a function, in which case that function is called once for each
642 character of OBJECT's printed representation;
643 - a symbol, in which case that symbol's function definition is called; or
644 - t, in which case the output is displayed in the echo area.
645
646If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
647is used instead. */)
5842a27b 648 (Lisp_Object object, Lisp_Object printcharfun)
38010d50 649{
081e0581 650 PRINTDECLARE;
38010d50 651
10eebdbb 652 if (NILP (printcharfun))
38010d50
JB
653 printcharfun = Vstandard_output;
654 PRINTPREPARE;
3738a371 655 print (object, printcharfun, 0);
38010d50 656 PRINTFINISH;
3738a371 657 return object;
38010d50
JB
658}
659
a7ca3326 660DEFUN ("print", Fprint, Sprint, 1, 2, 0,
8c1a1077
PJ
661 doc: /* Output the printed representation of OBJECT, with newlines around it.
662Quoting characters are printed when needed to make output that `read'
9474c847 663can handle, whenever this is possible. For complex objects, the behavior
7fab9223 664is controlled by `print-level' and `print-length', which see.
8c1a1077
PJ
665
666OBJECT is any of the Lisp data types: a number, a string, a symbol,
667a list, a buffer, a window, a frame, etc.
668
669A printed representation of an object is text which describes that object.
670
671Optional argument PRINTCHARFUN is the output stream, which can be one
672of these:
673
674 - a buffer, in which case output is inserted into that buffer at point;
675 - a marker, in which case output is inserted at marker's position;
676 - a function, in which case that function is called once for each
677 character of OBJECT's printed representation;
678 - a symbol, in which case that symbol's function definition is called; or
679 - t, in which case the output is displayed in the echo area.
680
681If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
682is used instead. */)
5842a27b 683 (Lisp_Object object, Lisp_Object printcharfun)
38010d50 684{
081e0581 685 PRINTDECLARE;
38010d50
JB
686 struct gcpro gcpro1;
687
10eebdbb 688 if (NILP (printcharfun))
38010d50 689 printcharfun = Vstandard_output;
3738a371 690 GCPRO1 (object);
38010d50 691 PRINTPREPARE;
38010d50 692 PRINTCHAR ('\n');
3738a371 693 print (object, printcharfun, 1);
38010d50
JB
694 PRINTCHAR ('\n');
695 PRINTFINISH;
38010d50 696 UNGCPRO;
3738a371 697 return object;
38010d50
JB
698}
699
700/* The subroutine object for external-debugging-output is kept here
701 for the convenience of the debugger. */
702Lisp_Object Qexternal_debugging_output;
703
4746118a 704DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
8c1a1077
PJ
705 doc: /* Write CHARACTER to stderr.
706You can call print while debugging emacs, and pass it this function
707to make it write to the debugging output. */)
5842a27b 708 (Lisp_Object character)
38010d50 709{
9ef58a52 710 unsigned int ch;
cd22039d 711
9ef58a52
EZ
712 CHECK_NUMBER (character);
713 ch = XINT (character);
714 if (ASCII_CHAR_P (ch))
945b0111 715 {
9ef58a52
EZ
716 putc (ch, stderr);
717#ifdef WINDOWSNT
718 /* Send the output to a debugger (nothing happens if there isn't
719 one). */
720 if (print_output_debug_flag)
721 {
722 char buf[2] = {(char) XINT (character), '\0'};
723 OutputDebugString (buf);
724 }
725#endif
945b0111 726 }
9ef58a52
EZ
727 else
728 {
729 unsigned char mbstr[MAX_MULTIBYTE_LENGTH];
730 ptrdiff_t len = CHAR_STRING (ch, mbstr);
731 Lisp_Object encoded_ch =
34baf96c 732 ENCODE_SYSTEM (make_multibyte_string ((char *) mbstr, 1, len));
9ef58a52
EZ
733
734 fwrite (SSDATA (encoded_ch), SBYTES (encoded_ch), 1, stderr);
735#ifdef WINDOWSNT
736 if (print_output_debug_flag)
737 OutputDebugString (SSDATA (encoded_ch));
cd22039d 738#endif
9ef58a52 739 }
cd22039d 740
38010d50
JB
741 return character;
742}
cf1bb91b 743
c33f8948
RS
744/* This function is never called. Its purpose is to prevent
745 print_output_debug_flag from being optimized away. */
746
0bce5d9e 747extern void debug_output_compilation_hack (bool) EXTERNALLY_VISIBLE;
dae581bf 748void
0bce5d9e 749debug_output_compilation_hack (bool x)
c33f8948
RS
750{
751 print_output_debug_flag = x;
752}
6b61353c 753
cd3587c1 754#if defined (GNU_LINUX)
6b61353c
KH
755
756/* This functionality is not vitally important in general, so we rely on
757 non-portable ability to use stderr as lvalue. */
758
759#define WITH_REDIRECT_DEBUGGING_OUTPUT 1
760
ad64fc97 761static FILE *initial_stderr_stream = NULL;
6b61353c
KH
762
763DEFUN ("redirect-debugging-output", Fredirect_debugging_output, Sredirect_debugging_output,
764 1, 2,
765 "FDebug output file: \nP",
766 doc: /* Redirect debugging output (stderr stream) to file FILE.
767If FILE is nil, reset target to the initial stderr stream.
768Optional arg APPEND non-nil (interactively, with prefix arg) means
28b8f740 769append to existing target file. */)
5842a27b 770 (Lisp_Object file, Lisp_Object append)
6b61353c
KH
771{
772 if (initial_stderr_stream != NULL)
f9467be3 773 {
4d7e6e51 774 block_input ();
f9467be3 775 fclose (stderr);
4d7e6e51 776 unblock_input ();
f9467be3 777 }
6b61353c
KH
778 stderr = initial_stderr_stream;
779 initial_stderr_stream = NULL;
780
781 if (STRINGP (file))
782 {
783 file = Fexpand_file_name (file, Qnil);
784 initial_stderr_stream = stderr;
406af475 785 stderr = emacs_fopen (SSDATA (file), NILP (append) ? "w" : "a");
6b61353c
KH
786 if (stderr == NULL)
787 {
788 stderr = initial_stderr_stream;
789 initial_stderr_stream = NULL;
a9757f6a 790 report_file_error ("Cannot open debugging output stream", file);
6b61353c
KH
791 }
792 }
793 return Qnil;
794}
795#endif /* GNU_LINUX */
796
797
cf1bb91b
RS
798/* This is the interface for debugging printing. */
799
800void
971de7fb 801debug_print (Lisp_Object arg)
cf1bb91b
RS
802{
803 Fprin1 (arg, Qexternal_debugging_output);
3684eb78 804 fprintf (stderr, "\r\n");
cf1bb91b 805}
bd90dcd0 806
e3b27b31 807void safe_debug_print (Lisp_Object) EXTERNALLY_VISIBLE;
bd90dcd0 808void
971de7fb 809safe_debug_print (Lisp_Object arg)
bd90dcd0
KS
810{
811 int valid = valid_lisp_object_p (arg);
812
813 if (valid > 0)
814 debug_print (arg);
815 else
c2982e87 816 fprintf (stderr, "#<%s_LISP_OBJECT 0x%08"pI"x>\r\n",
bd90dcd0 817 !valid ? "INVALID" : "SOME",
61ddb1b9 818 XLI (arg));
bd90dcd0
KS
819}
820
38010d50 821\f
a7ca3326 822DEFUN ("error-message-string", Ferror_message_string, Serror_message_string,
113620cc 823 1, 1, 0,
6b61353c
KH
824 doc: /* Convert an error value (ERROR-SYMBOL . DATA) to an error message.
825See Info anchor `(elisp)Definition of signal' for some details on how this
826error message is constructed. */)
5842a27b 827 (Lisp_Object obj)
113620cc
KH
828{
829 struct buffer *old = current_buffer;
63fbf4ff 830 Lisp_Object value;
113620cc
KH
831 struct gcpro gcpro1;
832
0872e11f
RS
833 /* If OBJ is (error STRING), just return STRING.
834 That is not only faster, it also avoids the need to allocate
835 space here when the error is due to memory full. */
94b342ce
KR
836 if (CONSP (obj) && EQ (XCAR (obj), Qerror)
837 && CONSP (XCDR (obj))
838 && STRINGP (XCAR (XCDR (obj)))
839 && NILP (XCDR (XCDR (obj))))
840 return XCAR (XCDR (obj));
0872e11f 841
240e806c 842 print_error_message (obj, Vprin1_to_string_buffer, 0, Qnil);
113620cc
KH
843
844 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
845 value = Fbuffer_string ();
846
847 GCPRO1 (value);
848 Ferase_buffer ();
849 set_buffer_internal (old);
850 UNGCPRO;
851
852 return value;
853}
854
c02279de 855/* Print an error message for the error DATA onto Lisp output stream
7ab56fea
RS
856 STREAM (suitable for the print functions).
857 CONTEXT is a C string describing the context of the error.
858 CALLER is the Lisp function inside which the error was signaled. */
113620cc 859
dc22f25e 860void
a8fe7202
AS
861print_error_message (Lisp_Object data, Lisp_Object stream, const char *context,
862 Lisp_Object caller)
113620cc
KH
863{
864 Lisp_Object errname, errmsg, file_error, tail;
865 struct gcpro gcpro1;
113620cc 866
240e806c
RS
867 if (context != 0)
868 write_string_1 (context, -1, stream);
869
870 /* If we know from where the error was signaled, show it in
871 *Messages*. */
872 if (!NILP (caller) && SYMBOLP (caller))
873 {
11fb15d5 874 Lisp_Object cname = SYMBOL_NAME (caller);
98c6f1e3 875 ptrdiff_t cnamelen = SBYTES (cname);
d311d28c 876 USE_SAFE_ALLOCA;
98c6f1e3
PE
877 char *name = SAFE_ALLOCA (cnamelen);
878 memcpy (name, SDATA (cname), cnamelen);
879 message_dolog (name, cnamelen, 0, 0);
240e806c 880 message_dolog (": ", 2, 0, 0);
d311d28c 881 SAFE_FREE ();
240e806c
RS
882 }
883
113620cc
KH
884 errname = Fcar (data);
885
886 if (EQ (errname, Qerror))
887 {
888 data = Fcdr (data);
c02279de
GM
889 if (!CONSP (data))
890 data = Qnil;
113620cc
KH
891 errmsg = Fcar (data);
892 file_error = Qnil;
893 }
894 else
895 {
71873e2b 896 Lisp_Object error_conditions = Fget (errname, Qerror_conditions);
113620cc 897 errmsg = Fget (errname, Qerror_message);
c02279de 898 file_error = Fmemq (Qfile_error, error_conditions);
113620cc
KH
899 }
900
901 /* Print an error message including the data items. */
902
903 tail = Fcdr_safe (data);
904 GCPRO1 (tail);
905
906 /* For file-error, make error message by concatenating
907 all the data items. They are all strings. */
8c29413d 908 if (!NILP (file_error) && CONSP (tail))
94b342ce 909 errmsg = XCAR (tail), tail = XCDR (tail);
113620cc 910
71873e2b
SM
911 {
912 const char *sep = ": ";
913
914 if (!STRINGP (errmsg))
915 write_string_1 ("peculiar error", -1, stream);
916 else if (SCHARS (errmsg))
917 Fprinc (errmsg, stream);
918 else
919 sep = NULL;
920
921 for (; CONSP (tail); tail = XCDR (tail), sep = ", ")
922 {
923 Lisp_Object obj;
99027bdd 924
71873e2b
SM
925 if (sep)
926 write_string_1 (sep, 2, stream);
927 obj = XCAR (tail);
928 if (!NILP (file_error)
929 || EQ (errname, Qend_of_file) || EQ (errname, Quser_error))
930 Fprinc (obj, stream);
931 else
932 Fprin1 (obj, stream);
933 }
934 }
177c0ea7 935
113620cc
KH
936 UNGCPRO;
937}
38010d50 938
c02279de
GM
939
940\f
38010d50 941/*
edb2a707 942 * The buffer should be at least as large as the max string size of the
8e6208c5 943 * largest float, printed in the biggest notation. This is undoubtedly
38010d50
JB
944 * 20d float_output_format, with the negative of the C-constant "HUGE"
945 * from <math.h>.
177c0ea7 946 *
38010d50 947 * On the vax the worst case is -1e38 in 20d format which takes 61 bytes.
177c0ea7 948 *
38010d50
JB
949 * I assume that IEEE-754 format numbers can take 329 bytes for the worst
950 * case of -1e307 in 20d float_output_format. What is one to do (short of
951 * re-writing _doprnt to be more sane)?
952 * -wsr
6e8e6bf2 953 * Given the above, the buffer must be least FLOAT_TO_STRING_BUFSIZE bytes.
38010d50 954 */
edb2a707 955
99027bdd 956int
57ace6d0 957float_to_string (char *buf, double data)
38010d50 958{
57ace6d0 959 char *cp;
322890c4 960 int width;
99027bdd 961 int len;
177c0ea7 962
7f45de2d
RS
963 /* Check for plus infinity in a way that won't lose
964 if there is no plus infinity. */
965 if (data == data / 2 && data > 1.0)
966 {
99027bdd
PE
967 static char const infinity_string[] = "1.0e+INF";
968 strcpy (buf, infinity_string);
969 return sizeof infinity_string - 1;
7f45de2d
RS
970 }
971 /* Likewise for minus infinity. */
972 if (data == data / 2 && data < -1.0)
973 {
99027bdd
PE
974 static char const minus_infinity_string[] = "-1.0e+INF";
975 strcpy (buf, minus_infinity_string);
976 return sizeof minus_infinity_string - 1;
7f45de2d
RS
977 }
978 /* Check for NaN in a way that won't fail if there are no NaNs. */
979 if (! (data * 0.0 >= 0.0))
980 {
68c45bf0
PE
981 /* Prepend "-" if the NaN's sign bit is negative.
982 The sign bit of a double is the bit that is 1 in -0.0. */
99027bdd 983 static char const NaN_string[] = "0.0e+NaN";
68c45bf0
PE
984 int i;
985 union { double d; char c[sizeof (double)]; } u_data, u_minus_zero;
0bce5d9e 986 bool negative = 0;
68c45bf0
PE
987 u_data.d = data;
988 u_minus_zero.d = - 0.0;
989 for (i = 0; i < sizeof (double); i++)
990 if (u_data.c[i] & u_minus_zero.c[i])
991 {
99027bdd
PE
992 *buf = '-';
993 negative = 1;
68c45bf0
PE
994 break;
995 }
177c0ea7 996
99027bdd
PE
997 strcpy (buf + negative, NaN_string);
998 return negative + sizeof NaN_string - 1;
7f45de2d
RS
999 }
1000
10eebdbb 1001 if (NILP (Vfloat_output_format)
d4ae1f7e 1002 || !STRINGP (Vfloat_output_format))
38010d50 1003 lose:
322890c4 1004 {
f356c3fb 1005 /* Generate the fewest number of digits that represent the
6e8e6bf2 1006 floating point value without losing information. */
99027bdd 1007 len = dtoastr (buf, FLOAT_TO_STRING_BUFSIZE - 2, 0, 0, data);
75b43359
MWD
1008 /* The decimal point must be printed, or the byte compiler can
1009 get confused (Bug#8033). */
1010 width = 1;
322890c4 1011 }
38010d50
JB
1012 else /* oink oink */
1013 {
1014 /* Check that the spec we have is fully valid.
1015 This means not only valid for printf,
1016 but meant for floats, and reasonable. */
57ace6d0 1017 cp = SSDATA (Vfloat_output_format);
38010d50
JB
1018
1019 if (cp[0] != '%')
1020 goto lose;
1021 if (cp[1] != '.')
1022 goto lose;
1023
1024 cp += 2;
c7b14277
JB
1025
1026 /* Check the width specification. */
322890c4 1027 width = -1;
c7b14277 1028 if ('0' <= *cp && *cp <= '9')
381cd4bb
KH
1029 {
1030 width = 0;
1031 do
aca216ff
PE
1032 {
1033 width = (width * 10) + (*cp++ - '0');
1034 if (DBL_DIG < width)
1035 goto lose;
1036 }
381cd4bb
KH
1037 while (*cp >= '0' && *cp <= '9');
1038
1039 /* A precision of zero is valid only for %f. */
aca216ff 1040 if (width == 0 && *cp != 'f')
381cd4bb
KH
1041 goto lose;
1042 }
38010d50
JB
1043
1044 if (*cp != 'e' && *cp != 'f' && *cp != 'g')
1045 goto lose;
1046
38010d50
JB
1047 if (cp[1] != 0)
1048 goto lose;
1049
99027bdd 1050 len = sprintf (buf, SSDATA (Vfloat_output_format), data);
38010d50 1051 }
edb2a707 1052
c7b14277
JB
1053 /* Make sure there is a decimal point with digit after, or an
1054 exponent, so that the value is readable as a float. But don't do
322890c4
RS
1055 this with "%.0f"; it's valid for that not to produce a decimal
1056 point. Note that width can be 0 only for %.0f. */
1057 if (width != 0)
0601fd3d 1058 {
c7b14277
JB
1059 for (cp = buf; *cp; cp++)
1060 if ((*cp < '0' || *cp > '9') && *cp != '-')
1061 break;
0601fd3d 1062
c7b14277
JB
1063 if (*cp == '.' && cp[1] == 0)
1064 {
1065 cp[1] = '0';
1066 cp[2] = 0;
99027bdd 1067 len++;
c7b14277 1068 }
75b43359 1069 else if (*cp == 0)
c7b14277
JB
1070 {
1071 *cp++ = '.';
1072 *cp++ = '0';
1073 *cp++ = 0;
99027bdd 1074 len += 2;
c7b14277 1075 }
edb2a707 1076 }
99027bdd
PE
1077
1078 return len;
38010d50 1079}
cc94f3b2 1080
38010d50
JB
1081\f
1082static void
0bce5d9e 1083print (Lisp_Object obj, Lisp_Object printcharfun, bool escapeflag)
38010d50 1084{
a22dec27 1085 new_backquote_output = 0;
38010d50 1086
0f25ecc6
RS
1087 /* Reset print_number_index and Vprint_number_table only when
1088 the variable Vprint_continuous_numbering is nil. Otherwise,
1089 the values of these variables will be kept between several
1090 print functions. */
e026eb89
KS
1091 if (NILP (Vprint_continuous_numbering)
1092 || NILP (Vprint_number_table))
0f25ecc6
RS
1093 {
1094 print_number_index = 0;
1095 Vprint_number_table = Qnil;
1096 }
38010d50 1097
0f25ecc6
RS
1098 /* Construct Vprint_number_table for print-gensym and print-circle. */
1099 if (!NILP (Vprint_gensym) || !NILP (Vprint_circle))
ec838c39 1100 {
e6d4cddd
RS
1101 /* Construct Vprint_number_table.
1102 This increments print_number_index for the objects added. */
9a6a4c40 1103 print_depth = 0;
0f25ecc6 1104 print_preprocess (obj);
e6d4cddd 1105
a65b85b5
SM
1106 if (HASH_TABLE_P (Vprint_number_table))
1107 { /* Remove unnecessary objects, which appear only once in OBJ;
a179e3f7 1108 that is, whose status is Qt. */
a65b85b5 1109 struct Lisp_Hash_Table *h = XHASH_TABLE (Vprint_number_table);
d311d28c 1110 ptrdiff_t i;
e6d4cddd 1111
a65b85b5
SM
1112 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1113 if (!NILP (HASH_HASH (h, i))
1114 && EQ (HASH_VALUE (h, i), Qt))
1115 Fremhash (HASH_KEY (h, i), Vprint_number_table);
1116 }
0f25ecc6
RS
1117 }
1118
9a6a4c40 1119 print_depth = 0;
0f25ecc6
RS
1120 print_object (obj, printcharfun, escapeflag);
1121}
1122
fb103ca9
SM
1123#define PRINT_CIRCLE_CANDIDATE_P(obj) \
1124 (STRINGP (obj) || CONSP (obj) \
1125 || (VECTORLIKEP (obj) \
1126 && (VECTORP (obj) || COMPILEDP (obj) \
1127 || CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj) \
1128 || HASH_TABLE_P (obj) || FONTP (obj))) \
1129 || (! NILP (Vprint_gensym) \
1130 && SYMBOLP (obj) \
1131 && !SYMBOL_INTERNED_P (obj)))
1132
0f25ecc6
RS
1133/* Construct Vprint_number_table according to the structure of OBJ.
1134 OBJ itself and all its elements will be added to Vprint_number_table
1135 recursively if it is a list, vector, compiled function, char-table,
1136 string (its text properties will be traced), or a symbol that has
1137 no obarray (this is for the print-gensym feature).
1138 The status fields of Vprint_number_table mean whether each object appears
f224e500 1139 more than once in OBJ: Qnil at the first time, and Qt after that. */
0f25ecc6 1140static void
971de7fb 1141print_preprocess (Lisp_Object obj)
0f25ecc6 1142{
6b61353c 1143 int i;
d311d28c 1144 ptrdiff_t size;
c1132671
RS
1145 int loop_count = 0;
1146 Lisp_Object halftail;
1147
1148 /* Avoid infinite recursion for circular nested structure
1149 in the case where Vprint_circle is nil. */
1150 if (NILP (Vprint_circle))
1151 {
4ae29f89
SM
1152 /* Give up if we go so deep that print_object will get an error. */
1153 /* See similar code in print_object. */
1154 if (print_depth >= PRINT_CIRCLE)
1155 error ("Apparently circular structure being printed");
1156
c1132671
RS
1157 for (i = 0; i < print_depth; i++)
1158 if (EQ (obj, being_printed[i]))
1159 return;
1160 being_printed[print_depth] = obj;
1161 }
1162
c1132671
RS
1163 print_depth++;
1164 halftail = obj;
0f25ecc6
RS
1165
1166 loop:
fb103ca9 1167 if (PRINT_CIRCLE_CANDIDATE_P (obj))
0f25ecc6 1168 {
a65b85b5
SM
1169 if (!HASH_TABLE_P (Vprint_number_table))
1170 {
1171 Lisp_Object args[2];
1172 args[0] = QCtest;
1173 args[1] = Qeq;
1174 Vprint_number_table = Fmake_hash_table (2, args);
1175 }
1176
aca2020b
KH
1177 /* In case print-circle is nil and print-gensym is t,
1178 add OBJ to Vprint_number_table only when OBJ is a symbol. */
1179 if (! NILP (Vprint_circle) || SYMBOLP (obj))
0f25ecc6 1180 {
a65b85b5
SM
1181 Lisp_Object num = Fgethash (obj, Vprint_number_table, Qnil);
1182 if (!NILP (num)
1183 /* If Vprint_continuous_numbering is non-nil and OBJ is a gensym,
1184 always print the gensym with a number. This is a special for
1185 the lisp function byte-compile-output-docform. */
1186 || (!NILP (Vprint_continuous_numbering)
1187 && SYMBOLP (obj)
1188 && !SYMBOL_INTERNED_P (obj)))
1189 { /* OBJ appears more than once. Let's remember that. */
17870c01 1190 if (!INTEGERP (num))
aca2020b 1191 {
a65b85b5
SM
1192 print_number_index++;
1193 /* Negative number indicates it hasn't been printed yet. */
1194 Fputhash (obj, make_number (- print_number_index),
1195 Vprint_number_table);
aca2020b 1196 }
a65b85b5
SM
1197 print_depth--;
1198 return;
0f25ecc6 1199 }
a65b85b5
SM
1200 else
1201 /* OBJ is not yet recorded. Let's add to the table. */
1202 Fputhash (obj, Qt, Vprint_number_table);
0f25ecc6 1203 }
0f25ecc6 1204
8e50cc2d 1205 switch (XTYPE (obj))
0f25ecc6
RS
1206 {
1207 case Lisp_String:
0f25ecc6 1208 /* A string may have text properties, which can be circular. */
0c94c8d6 1209 traverse_intervals_noorder (string_intervals (obj),
8bbfc258 1210 print_preprocess_string, Qnil);
0f25ecc6
RS
1211 break;
1212
1213 case Lisp_Cons:
c1132671
RS
1214 /* Use HALFTAIL and LOOP_COUNT to detect circular lists,
1215 just as in print_object. */
1216 if (loop_count && EQ (obj, halftail))
1217 break;
0f25ecc6
RS
1218 print_preprocess (XCAR (obj));
1219 obj = XCDR (obj);
c1132671
RS
1220 loop_count++;
1221 if (!(loop_count & 1))
1222 halftail = XCDR (halftail);
0f25ecc6
RS
1223 goto loop;
1224
1225 case Lisp_Vectorlike:
77b37c05 1226 size = ASIZE (obj);
6b61353c
KH
1227 if (size & PSEUDOVECTOR_FLAG)
1228 size &= PSEUDOVECTOR_SIZE_MASK;
0f25ecc6 1229 for (i = 0; i < size; i++)
28be1ada 1230 print_preprocess (AREF (obj, i));
3e0de07f
SM
1231 if (HASH_TABLE_P (obj))
1232 { /* For hash tables, the key_and_value slot is past
a65b85b5
SM
1233 `size' because it needs to be marked specially in case
1234 the table is weak. */
3e0de07f
SM
1235 struct Lisp_Hash_Table *h = XHASH_TABLE (obj);
1236 print_preprocess (h->key_and_value);
1237 }
ee5263af
GM
1238 break;
1239
1240 default:
1241 break;
0f25ecc6
RS
1242 }
1243 }
c1132671 1244 print_depth--;
0f25ecc6
RS
1245}
1246
0f25ecc6 1247static void
971de7fb 1248print_preprocess_string (INTERVAL interval, Lisp_Object arg)
0f25ecc6
RS
1249{
1250 print_preprocess (interval->plist);
1251}
0f25ecc6 1252
971de7fb 1253static void print_check_string_charset_prop (INTERVAL interval, Lisp_Object string);
71ea13cb
KH
1254
1255#define PRINT_STRING_NON_CHARSET_FOUND 1
1256#define PRINT_STRING_UNSAFE_CHARSET_FOUND 2
1257
4ae29f89 1258/* Bitwise or of the above macros. */
71ea13cb
KH
1259static int print_check_string_result;
1260
1261static void
971de7fb 1262print_check_string_charset_prop (INTERVAL interval, Lisp_Object string)
71ea13cb
KH
1263{
1264 Lisp_Object val;
1265
1266 if (NILP (interval->plist)
1267 || (print_check_string_result == (PRINT_STRING_NON_CHARSET_FOUND
1268 | PRINT_STRING_UNSAFE_CHARSET_FOUND)))
1269 return;
1270 for (val = interval->plist; CONSP (val) && ! EQ (XCAR (val), Qcharset);
1271 val = XCDR (XCDR (val)));
1272 if (! CONSP (val))
1273 {
1274 print_check_string_result |= PRINT_STRING_NON_CHARSET_FOUND;
1275 return;
1276 }
1277 if (! (print_check_string_result & PRINT_STRING_NON_CHARSET_FOUND))
1278 {
1279 if (! EQ (val, interval->plist)
1280 || CONSP (XCDR (XCDR (val))))
1281 print_check_string_result |= PRINT_STRING_NON_CHARSET_FOUND;
1282 }
1283 if (NILP (Vprint_charset_text_property)
1284 || ! (print_check_string_result & PRINT_STRING_UNSAFE_CHARSET_FOUND))
1285 {
1286 int i, c;
d311d28c
PE
1287 ptrdiff_t charpos = interval->position;
1288 ptrdiff_t bytepos = string_char_to_byte (string, charpos);
71ea13cb
KH
1289 Lisp_Object charset;
1290
1291 charset = XCAR (XCDR (val));
1292 for (i = 0; i < LENGTH (interval); i++)
1293 {
1294 FETCH_STRING_CHAR_ADVANCE (c, string, charpos, bytepos);
c80bcdbc
KH
1295 if (! ASCII_CHAR_P (c)
1296 && ! EQ (CHARSET_NAME (CHAR_CHARSET (c)), charset))
71ea13cb
KH
1297 {
1298 print_check_string_result |= PRINT_STRING_UNSAFE_CHARSET_FOUND;
1299 break;
1300 }
1301 }
1302 }
1303}
1304
1305/* The value is (charset . nil). */
1306static Lisp_Object print_prune_charset_plist;
1307
1308static Lisp_Object
971de7fb 1309print_prune_string_charset (Lisp_Object string)
71ea13cb
KH
1310{
1311 print_check_string_result = 0;
0c94c8d6 1312 traverse_intervals (string_intervals (string), 0,
71ea13cb
KH
1313 print_check_string_charset_prop, string);
1314 if (! (print_check_string_result & PRINT_STRING_UNSAFE_CHARSET_FOUND))
1315 {
1316 string = Fcopy_sequence (string);
1317 if (print_check_string_result & PRINT_STRING_NON_CHARSET_FOUND)
1318 {
1319 if (NILP (print_prune_charset_plist))
6c6f1994 1320 print_prune_charset_plist = list1 (Qcharset);
eabe04c0
KH
1321 Fremove_text_properties (make_number (0),
1322 make_number (SCHARS (string)),
71ea13cb
KH
1323 print_prune_charset_plist, string);
1324 }
1325 else
eabe04c0
KH
1326 Fset_text_properties (make_number (0), make_number (SCHARS (string)),
1327 Qnil, string);
71ea13cb
KH
1328 }
1329 return string;
1330}
1331
0f25ecc6 1332static void
0bce5d9e 1333print_object (Lisp_Object obj, Lisp_Object printcharfun, bool escapeflag)
0f25ecc6 1334{
aca216ff
PE
1335 char buf[max (sizeof "from..to..in " + 2 * INT_STRLEN_BOUND (EMACS_INT),
1336 max (sizeof " . #" + INT_STRLEN_BOUND (printmax_t),
1337 40))];
0f25ecc6
RS
1338
1339 QUIT;
1340
1341 /* Detect circularities and truncate them. */
4ae29f89 1342 if (NILP (Vprint_circle))
0f25ecc6 1343 {
4ae29f89
SM
1344 /* Simple but incomplete way. */
1345 int i;
1346
1347 /* See similar code in print_preprocess. */
1348 if (print_depth >= PRINT_CIRCLE)
1349 error ("Apparently circular structure being printed");
1350
1351 for (i = 0; i < print_depth; i++)
1352 if (EQ (obj, being_printed[i]))
1353 {
99027bdd
PE
1354 int len = sprintf (buf, "#%d", i);
1355 strout (buf, len, len, printcharfun);
4ae29f89
SM
1356 return;
1357 }
1358 being_printed[print_depth] = obj;
1359 }
1360 else if (PRINT_CIRCLE_CANDIDATE_P (obj))
1361 {
1362 /* With the print-circle feature. */
1363 Lisp_Object num = Fgethash (obj, Vprint_number_table, Qnil);
1364 if (INTEGERP (num))
0f25ecc6 1365 {
4ae29f89
SM
1366 EMACS_INT n = XINT (num);
1367 if (n < 0)
1368 { /* Add a prefix #n= if OBJ has not yet been printed;
1369 that is, its status field is nil. */
99027bdd
PE
1370 int len = sprintf (buf, "#%"pI"d=", -n);
1371 strout (buf, len, len, printcharfun);
4ae29f89
SM
1372 /* OBJ is going to be printed. Remember that fact. */
1373 Fputhash (obj, make_number (- n), Vprint_number_table);
1374 }
1375 else
a65b85b5 1376 {
4ae29f89 1377 /* Just print #n# if OBJ has already been printed. */
99027bdd
PE
1378 int len = sprintf (buf, "#%"pI"d#", n);
1379 strout (buf, len, len, printcharfun);
4ae29f89 1380 return;
a65b85b5 1381 }
0f25ecc6 1382 }
ec838c39 1383 }
ec838c39 1384
38010d50
JB
1385 print_depth++;
1386
8e50cc2d 1387 switch (XTYPE (obj))
38010d50 1388 {
2de9f71c 1389 case_Lisp_Int:
99027bdd
PE
1390 {
1391 int len = sprintf (buf, "%"pI"d", XINT (obj));
1392 strout (buf, len, len, printcharfun);
1393 }
ca0569ad
RS
1394 break;
1395
ca0569ad
RS
1396 case Lisp_Float:
1397 {
6e8e6bf2 1398 char pigbuf[FLOAT_TO_STRING_BUFSIZE];
99027bdd
PE
1399 int len = float_to_string (pigbuf, XFLOAT_DATA (obj));
1400 strout (pigbuf, len, len, printcharfun);
ca0569ad
RS
1401 }
1402 break;
ca0569ad
RS
1403
1404 case Lisp_String:
38010d50
JB
1405 if (!escapeflag)
1406 print_string (obj, printcharfun);
1407 else
1408 {
198af6df 1409 register ptrdiff_t i, i_byte;
38010d50 1410 struct gcpro gcpro1;
d311d28c 1411 ptrdiff_t size_byte;
453fa987
RS
1412 /* 1 means we must ensure that the next character we output
1413 cannot be taken as part of a hex character escape. */
0bce5d9e 1414 bool need_nonhex = 0;
0063fdb1 1415 bool multibyte = STRING_MULTIBYTE (obj);
38010d50 1416
7651e1f5
RS
1417 GCPRO1 (obj);
1418
71ea13cb
KH
1419 if (! EQ (Vprint_charset_text_property, Qt))
1420 obj = print_prune_string_charset (obj);
1421
0c94c8d6 1422 if (string_intervals (obj))
7651e1f5
RS
1423 {
1424 PRINTCHAR ('#');
1425 PRINTCHAR ('(');
1426 }
38010d50
JB
1427
1428 PRINTCHAR ('\"');
d5db4077 1429 size_byte = SBYTES (obj);
dc2a0b79 1430
198af6df 1431 for (i = 0, i_byte = 0; i_byte < size_byte;)
38010d50 1432 {
6ddd6eee
RS
1433 /* Here, we must convert each multi-byte form to the
1434 corresponding character code before handing it to PRINTCHAR. */
dc2a0b79
RS
1435 int c;
1436
198af6df 1437 FETCH_STRING_CHAR_ADVANCE (c, obj, i, i_byte);
dc2a0b79 1438
38010d50 1439 QUIT;
6ddd6eee 1440
38010d50
JB
1441 if (c == '\n' && print_escape_newlines)
1442 {
1443 PRINTCHAR ('\\');
1444 PRINTCHAR ('n');
1445 }
c6f7982f
RM
1446 else if (c == '\f' && print_escape_newlines)
1447 {
1448 PRINTCHAR ('\\');
1449 PRINTCHAR ('f');
1450 }
ae7367d3 1451 else if (multibyte
42a5b22f 1452 && (CHAR_BYTE8_P (c)
73af357a 1453 || (! ASCII_CHAR_P (c) && print_escape_multibyte)))
dc2a0b79
RS
1454 {
1455 /* When multibyte is disabled,
ae7367d3
RS
1456 print multibyte string chars using hex escapes.
1457 For a char code that could be in a unibyte string,
1458 when found in a multibyte string, always use a hex escape
1459 so it reads back as multibyte. */
09125ef8 1460 char outbuf[50];
99027bdd 1461 int len;
8b4b4467
KH
1462
1463 if (CHAR_BYTE8_P (c))
99027bdd 1464 len = sprintf (outbuf, "\\%03o", CHAR_TO_BYTE8 (c));
8b4b4467 1465 else
8f924df7 1466 {
99027bdd 1467 len = sprintf (outbuf, "\\x%04x", c);
8f924df7
KH
1468 need_nonhex = 1;
1469 }
99027bdd 1470 strout (outbuf, len, len, printcharfun);
dc2a0b79 1471 }
db300f59 1472 else if (! multibyte
200fc949 1473 && SINGLE_BYTE_CHAR_P (c) && ! ASCII_CHAR_P (c)
835d0be6 1474 && print_escape_nonascii)
974a6ff5 1475 {
835d0be6
RS
1476 /* When printing in a multibyte buffer
1477 or when explicitly requested,
974a6ff5
KH
1478 print single-byte non-ASCII string chars
1479 using octal escapes. */
09125ef8 1480 char outbuf[5];
99027bdd
PE
1481 int len = sprintf (outbuf, "\\%03o", c);
1482 strout (outbuf, len, len, printcharfun);
974a6ff5 1483 }
38010d50
JB
1484 else
1485 {
453fa987
RS
1486 /* If we just had a hex escape, and this character
1487 could be taken as part of it,
1488 output `\ ' to prevent that. */
1b62edd6
KH
1489 if (need_nonhex)
1490 {
1491 need_nonhex = 0;
1492 if ((c >= 'a' && c <= 'f')
453fa987 1493 || (c >= 'A' && c <= 'F')
1b62edd6 1494 || (c >= '0' && c <= '9'))
1db5b1ad 1495 strout ("\\ ", -1, -1, printcharfun);
1b62edd6 1496 }
453fa987 1497
38010d50
JB
1498 if (c == '\"' || c == '\\')
1499 PRINTCHAR ('\\');
1500 PRINTCHAR (c);
1501 }
1502 }
1503 PRINTCHAR ('\"');
7651e1f5 1504
0c94c8d6 1505 if (string_intervals (obj))
7651e1f5 1506 {
0c94c8d6 1507 traverse_intervals (string_intervals (obj),
8bbfc258 1508 0, print_interval, printcharfun);
7651e1f5
RS
1509 PRINTCHAR (')');
1510 }
7651e1f5 1511
38010d50
JB
1512 UNGCPRO;
1513 }
ca0569ad 1514 break;
38010d50 1515
ca0569ad
RS
1516 case Lisp_Symbol:
1517 {
0bce5d9e
PE
1518 bool confusing;
1519 unsigned char *p = SDATA (SYMBOL_NAME (obj));
1520 unsigned char *end = p + SBYTES (SYMBOL_NAME (obj));
1521 int c;
d311d28c
PE
1522 ptrdiff_t i, i_byte;
1523 ptrdiff_t size_byte;
dc2a0b79
RS
1524 Lisp_Object name;
1525
76d0b3ae 1526 name = SYMBOL_NAME (obj);
ca0569ad
RS
1527
1528 if (p != end && (*p == '-' || *p == '+')) p++;
1529 if (p == end)
1530 confusing = 0;
d27497e3
RS
1531 /* If symbol name begins with a digit, and ends with a digit,
1532 and contains nothing but digits and `e', it could be treated
1533 as a number. So set CONFUSING.
1534
1535 Symbols that contain periods could also be taken as numbers,
1536 but periods are always escaped, so we don't have to worry
1537 about them here. */
1538 else if (*p >= '0' && *p <= '9'
1539 && end[-1] >= '0' && end[-1] <= '9')
ca0569ad 1540 {
e837058b
RS
1541 while (p != end && ((*p >= '0' && *p <= '9')
1542 /* Needed for \2e10. */
01a8d3fa 1543 || *p == 'e' || *p == 'E'))
ca0569ad
RS
1544 p++;
1545 confusing = (end == p);
1546 }
d27497e3
RS
1547 else
1548 confusing = 0;
ca0569ad 1549
9a79b20c
AS
1550 size_byte = SBYTES (name);
1551
bf9f2aab 1552 if (! NILP (Vprint_gensym) && !SYMBOL_INTERNED_P (obj))
081e0581 1553 {
081e0581
EN
1554 PRINTCHAR ('#');
1555 PRINTCHAR (':');
1556 }
9a79b20c
AS
1557 else if (size_byte == 0)
1558 {
1559 PRINTCHAR ('#');
1560 PRINTCHAR ('#');
1561 break;
1562 }
dc2a0b79
RS
1563
1564 for (i = 0, i_byte = 0; i_byte < size_byte;)
ca0569ad 1565 {
6ddd6eee
RS
1566 /* Here, we must convert each multi-byte form to the
1567 corresponding character code before handing it to PRINTCHAR. */
eba90784 1568 FETCH_STRING_CHAR_ADVANCE (c, name, i, i_byte);
ca0569ad 1569 QUIT;
09eddb56 1570
ca0569ad
RS
1571 if (escapeflag)
1572 {
09eddb56
RS
1573 if (c == '\"' || c == '\\' || c == '\''
1574 || c == ';' || c == '#' || c == '(' || c == ')'
9a79b20c 1575 || c == ',' || c == '.' || c == '`'
09eddb56
RS
1576 || c == '[' || c == ']' || c == '?' || c <= 040
1577 || confusing)
ca0569ad
RS
1578 PRINTCHAR ('\\'), confusing = 0;
1579 }
1580 PRINTCHAR (c);
1581 }
1582 }
1583 break;
1584
1585 case Lisp_Cons:
38010d50 1586 /* If deeper than spec'd depth, print placeholder. */
d4ae1f7e 1587 if (INTEGERP (Vprint_level)
38010d50 1588 && print_depth > XINT (Vprint_level))
1db5b1ad 1589 strout ("...", -1, -1, printcharfun);
2f100b5c
EN
1590 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1591 && (EQ (XCAR (obj), Qquote)))
1592 {
1593 PRINTCHAR ('\'');
0f25ecc6 1594 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
2f100b5c
EN
1595 }
1596 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1597 && (EQ (XCAR (obj), Qfunction)))
1598 {
1599 PRINTCHAR ('#');
1600 PRINTCHAR ('\'');
0f25ecc6 1601 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
2f100b5c
EN
1602 }
1603 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
a22dec27
SM
1604 && ((EQ (XCAR (obj), Qbackquote))))
1605 {
1606 print_object (XCAR (obj), printcharfun, 0);
1607 new_backquote_output++;
1608 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1609 new_backquote_output--;
1610 }
1611 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1612 && new_backquote_output
2f100b5c
EN
1613 && ((EQ (XCAR (obj), Qbackquote)
1614 || EQ (XCAR (obj), Qcomma)
1615 || EQ (XCAR (obj), Qcomma_at)
1616 || EQ (XCAR (obj), Qcomma_dot))))
1617 {
0f25ecc6 1618 print_object (XCAR (obj), printcharfun, 0);
a22dec27 1619 new_backquote_output--;
0f25ecc6 1620 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
a22dec27 1621 new_backquote_output++;
2f100b5c 1622 }
e0f93814 1623 else
38010d50 1624 {
e0f93814 1625 PRINTCHAR ('(');
177c0ea7 1626
38010d50 1627 {
aca216ff 1628 printmax_t i, print_length;
1eab22b5 1629 Lisp_Object halftail = obj;
e0f93814 1630
9ab8560d 1631 /* Negative values of print-length are invalid in CL.
42ac1ed4
GM
1632 Treat them like nil, as CMUCL does. */
1633 if (NATNUMP (Vprint_length))
1634 print_length = XFASTINT (Vprint_length);
1635 else
aca216ff 1636 print_length = TYPE_MAXIMUM (printmax_t);
42ac1ed4
GM
1637
1638 i = 0;
e0f93814 1639 while (CONSP (obj))
38010d50 1640 {
1eab22b5 1641 /* Detect circular list. */
0f25ecc6 1642 if (NILP (Vprint_circle))
1eab22b5 1643 {
53964682 1644 /* Simple but incomplete way. */
0f25ecc6
RS
1645 if (i != 0 && EQ (obj, halftail))
1646 {
99027bdd
PE
1647 int len = sprintf (buf, " . #%"pMd, i / 2);
1648 strout (buf, len, len, printcharfun);
0f25ecc6
RS
1649 goto end_of_list;
1650 }
1651 }
1652 else
1653 {
1654 /* With the print-circle feature. */
1655 if (i != 0)
1656 {
a65b85b5
SM
1657 Lisp_Object num = Fgethash (obj, Vprint_number_table, Qnil);
1658 if (INTEGERP (num))
36de6a04 1659 {
1db5b1ad 1660 strout (" . ", 3, 3, printcharfun);
36de6a04
AS
1661 print_object (obj, printcharfun, escapeflag);
1662 goto end_of_list;
1663 }
0f25ecc6 1664 }
1eab22b5 1665 }
177c0ea7 1666
aca216ff 1667 if (i)
e0f93814 1668 PRINTCHAR (' ');
177c0ea7 1669
aca216ff 1670 if (print_length <= i)
e0f93814 1671 {
1db5b1ad 1672 strout ("...", 3, 3, printcharfun);
0f25ecc6 1673 goto end_of_list;
e0f93814 1674 }
177c0ea7 1675
aca216ff 1676 i++;
0f25ecc6 1677 print_object (XCAR (obj), printcharfun, escapeflag);
177c0ea7 1678
2f100b5c 1679 obj = XCDR (obj);
1eab22b5
RS
1680 if (!(i & 1))
1681 halftail = XCDR (halftail);
38010d50 1682 }
38010d50 1683 }
42ac1ed4
GM
1684
1685 /* OBJ non-nil here means it's the end of a dotted list. */
2f100b5c 1686 if (!NILP (obj))
e0f93814 1687 {
1db5b1ad 1688 strout (" . ", 3, 3, printcharfun);
0f25ecc6 1689 print_object (obj, printcharfun, escapeflag);
e0f93814 1690 }
177c0ea7 1691
0f25ecc6 1692 end_of_list:
e0f93814 1693 PRINTCHAR (')');
38010d50 1694 }
ca0569ad
RS
1695 break;
1696
1697 case Lisp_Vectorlike:
1698 if (PROCESSP (obj))
1699 {
1700 if (escapeflag)
1701 {
1db5b1ad 1702 strout ("#<process ", -1, -1, printcharfun);
4d2b044c 1703 print_string (XPROCESS (obj)->name, printcharfun);
ca0569ad
RS
1704 PRINTCHAR ('>');
1705 }
1706 else
4d2b044c 1707 print_string (XPROCESS (obj)->name, printcharfun);
ca0569ad 1708 }
ed2c35ef
RS
1709 else if (BOOL_VECTOR_P (obj))
1710 {
29ebea3b 1711 ptrdiff_t i;
99027bdd
PE
1712 int len;
1713 unsigned char c;
ed2c35ef 1714 struct gcpro gcpro1;
1c0a7493 1715 EMACS_INT size = bool_vector_size (obj);
2cf00efc 1716 ptrdiff_t size_in_chars = bool_vector_bytes (size);
5e15c624 1717 ptrdiff_t real_size_in_chars = size_in_chars;
ed2c35ef
RS
1718 GCPRO1 (obj);
1719
1720 PRINTCHAR ('#');
1721 PRINTCHAR ('&');
1c0a7493 1722 len = sprintf (buf, "%"pI"d", size);
99027bdd 1723 strout (buf, len, len, printcharfun);
ed2c35ef 1724 PRINTCHAR ('\"');
a40384bc 1725
42ac1ed4 1726 /* Don't print more characters than the specified maximum.
9ab8560d 1727 Negative values of print-length are invalid. Treat them
42ac1ed4
GM
1728 like a print-length of nil. */
1729 if (NATNUMP (Vprint_length)
1730 && XFASTINT (Vprint_length) < size_in_chars)
1731 size_in_chars = XFASTINT (Vprint_length);
a40384bc 1732
ed2c35ef
RS
1733 for (i = 0; i < size_in_chars; i++)
1734 {
1735 QUIT;
df5b4930 1736 c = bool_vector_uchar_data (obj)[i];
f10fdbfd 1737 if (c == '\n' && print_escape_newlines)
ed2c35ef
RS
1738 {
1739 PRINTCHAR ('\\');
1740 PRINTCHAR ('n');
1741 }
1742 else if (c == '\f' && print_escape_newlines)
1743 {
1744 PRINTCHAR ('\\');
1745 PRINTCHAR ('f');
1746 }
4b5af5e4
AS
1747 else if (c > '\177')
1748 {
1749 /* Use octal escapes to avoid encoding issues. */
1750 PRINTCHAR ('\\');
1751 PRINTCHAR ('0' + ((c >> 6) & 3));
1752 PRINTCHAR ('0' + ((c >> 3) & 7));
1753 PRINTCHAR ('0' + (c & 7));
1754 }
ed2c35ef
RS
1755 else
1756 {
1757 if (c == '\"' || c == '\\')
1758 PRINTCHAR ('\\');
1759 PRINTCHAR (c);
1760 }
1761 }
5e15c624
PE
1762
1763 if (size_in_chars < real_size_in_chars)
1764 strout (" ...", 4, 4, printcharfun);
ed2c35ef
RS
1765 PRINTCHAR ('\"');
1766
1767 UNGCPRO;
1768 }
ca0569ad
RS
1769 else if (SUBRP (obj))
1770 {
1db5b1ad
JB
1771 strout ("#<subr ", -1, -1, printcharfun);
1772 strout (XSUBR (obj)->symbol_name, -1, -1, printcharfun);
ca0569ad
RS
1773 PRINTCHAR ('>');
1774 }
ca0569ad
RS
1775 else if (WINDOWP (obj))
1776 {
880e6158
MR
1777 int len;
1778 strout ("#<window ", -1, -1, printcharfun);
1779 len = sprintf (buf, "%d", XWINDOW (obj)->sequence_number);
99027bdd 1780 strout (buf, len, len, printcharfun);
e74aeda8 1781 if (BUFFERP (XWINDOW (obj)->contents))
ca0569ad 1782 {
1db5b1ad 1783 strout (" on ", -1, -1, printcharfun);
e74aeda8 1784 print_string (BVAR (XBUFFER (XWINDOW (obj)->contents), name),
3a45383a 1785 printcharfun);
ca0569ad
RS
1786 }
1787 PRINTCHAR ('>');
1788 }
f76c8b1e
SM
1789 else if (TERMINALP (obj))
1790 {
99027bdd 1791 int len;
f76c8b1e 1792 struct terminal *t = XTERMINAL (obj);
1db5b1ad 1793 strout ("#<terminal ", -1, -1, printcharfun);
99027bdd
PE
1794 len = sprintf (buf, "%d", t->id);
1795 strout (buf, len, len, printcharfun);
f76c8b1e
SM
1796 if (t->name)
1797 {
1db5b1ad
JB
1798 strout (" on ", -1, -1, printcharfun);
1799 strout (t->name, -1, -1, printcharfun);
f76c8b1e
SM
1800 }
1801 PRINTCHAR ('>');
1802 }
7eb03302
GM
1803 else if (HASH_TABLE_P (obj))
1804 {
1805 struct Lisp_Hash_Table *h = XHASH_TABLE (obj);
d311d28c
PE
1806 ptrdiff_t i;
1807 ptrdiff_t real_size, size;
99027bdd 1808 int len;
f19a0f5b 1809#if 0
29abe551 1810 void *ptr = h;
1db5b1ad 1811 strout ("#<hash-table", -1, -1, printcharfun);
7eb03302
GM
1812 if (SYMBOLP (h->test))
1813 {
1814 PRINTCHAR (' ');
1815 PRINTCHAR ('\'');
1db5b1ad 1816 strout (SDATA (SYMBOL_NAME (h->test)), -1, -1, printcharfun);
7eb03302 1817 PRINTCHAR (' ');
1db5b1ad 1818 strout (SDATA (SYMBOL_NAME (h->weak)), -1, -1, printcharfun);
7eb03302 1819 PRINTCHAR (' ');
99027bdd
PE
1820 len = sprintf (buf, "%"pD"d/%"pD"d", h->count, ASIZE (h->next));
1821 strout (buf, len, len, printcharfun);
7eb03302 1822 }
29abe551 1823 len = sprintf (buf, " %p>", ptr);
99027bdd 1824 strout (buf, len, len, printcharfun);
f19a0f5b
TZ
1825#endif
1826 /* Implement a readable output, e.g.:
1827 #s(hash-table size 2 test equal data (k1 v1 k2 v2)) */
b7432bb2 1828 /* Always print the size. */
99027bdd
PE
1829 len = sprintf (buf, "#s(hash-table size %"pD"d", ASIZE (h->next));
1830 strout (buf, len, len, printcharfun);
f19a0f5b 1831
b7432bb2 1832 if (!NILP (h->test.name))
f19a0f5b 1833 {
1db5b1ad 1834 strout (" test ", -1, -1, printcharfun);
b7432bb2 1835 print_object (h->test.name, printcharfun, escapeflag);
f19a0f5b
TZ
1836 }
1837
1838 if (!NILP (h->weak))
1839 {
1db5b1ad 1840 strout (" weakness ", -1, -1, printcharfun);
617a0e83 1841 print_object (h->weak, printcharfun, escapeflag);
f19a0f5b
TZ
1842 }
1843
1844 if (!NILP (h->rehash_size))
1845 {
1db5b1ad 1846 strout (" rehash-size ", -1, -1, printcharfun);
617a0e83 1847 print_object (h->rehash_size, printcharfun, escapeflag);
f19a0f5b
TZ
1848 }
1849
1850 if (!NILP (h->rehash_threshold))
1851 {
1db5b1ad 1852 strout (" rehash-threshold ", -1, -1, printcharfun);
617a0e83 1853 print_object (h->rehash_threshold, printcharfun, escapeflag);
f19a0f5b
TZ
1854 }
1855
1db5b1ad 1856 strout (" data ", -1, -1, printcharfun);
f19a0f5b
TZ
1857
1858 /* Print the data here as a plist. */
b0ca0f33
DN
1859 real_size = HASH_TABLE_SIZE (h);
1860 size = real_size;
f19a0f5b
TZ
1861
1862 /* Don't print more elements than the specified maximum. */
1863 if (NATNUMP (Vprint_length)
1864 && XFASTINT (Vprint_length) < size)
1865 size = XFASTINT (Vprint_length);
42a5b22f 1866
f19a0f5b
TZ
1867 PRINTCHAR ('(');
1868 for (i = 0; i < size; i++)
1869 if (!NILP (HASH_HASH (h, i)))
1870 {
1871 if (i) PRINTCHAR (' ');
617a0e83 1872 print_object (HASH_KEY (h, i), printcharfun, escapeflag);
f19a0f5b 1873 PRINTCHAR (' ');
617a0e83 1874 print_object (HASH_VALUE (h, i), printcharfun, escapeflag);
f19a0f5b
TZ
1875 }
1876
1877 if (size < real_size)
1db5b1ad 1878 strout (" ...", 4, 4, printcharfun);
f19a0f5b
TZ
1879
1880 PRINTCHAR (')');
1881 PRINTCHAR (')');
1882
7eb03302 1883 }
908b0ae5
RS
1884 else if (BUFFERP (obj))
1885 {
e578f381 1886 if (!BUFFER_LIVE_P (XBUFFER (obj)))
1db5b1ad 1887 strout ("#<killed buffer>", -1, -1, printcharfun);
908b0ae5
RS
1888 else if (escapeflag)
1889 {
1db5b1ad 1890 strout ("#<buffer ", -1, -1, printcharfun);
4b4deea2 1891 print_string (BVAR (XBUFFER (obj), name), printcharfun);
908b0ae5
RS
1892 PRINTCHAR ('>');
1893 }
1894 else
4b4deea2 1895 print_string (BVAR (XBUFFER (obj), name), printcharfun);
908b0ae5 1896 }
ca0569ad
RS
1897 else if (WINDOW_CONFIGURATIONP (obj))
1898 {
1db5b1ad 1899 strout ("#<window-configuration>", -1, -1, printcharfun);
ca0569ad 1900 }
ca0569ad
RS
1901 else if (FRAMEP (obj))
1902 {
99027bdd 1903 int len;
29abe551 1904 void *ptr = XFRAME (obj);
e69b0960 1905 Lisp_Object frame_name = XFRAME (obj)->name;
436bc8e0 1906
ca0569ad
RS
1907 strout ((FRAME_LIVE_P (XFRAME (obj))
1908 ? "#<frame " : "#<dead frame "),
1db5b1ad 1909 -1, -1, printcharfun);
436bc8e0
EZ
1910 if (!STRINGP (frame_name))
1911 {
1912 /* A frame could be too young and have no name yet;
1913 don't crash. */
1914 if (SYMBOLP (frame_name))
1915 frame_name = Fsymbol_name (frame_name);
1916 else /* can't happen: name should be either nil or string */
1917 frame_name = build_string ("*INVALID*FRAME*NAME*");
1918 }
1919 print_string (frame_name, printcharfun);
29abe551 1920 len = sprintf (buf, " %p>", ptr);
99027bdd 1921 strout (buf, len, len, printcharfun);
ca0569ad 1922 }
2a7b7982
KH
1923 else if (FONTP (obj))
1924 {
d311d28c 1925 int i;
2a7b7982
KH
1926
1927 if (! FONT_OBJECT_P (obj))
1928 {
1929 if (FONT_SPEC_P (obj))
1db5b1ad 1930 strout ("#<font-spec", -1, -1, printcharfun);
2a7b7982 1931 else
1db5b1ad 1932 strout ("#<font-entity", -1, -1, printcharfun);
2a7b7982
KH
1933 for (i = 0; i < FONT_SPEC_MAX; i++)
1934 {
1935 PRINTCHAR (' ');
1936 if (i < FONT_WEIGHT_INDEX || i > FONT_WIDTH_INDEX)
1937 print_object (AREF (obj, i), printcharfun, escapeflag);
1938 else
1939 print_object (font_style_symbolic (obj, i, 0),
1940 printcharfun, escapeflag);
1941 }
1942 }
1943 else
1944 {
1db5b1ad 1945 strout ("#<font-object ", -1, -1, printcharfun);
2a7b7982
KH
1946 print_object (AREF (obj, FONT_NAME_INDEX), printcharfun,
1947 escapeflag);
1948 }
1949 PRINTCHAR ('>');
1950 }
ca0569ad
RS
1951 else
1952 {
d311d28c 1953 ptrdiff_t size = ASIZE (obj);
ca0569ad
RS
1954 if (COMPILEDP (obj))
1955 {
1956 PRINTCHAR ('#');
1957 size &= PSEUDOVECTOR_SIZE_MASK;
1958 }
8b4b4467 1959 if (CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj))
ed2c35ef
RS
1960 {
1961 /* We print a char-table as if it were a vector,
1962 lumping the parent and default slots in with the
1963 character slots. But we add #^ as a prefix. */
223509a3
KH
1964
1965 /* Make each lowest sub_char_table start a new line.
1966 Otherwise we'll make a line extremely long, which
1967 results in slow redisplay. */
1968 if (SUB_CHAR_TABLE_P (obj)
1969 && XINT (XSUB_CHAR_TABLE (obj)->depth) == 3)
1970 PRINTCHAR ('\n');
ed2c35ef
RS
1971 PRINTCHAR ('#');
1972 PRINTCHAR ('^');
3701b5de
KH
1973 if (SUB_CHAR_TABLE_P (obj))
1974 PRINTCHAR ('^');
ed2c35ef
RS
1975 size &= PSEUDOVECTOR_SIZE_MASK;
1976 }
00d76abc
KH
1977 if (size & PSEUDOVECTOR_FLAG)
1978 goto badtype;
ca0569ad
RS
1979
1980 PRINTCHAR ('[');
38010d50 1981 {
ca0569ad
RS
1982 register int i;
1983 register Lisp_Object tem;
d311d28c 1984 ptrdiff_t real_size = size;
a40384bc
RS
1985
1986 /* Don't print more elements than the specified maximum. */
42ac1ed4
GM
1987 if (NATNUMP (Vprint_length)
1988 && XFASTINT (Vprint_length) < size)
1989 size = XFASTINT (Vprint_length);
a40384bc 1990
ca0569ad
RS
1991 for (i = 0; i < size; i++)
1992 {
1993 if (i) PRINTCHAR (' ');
28be1ada 1994 tem = AREF (obj, i);
0f25ecc6 1995 print_object (tem, printcharfun, escapeflag);
ca0569ad 1996 }
d6ac884e 1997 if (size < real_size)
1db5b1ad 1998 strout (" ...", 4, 4, printcharfun);
38010d50 1999 }
ca0569ad
RS
2000 PRINTCHAR (']');
2001 }
2002 break;
2003
ca0569ad 2004 case Lisp_Misc:
5db20f08 2005 switch (XMISCTYPE (obj))
38010d50 2006 {
00d76abc 2007 case Lisp_Misc_Marker:
1db5b1ad 2008 strout ("#<marker ", -1, -1, printcharfun);
087e3c46
KH
2009 /* Do you think this is necessary? */
2010 if (XMARKER (obj)->insertion_type != 0)
1db5b1ad 2011 strout ("(moves after insertion) ", -1, -1, printcharfun);
cd3587c1 2012 if (! XMARKER (obj)->buffer)
1db5b1ad 2013 strout ("in no buffer", -1, -1, printcharfun);
ca0569ad
RS
2014 else
2015 {
99027bdd
PE
2016 int len = sprintf (buf, "at %"pD"d", marker_position (obj));
2017 strout (buf, len, len, printcharfun);
1db5b1ad 2018 strout (" in ", -1, -1, printcharfun);
4b4deea2 2019 print_string (BVAR (XMARKER (obj)->buffer, name), printcharfun);
ca0569ad 2020 }
38010d50 2021 PRINTCHAR ('>');
908b0ae5 2022 break;
00d76abc
KH
2023
2024 case Lisp_Misc_Overlay:
1db5b1ad 2025 strout ("#<overlay ", -1, -1, printcharfun);
cd3587c1 2026 if (! XMARKER (OVERLAY_START (obj))->buffer)
1db5b1ad 2027 strout ("in no buffer", -1, -1, printcharfun);
ca0569ad
RS
2028 else
2029 {
99027bdd
PE
2030 int len = sprintf (buf, "from %"pD"d to %"pD"d in ",
2031 marker_position (OVERLAY_START (obj)),
2032 marker_position (OVERLAY_END (obj)));
2033 strout (buf, len, len, printcharfun);
4b4deea2 2034 print_string (BVAR (XMARKER (OVERLAY_START (obj))->buffer, name),
ca0569ad
RS
2035 printcharfun);
2036 }
2037 PRINTCHAR ('>');
908b0ae5 2038 break;
00d76abc 2039
73ebd38f
DA
2040 /* Remaining cases shouldn't happen in normal usage, but let's
2041 print them anyway for the benefit of the debugger. */
2042
00d76abc 2043 case Lisp_Misc_Free:
1db5b1ad 2044 strout ("#<misc free cell>", -1, -1, printcharfun);
00d76abc
KH
2045 break;
2046
c069fee4 2047 case Lisp_Misc_Save_Value:
99027bdd 2048 {
6cda572a
DA
2049 int i;
2050 struct Lisp_Save_Value *v = XSAVE_VALUE (obj);
2051
2052 strout ("#<save-value ", -1, -1, printcharfun);
73ebd38f 2053
7b1123d8 2054 if (v->save_type == SAVE_TYPE_MEMORY)
6cda572a 2055 {
73ebd38f
DA
2056 ptrdiff_t amount = v->data[1].integer;
2057
2058#if GC_MARK_STACK
2059
7b1123d8
PE
2060 /* valid_lisp_object_p is reliable, so try to print up
2061 to 8 saved objects. This code is rarely used, so
2062 it's OK that valid_lisp_object_p is slow. */
6cda572a 2063
73ebd38f 2064 int limit = min (amount, 8);
c50cf2ea 2065 Lisp_Object *area = v->data[0].pointer;
73ebd38f
DA
2066
2067 i = sprintf (buf, "with %"pD"d objects", amount);
6cda572a
DA
2068 strout (buf, i, i, printcharfun);
2069
73ebd38f 2070 for (i = 0; i < limit; i++)
6cda572a 2071 {
73ebd38f 2072 Lisp_Object maybe = area[i];
6cda572a 2073
8855dfa5 2074 if (valid_lisp_object_p (maybe) > 0)
6cda572a
DA
2075 {
2076 PRINTCHAR (' ');
2077 print_object (maybe, printcharfun, escapeflag);
2078 }
2079 else
2080 strout (" <invalid>", -1, -1, printcharfun);
2081 }
73ebd38f 2082 if (i == limit && i < amount)
6cda572a 2083 strout (" ...", 4, 4, printcharfun);
73ebd38f
DA
2084
2085#else /* not GC_MARK_STACK */
2086
7b1123d8
PE
2087 /* There is no reliable way to determine whether the objects
2088 are initialized, so do not try to print them. */
73ebd38f
DA
2089
2090 i = sprintf (buf, "with %"pD"d objects", amount);
2091 strout (buf, i, i, printcharfun);
2092
2093#endif /* GC_MARK_STACK */
6cda572a
DA
2094 }
2095 else
2096 {
7b1123d8
PE
2097 /* Print each slot according to its type. */
2098 int index;
2099 for (index = 0; index < SAVE_VALUE_SLOTS; index++)
2100 {
2101 if (index)
2102 PRINTCHAR (' ');
73ebd38f 2103
7b1123d8
PE
2104 switch (save_type (v, index))
2105 {
2106 case SAVE_UNUSED:
2107 i = sprintf (buf, "<unused>");
2108 break;
2109
2110 case SAVE_POINTER:
2111 i = sprintf (buf, "<pointer %p>",
2112 v->data[index].pointer);
2113 break;
2114
52a9bcae
PE
2115 case SAVE_FUNCPOINTER:
2116 i = sprintf (buf, "<funcpointer %p>",
2117 ((void *) (intptr_t)
2118 v->data[index].funcpointer));
2119 break;
2120
7b1123d8
PE
2121 case SAVE_INTEGER:
2122 i = sprintf (buf, "<integer %"pD"d>",
2123 v->data[index].integer);
2124 break;
2125
2126 case SAVE_OBJECT:
2127 print_object (v->data[index].object, printcharfun,
2128 escapeflag);
2129 continue;
52a9bcae
PE
2130
2131 default:
2132 emacs_abort ();
7b1123d8 2133 }
73ebd38f 2134
7b1123d8
PE
2135 strout (buf, i, i, printcharfun);
2136 }
6cda572a
DA
2137 }
2138 PRINTCHAR ('>');
99027bdd 2139 }
c069fee4
KS
2140 break;
2141
00d76abc
KH
2142 default:
2143 goto badtype;
e0f93814 2144 }
00d76abc 2145 break;
ca0569ad
RS
2146
2147 default:
00d76abc 2148 badtype:
ca0569ad 2149 {
99027bdd 2150 int len;
ca0569ad 2151 /* We're in trouble if this happens!
1088b922 2152 Probably should just emacs_abort (). */
1db5b1ad 2153 strout ("#<EMACS BUG: INVALID DATATYPE ", -1, -1, printcharfun);
00d76abc 2154 if (MISCP (obj))
99027bdd 2155 len = sprintf (buf, "(MISC 0x%04x)", (int) XMISCTYPE (obj));
00d76abc 2156 else if (VECTORLIKEP (obj))
99027bdd 2157 len = sprintf (buf, "(PVEC 0x%08"pD"x)", ASIZE (obj));
00d76abc 2158 else
99027bdd
PE
2159 len = sprintf (buf, "(0x%02x)", (int) XTYPE (obj));
2160 strout (buf, len, len, printcharfun);
ca0569ad 2161 strout (" Save your buffers immediately and please report this bug>",
1db5b1ad 2162 -1, -1, printcharfun);
ca0569ad 2163 }
38010d50
JB
2164 }
2165
2166 print_depth--;
2167}
2168\f
7651e1f5
RS
2169
2170/* Print a description of INTERVAL using PRINTCHARFUN.
2171 This is part of printing a string that has text properties. */
2172
12fbe755 2173static void
971de7fb 2174print_interval (INTERVAL interval, Lisp_Object printcharfun)
7651e1f5 2175{
71ea13cb
KH
2176 if (NILP (interval->plist))
2177 return;
30503c0b 2178 PRINTCHAR (' ');
0f25ecc6 2179 print_object (make_number (interval->position), printcharfun, 1);
7651e1f5 2180 PRINTCHAR (' ');
0f25ecc6 2181 print_object (make_number (interval->position + LENGTH (interval)),
cd3587c1 2182 printcharfun, 1);
7651e1f5 2183 PRINTCHAR (' ');
0f25ecc6 2184 print_object (interval->plist, printcharfun, 1);
7651e1f5
RS
2185}
2186
cf4bb06d
DA
2187/* Initialize debug_print stuff early to have it working from the very
2188 beginning. */
2189
2190void
2191init_print_once (void)
2192{
2193 DEFSYM (Qexternal_debugging_output, "external-debugging-output");
2194 defsubr (&Sexternal_debugging_output);
2195}
2196
38010d50 2197void
971de7fb 2198syms_of_print (void)
38010d50 2199{
fe6aa7a1
BT
2200#include "print.x"
2201
cd3520a4 2202 DEFSYM (Qtemp_buffer_setup_hook, "temp-buffer-setup-hook");
d9c21094 2203
29208e82 2204 DEFVAR_LISP ("standard-output", Vstandard_output,
8c1a1077
PJ
2205 doc: /* Output stream `print' uses by default for outputting a character.
2206This may be any function of one argument.
2207It may also be a buffer (output is inserted before point)
2208or a marker (output is inserted and the marker is advanced)
2209or the symbol t (output appears in the echo area). */);
38010d50 2210 Vstandard_output = Qt;
cd3520a4 2211 DEFSYM (Qstandard_output, "standard-output");
38010d50 2212
29208e82 2213 DEFVAR_LISP ("float-output-format", Vfloat_output_format,
8c1a1077
PJ
2214 doc: /* The format descriptor string used to print floats.
2215This is a %-spec like those accepted by `printf' in C,
2216but with some restrictions. It must start with the two characters `%.'.
2217After that comes an integer precision specification,
2218and then a letter which controls the format.
2219The letters allowed are `e', `f' and `g'.
2220Use `e' for exponential notation \"DIG.DIGITSeEXPT\"
2221Use `f' for decimal point notation \"DIGITS.DIGITS\".
2222Use `g' to choose the shorter of those two formats for the number at hand.
2223The precision in any of these cases is the number of digits following
2224the decimal point. With `f', a precision of 0 means to omit the
2225decimal point. 0 is not allowed with `e' or `g'.
2226
2227A value of nil means to use the shortest notation
2228that represents the number without losing information. */);
38010d50 2229 Vfloat_output_format = Qnil;
cd3520a4 2230 DEFSYM (Qfloat_output_format, "float-output-format");
38010d50 2231
29208e82 2232 DEFVAR_LISP ("print-length", Vprint_length,
8c1a1077
PJ
2233 doc: /* Maximum length of list to print before abbreviating.
2234A value of nil means no limit. See also `eval-expression-print-length'. */);
38010d50
JB
2235 Vprint_length = Qnil;
2236
29208e82 2237 DEFVAR_LISP ("print-level", Vprint_level,
8c1a1077
PJ
2238 doc: /* Maximum depth of list nesting to print before abbreviating.
2239A value of nil means no limit. See also `eval-expression-print-level'. */);
38010d50
JB
2240 Vprint_level = Qnil;
2241
29208e82 2242 DEFVAR_BOOL ("print-escape-newlines", print_escape_newlines,
8c1a1077
PJ
2243 doc: /* Non-nil means print newlines in strings as `\\n'.
2244Also print formfeeds as `\\f'. */);
38010d50
JB
2245 print_escape_newlines = 0;
2246
29208e82 2247 DEFVAR_BOOL ("print-escape-nonascii", print_escape_nonascii,
8c1a1077
PJ
2248 doc: /* Non-nil means print unibyte non-ASCII chars in strings as \\OOO.
2249\(OOO is the octal representation of the character code.)
249c0f71
RS
2250Only single-byte characters are affected, and only in `prin1'.
2251When the output goes in a multibyte buffer, this feature is
2252enabled regardless of the value of the variable. */);
38940e93
RS
2253 print_escape_nonascii = 0;
2254
29208e82 2255 DEFVAR_BOOL ("print-escape-multibyte", print_escape_multibyte,
8c1a1077
PJ
2256 doc: /* Non-nil means print multibyte characters in strings as \\xXXXX.
2257\(XXXX is the hex representation of the character code.)
2258This affects only `prin1'. */);
835d0be6
RS
2259 print_escape_multibyte = 0;
2260
29208e82 2261 DEFVAR_BOOL ("print-quoted", print_quoted,
8c1a1077 2262 doc: /* Non-nil means print quoted forms with reader syntax.
db75cb5f 2263I.e., (quote foo) prints as 'foo, (function foo) as #'foo. */);
2f100b5c
EN
2264 print_quoted = 0;
2265
29208e82 2266 DEFVAR_LISP ("print-gensym", Vprint_gensym,
8c1a1077
PJ
2267 doc: /* Non-nil means print uninterned symbols so they will read as uninterned.
2268I.e., the value of (make-symbol \"foobar\") prints as #:foobar.
2269When the uninterned symbol appears within a recursive data structure,
2270and the symbol appears more than once, in addition use the #N# and #N=
2271constructs as needed, so that multiple references to the same symbol are
2272shared once again when the text is read back. */);
e0f69431
RS
2273 Vprint_gensym = Qnil;
2274
29208e82 2275 DEFVAR_LISP ("print-circle", Vprint_circle,
fb7ada5f 2276 doc: /* Non-nil means print recursive structures using #N= and #N# syntax.
8c1a1077
PJ
2277If nil, printing proceeds recursively and may lead to
2278`max-lisp-eval-depth' being exceeded or an error may occur:
2279\"Apparently circular structure being printed.\" Also see
2280`print-length' and `print-level'.
2281If non-nil, shared substructures anywhere in the structure are printed
2282with `#N=' before the first occurrence (in the order of the print
2283representation) and `#N#' in place of each subsequent occurrence,
2284where N is a positive decimal integer. */);
0f25ecc6
RS
2285 Vprint_circle = Qnil;
2286
29208e82 2287 DEFVAR_LISP ("print-continuous-numbering", Vprint_continuous_numbering,
fb7ada5f 2288 doc: /* Non-nil means number continuously across print calls.
8c1a1077
PJ
2289This affects the numbers printed for #N= labels and #M# references.
2290See also `print-circle', `print-gensym', and `print-number-table'.
2291This variable should not be set with `setq'; bind it with a `let' instead. */);
0f25ecc6
RS
2292 Vprint_continuous_numbering = Qnil;
2293
29208e82 2294 DEFVAR_LISP ("print-number-table", Vprint_number_table,
8c1a1077
PJ
2295 doc: /* A vector used internally to produce `#N=' labels and `#N#' references.
2296The Lisp printer uses this vector to detect Lisp objects referenced more
e6d4cddd
RS
2297than once.
2298
2299When you bind `print-continuous-numbering' to t, you should probably
2300also bind `print-number-table' to nil. This ensures that the value of
2301`print-number-table' can be garbage-collected once the printing is
2302done. If all elements of `print-number-table' are nil, it means that
2303the printing done so far has not found any shared structure or objects
2304that need to be recorded in the table. */);
0f25ecc6 2305 Vprint_number_table = Qnil;
081e0581 2306
29208e82 2307 DEFVAR_LISP ("print-charset-text-property", Vprint_charset_text_property,
71ea13cb
KH
2308 doc: /* A flag to control printing of `charset' text property on printing a string.
2309The value must be nil, t, or `default'.
2310
2311If the value is nil, don't print the text property `charset'.
2312
2313If the value is t, always print the text property `charset'.
2314
2315If the value is `default', print the text property `charset' only when
2316the value is different from what is guessed in the current charset
dedbd91c 2317priorities. */);
71ea13cb
KH
2318 Vprint_charset_text_property = Qdefault;
2319
38010d50
JB
2320 /* prin1_to_string_buffer initialized in init_buffer_once in buffer.c */
2321 staticpro (&Vprin1_to_string_buffer);
2322
cd3520a4
JB
2323 DEFSYM (Qprint_escape_newlines, "print-escape-newlines");
2324 DEFSYM (Qprint_escape_multibyte, "print-escape-multibyte");
2325 DEFSYM (Qprint_escape_nonascii, "print-escape-nonascii");
835d0be6 2326
71ea13cb
KH
2327 print_prune_charset_plist = Qnil;
2328 staticpro (&print_prune_charset_plist);
38010d50 2329}