Merge from emacs-24; up to 2012-12-11T09:51:12Z!dmantipov@yandex.ru
[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>
38010d50 23#include <stdio.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. */
42c8bc9b 87int 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 (); \
0788646c 104 int free_print_buffer = 0; \
4b4deea2 105 int multibyte = !NILP (BVAR (current_buffer, enable_multibyte_characters)); \
081e0581
EN
106 Lisp_Object original
107
0788646c
GM
108#define PRINTPREPARE \
109 original = printcharfun; \
110 if (NILP (printcharfun)) printcharfun = Qt; \
111 if (BUFFERP (printcharfun)) \
112 { \
113 if (XBUFFER (printcharfun) != current_buffer) \
114 Fset_buffer (printcharfun); \
115 printcharfun = Qnil; \
116 } \
117 if (MARKERP (printcharfun)) \
118 { \
d311d28c 119 ptrdiff_t marker_pos; \
cd3587c1 120 if (! XMARKER (printcharfun)->buffer) \
0788646c 121 error ("Marker does not point anywhere"); \
1cf21850
LK
122 if (XMARKER (printcharfun)->buffer != current_buffer) \
123 set_buffer_internal (XMARKER (printcharfun)->buffer); \
124 marker_pos = marker_position (printcharfun); \
125 if (marker_pos < BEGV || marker_pos > ZV) \
126 error ("Marker is outside the accessible part of the buffer"); \
0788646c
GM
127 old_point = PT; \
128 old_point_byte = PT_BYTE; \
1cf21850 129 SET_PT_BOTH (marker_pos, \
0788646c
GM
130 marker_byte_position (printcharfun)); \
131 start_point = PT; \
132 start_point_byte = PT_BYTE; \
133 printcharfun = Qnil; \
134 } \
135 if (NILP (printcharfun)) \
136 { \
137 Lisp_Object string; \
4b4deea2 138 if (NILP (BVAR (current_buffer, enable_multibyte_characters)) \
0788646c
GM
139 && ! print_escape_multibyte) \
140 specbind (Qprint_escape_multibyte, Qt); \
4b4deea2 141 if (! NILP (BVAR (current_buffer, enable_multibyte_characters)) \
d39f07c2
RS
142 && ! print_escape_nonascii) \
143 specbind (Qprint_escape_nonascii, Qt); \
0788646c
GM
144 if (print_buffer != 0) \
145 { \
146 string = make_string_from_bytes (print_buffer, \
147 print_buffer_pos, \
148 print_buffer_pos_byte); \
149 record_unwind_protect (print_unwind, string); \
150 } \
151 else \
152 { \
d311d28c 153 int new_size = 1000; \
23f86fce 154 print_buffer = xmalloc (new_size); \
ff5844ad 155 print_buffer_size = new_size; \
0788646c
GM
156 free_print_buffer = 1; \
157 } \
158 print_buffer_pos = 0; \
159 print_buffer_pos_byte = 0; \
160 } \
5494b50f 161 if (EQ (printcharfun, Qt) && ! noninteractive) \
0f25ecc6 162 setup_echo_area_for_printing (multibyte);
38010d50 163
8a2ab0c6
RS
164#define PRINTFINISH \
165 if (NILP (printcharfun)) \
166 { \
167 if (print_buffer_pos != print_buffer_pos_byte \
4b4deea2 168 && NILP (BVAR (current_buffer, enable_multibyte_characters))) \
8a2ab0c6 169 { \
38182d90 170 unsigned char *temp = alloca (print_buffer_pos + 1); \
09125ef8
PE
171 copy_text ((unsigned char *) print_buffer, temp, \
172 print_buffer_pos_byte, 1, 0); \
b68864e5 173 insert_1_both ((char *) temp, print_buffer_pos, \
8a2ab0c6
RS
174 print_buffer_pos, 0, 1, 0); \
175 } \
176 else \
177 insert_1_both (print_buffer, print_buffer_pos, \
178 print_buffer_pos_byte, 0, 1, 0); \
570fab6c 179 signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
8a2ab0c6
RS
180 } \
181 if (free_print_buffer) \
182 { \
183 xfree (print_buffer); \
184 print_buffer = 0; \
185 } \
186 unbind_to (specpdl_count, Qnil); \
187 if (MARKERP (original)) \
188 set_marker_both (original, Qnil, PT, PT_BYTE); \
189 if (old_point >= 0) \
190 SET_PT_BOTH (old_point + (old_point >= start_point \
191 ? PT - start_point : 0), \
6ddd6eee 192 old_point_byte + (old_point_byte >= start_point_byte \
cd3587c1 193 ? PT_BYTE - start_point_byte : 0)); \
a3d794a1 194 set_buffer_internal (old);
38010d50
JB
195
196#define PRINTCHAR(ch) printchar (ch, printcharfun)
197
08e8d297
RS
198/* This is used to restore the saved contents of print_buffer
199 when there is a recursive call to print. */
0788646c 200
08e8d297 201static Lisp_Object
971de7fb 202print_unwind (Lisp_Object saved_text)
08e8d297 203{
72af86bd 204 memcpy (print_buffer, SDATA (saved_text), SCHARS (saved_text));
ee5263af 205 return Qnil;
08e8d297
RS
206}
207
0788646c
GM
208
209/* Print character CH using method FUN. FUN nil means print to
210 print_buffer. FUN t means print to echo area or stdout if
211 non-interactive. If FUN is neither nil nor t, call FUN with CH as
212 argument. */
38010d50
JB
213
214static void
971de7fb 215printchar (unsigned int ch, Lisp_Object fun)
38010d50 216{
0788646c
GM
217 if (!NILP (fun) && !EQ (fun, Qt))
218 call1 (fun, make_number (ch));
219 else
38010d50 220 {
19a86a03
KH
221 unsigned char str[MAX_MULTIBYTE_LENGTH];
222 int len = CHAR_STRING (ch, str);
223
09eddb56 224 QUIT;
177c0ea7 225
0788646c 226 if (NILP (fun))
9a4d01d8 227 {
d311d28c
PE
228 ptrdiff_t incr = len - (print_buffer_size - print_buffer_pos_byte);
229 if (0 < incr)
230 print_buffer =
231 xpalloc (print_buffer, &print_buffer_size, incr, -1, 1);
72af86bd 232 memcpy (print_buffer + print_buffer_pos_byte, str, len);
0788646c
GM
233 print_buffer_pos += 1;
234 print_buffer_pos_byte += len;
9a4d01d8 235 }
0788646c 236 else if (noninteractive)
1134b854 237 {
0788646c
GM
238 fwrite (str, 1, len, stdout);
239 noninteractive_need_newline = 1;
1134b854 240 }
0788646c 241 else
d366d2e4 242 {
0788646c 243 int multibyte_p
4b4deea2 244 = !NILP (BVAR (current_buffer, enable_multibyte_characters));
177c0ea7 245
eb7b678b 246 setup_echo_area_for_printing (multibyte_p);
0788646c 247 insert_char (ch);
09125ef8 248 message_dolog ((char *) str, len, 0, multibyte_p);
d366d2e4 249 }
38010d50 250 }
38010d50
JB
251}
252
0788646c
GM
253
254/* Output SIZE characters, SIZE_BYTE bytes from string PTR using
255 method PRINTCHARFUN. If SIZE < 0, use the string length of PTR for
256 both SIZE and SIZE_BYTE. PRINTCHARFUN nil means output to
257 print_buffer. PRINTCHARFUN t means output to the echo area or to
258 stdout if non-interactive. If neither nil nor t, call Lisp
259 function PRINTCHARFUN for each character printed. MULTIBYTE
efb15f96
RS
260 non-zero means PTR contains multibyte characters.
261
262 In the case where PRINTCHARFUN is nil, it is safe for PTR to point
263 to data in a Lisp string. Otherwise that is not safe. */
0788646c 264
38010d50 265static void
d311d28c 266strout (const char *ptr, ptrdiff_t size, ptrdiff_t size_byte,
1db5b1ad 267 Lisp_Object printcharfun)
38010d50 268{
087e3c46 269 if (size < 0)
dc2a0b79 270 size_byte = size = strlen (ptr);
087e3c46 271
0788646c 272 if (NILP (printcharfun))
38010d50 273 {
d311d28c
PE
274 ptrdiff_t incr = size_byte - (print_buffer_size - print_buffer_pos_byte);
275 if (0 < incr)
276 print_buffer = xpalloc (print_buffer, &print_buffer_size, incr, -1, 1);
72af86bd 277 memcpy (print_buffer + print_buffer_pos_byte, ptr, size_byte);
6fec5601 278 print_buffer_pos += size;
dc2a0b79 279 print_buffer_pos_byte += size_byte;
38010d50 280 }
7b0cb8a0 281 else if (noninteractive && EQ (printcharfun, Qt))
38010d50 282 {
0788646c
GM
283 fwrite (ptr, 1, size_byte, stdout);
284 noninteractive_need_newline = 1;
285 }
286 else if (EQ (printcharfun, Qt))
287 {
288 /* Output to echo area. We're trying to avoid a little overhead
289 here, that's the reason we don't call printchar to do the
290 job. */
291 int i;
292 int multibyte_p
4b4deea2 293 = !NILP (BVAR (current_buffer, enable_multibyte_characters));
177c0ea7 294
eb7b678b 295 setup_echo_area_for_printing (multibyte_p);
0788646c 296 message_dolog (ptr, size_byte, 0, multibyte_p);
177c0ea7 297
0788646c 298 if (size == size_byte)
38010d50 299 {
0788646c 300 for (i = 0; i < size; ++i)
bcdbfd36 301 insert_char ((unsigned char) *ptr++);
38010d50 302 }
0788646c 303 else
38010d50 304 {
0788646c
GM
305 int len;
306 for (i = 0; i < size_byte; i += len)
aec2b95b 307 {
09125ef8
PE
308 int ch = STRING_CHAR_AND_LENGTH ((const unsigned char *) ptr + i,
309 len);
0788646c 310 insert_char (ch);
aec2b95b 311 }
38010d50 312 }
0788646c
GM
313 }
314 else
315 {
316 /* PRINTCHARFUN is a Lisp function. */
d311d28c 317 ptrdiff_t i = 0;
38010d50 318
0788646c 319 if (size == size_byte)
4ad8bb20 320 {
0788646c 321 while (i < size_byte)
4ad8bb20 322 {
0788646c
GM
323 int ch = ptr[i++];
324 PRINTCHAR (ch);
4ad8bb20 325 }
4ad8bb20 326 }
0788646c 327 else
087e3c46 328 {
0788646c
GM
329 while (i < size_byte)
330 {
331 /* Here, we must convert each multi-byte form to the
332 corresponding character code before handing it to
333 PRINTCHAR. */
334 int len;
09125ef8
PE
335 int ch = STRING_CHAR_AND_LENGTH ((const unsigned char *) ptr + i,
336 len);
0788646c
GM
337 PRINTCHAR (ch);
338 i += len;
339 }
087e3c46 340 }
38010d50 341 }
38010d50
JB
342}
343
344/* Print the contents of a string STRING using PRINTCHARFUN.
ed2c35ef
RS
345 It isn't safe to use strout in many cases,
346 because printing one char can relocate. */
38010d50 347
dc2a0b79 348static void
971de7fb 349print_string (Lisp_Object string, Lisp_Object printcharfun)
38010d50 350{
6fec5601 351 if (EQ (printcharfun, Qt) || NILP (printcharfun))
375fcc09 352 {
d311d28c 353 ptrdiff_t chars;
375fcc09 354
8b4b4467
KH
355 if (print_escape_nonascii)
356 string = string_escape_byte8 (string);
357
375fcc09 358 if (STRING_MULTIBYTE (string))
d5db4077 359 chars = SCHARS (string);
8b4b4467
KH
360 else if (! print_escape_nonascii
361 && (EQ (printcharfun, Qt)
4b4deea2
TT
362 ? ! NILP (BVAR (&buffer_defaults, enable_multibyte_characters))
363 : ! NILP (BVAR (current_buffer, enable_multibyte_characters))))
a76ef35d
KH
364 {
365 /* If unibyte string STRING contains 8-bit codes, we must
366 convert STRING to a multibyte string containing the same
367 character codes. */
368 Lisp_Object newstr;
d311d28c 369 ptrdiff_t bytes;
a76ef35d 370
d5db4077 371 chars = SBYTES (string);
de883a70 372 bytes = count_size_as_multibyte (SDATA (string), chars);
a76ef35d
KH
373 if (chars < bytes)
374 {
375 newstr = make_uninit_multibyte_string (chars, bytes);
72af86bd 376 memcpy (SDATA (newstr), SDATA (string), chars);
d5db4077 377 str_to_multibyte (SDATA (newstr), bytes, chars);
a76ef35d
KH
378 string = newstr;
379 }
380 }
375fcc09 381 else
d5db4077 382 chars = SBYTES (string);
375fcc09 383
efb15f96
RS
384 if (EQ (printcharfun, Qt))
385 {
386 /* Output to echo area. */
d311d28c 387 ptrdiff_t nbytes = SBYTES (string);
efb15f96
RS
388
389 /* Copy the string contents so that relocation of STRING by
390 GC does not cause trouble. */
391 USE_SAFE_ALLOCA;
98c6f1e3 392 char *buffer = SAFE_ALLOCA (nbytes);
72af86bd 393 memcpy (buffer, SDATA (string), nbytes);
efb15f96 394
98c6f1e3 395 strout (buffer, chars, nbytes, printcharfun);
efb15f96
RS
396
397 SAFE_FREE ();
398 }
399 else
400 /* No need to copy, since output to print_buffer can't GC. */
1db5b1ad 401 strout (SSDATA (string), chars, SBYTES (string), printcharfun);
375fcc09 402 }
38010d50
JB
403 else
404 {
dc2a0b79
RS
405 /* Otherwise, string may be relocated by printing one char.
406 So re-fetch the string address for each character. */
d311d28c
PE
407 ptrdiff_t i;
408 ptrdiff_t size = SCHARS (string);
409 ptrdiff_t size_byte = SBYTES (string);
38010d50
JB
410 struct gcpro gcpro1;
411 GCPRO1 (string);
dc2a0b79
RS
412 if (size == size_byte)
413 for (i = 0; i < size; i++)
d5db4077 414 PRINTCHAR (SREF (string, i));
dc2a0b79 415 else
6b61353c 416 for (i = 0; i < size_byte; )
dc2a0b79
RS
417 {
418 /* Here, we must convert each multi-byte form to the
419 corresponding character code before handing it to PRINTCHAR. */
420 int len;
62a6e103 421 int ch = STRING_CHAR_AND_LENGTH (SDATA (string) + i, len);
dc2a0b79
RS
422 PRINTCHAR (ch);
423 i += len;
424 }
38010d50
JB
425 UNGCPRO;
426 }
427}
428\f
429DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
8c1a1077
PJ
430 doc: /* Output character CHARACTER to stream PRINTCHARFUN.
431PRINTCHARFUN defaults to the value of `standard-output' (which see). */)
5842a27b 432 (Lisp_Object character, Lisp_Object printcharfun)
38010d50 433{
081e0581 434 PRINTDECLARE;
38010d50 435
10eebdbb 436 if (NILP (printcharfun))
38010d50 437 printcharfun = Vstandard_output;
b7826503 438 CHECK_NUMBER (character);
38010d50 439 PRINTPREPARE;
3738a371 440 PRINTCHAR (XINT (character));
38010d50 441 PRINTFINISH;
3738a371 442 return character;
38010d50
JB
443}
444
dc2a0b79
RS
445/* Used from outside of print.c to print a block of SIZE
446 single-byte chars at DATA on the default output stream.
38010d50
JB
447 Do not use this on the contents of a Lisp string. */
448
dc22f25e 449void
a8fe7202 450write_string (const char *data, int size)
38010d50 451{
081e0581 452 PRINTDECLARE;
38010d50 453 Lisp_Object printcharfun;
38010d50
JB
454
455 printcharfun = Vstandard_output;
456
457 PRINTPREPARE;
1db5b1ad 458 strout (data, size, size, printcharfun);
38010d50
JB
459 PRINTFINISH;
460}
461
2f7c71a1
AS
462/* Used to print a block of SIZE single-byte chars at DATA on a
463 specified stream PRINTCHARFUN.
38010d50
JB
464 Do not use this on the contents of a Lisp string. */
465
2f7c71a1 466static void
a8fe7202 467write_string_1 (const char *data, int size, Lisp_Object printcharfun)
38010d50 468{
081e0581 469 PRINTDECLARE;
38010d50
JB
470
471 PRINTPREPARE;
1db5b1ad 472 strout (data, size, size, printcharfun);
38010d50
JB
473 PRINTFINISH;
474}
475
476
38010d50 477void
971de7fb 478temp_output_buffer_setup (const char *bufname)
38010d50 479{
d311d28c 480 ptrdiff_t count = SPECPDL_INDEX ();
38010d50
JB
481 register struct buffer *old = current_buffer;
482 register Lisp_Object buf;
483
66322887 484 record_unwind_current_buffer ();
d9c21094 485
38010d50
JB
486 Fset_buffer (Fget_buffer_create (build_string (bufname)));
487
9756ea0f 488 Fkill_all_local_variables ();
fd531951 489 delete_all_overlays (current_buffer);
39eb03f1
PE
490 bset_directory (current_buffer, BVAR (old, directory));
491 bset_read_only (current_buffer, Qnil);
492 bset_filename (current_buffer, Qnil);
493 bset_undo_list (current_buffer, Qt);
fd318b54
DA
494 eassert (current_buffer->overlays_before == NULL);
495 eassert (current_buffer->overlays_after == NULL);
39eb03f1
PE
496 bset_enable_multibyte_characters
497 (current_buffer, BVAR (&buffer_defaults, enable_multibyte_characters));
d28eab19
KH
498 specbind (Qinhibit_read_only, Qt);
499 specbind (Qinhibit_modification_hooks, Qt);
38010d50 500 Ferase_buffer ();
633307b5 501 XSETBUFFER (buf, current_buffer);
38010d50 502
98040cf1 503 Frun_hooks (1, &Qtemp_buffer_setup_hook);
d9c21094
RS
504
505 unbind_to (count, Qnil);
506
507 specbind (Qstandard_output, buf);
38010d50 508}
38010d50 509\f
971de7fb
DN
510static void print (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag);
511static void print_preprocess (Lisp_Object obj);
512static void print_preprocess_string (INTERVAL interval, Lisp_Object arg);
513static void print_object (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag);
38010d50 514
a7ca3326 515DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
8c1a1077
PJ
516 doc: /* Output a newline to stream PRINTCHARFUN.
517If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used. */)
5842a27b 518 (Lisp_Object printcharfun)
38010d50 519{
081e0581 520 PRINTDECLARE;
38010d50 521
10eebdbb 522 if (NILP (printcharfun))
38010d50
JB
523 printcharfun = Vstandard_output;
524 PRINTPREPARE;
525 PRINTCHAR ('\n');
526 PRINTFINISH;
527 return Qt;
528}
529
a7ca3326 530DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
8c1a1077
PJ
531 doc: /* Output the printed representation of OBJECT, any Lisp object.
532Quoting characters are printed when needed to make output that `read'
9474c847 533can handle, whenever this is possible. For complex objects, the behavior
7fab9223 534is controlled by `print-level' and `print-length', which see.
8c1a1077
PJ
535
536OBJECT is any of the Lisp data types: a number, a string, a symbol,
537a list, a buffer, a window, a frame, etc.
538
539A printed representation of an object is text which describes that object.
540
541Optional argument PRINTCHARFUN is the output stream, which can be one
542of these:
543
544 - a buffer, in which case output is inserted into that buffer at point;
545 - a marker, in which case output is inserted at marker's position;
546 - a function, in which case that function is called once for each
547 character of OBJECT's printed representation;
548 - a symbol, in which case that symbol's function definition is called; or
549 - t, in which case the output is displayed in the echo area.
550
551If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
552is used instead. */)
5842a27b 553 (Lisp_Object object, Lisp_Object printcharfun)
38010d50 554{
081e0581 555 PRINTDECLARE;
38010d50 556
10eebdbb 557 if (NILP (printcharfun))
38010d50
JB
558 printcharfun = Vstandard_output;
559 PRINTPREPARE;
3738a371 560 print (object, printcharfun, 1);
38010d50 561 PRINTFINISH;
3738a371 562 return object;
38010d50
JB
563}
564
565/* a buffer which is used to hold output being built by prin1-to-string */
566Lisp_Object Vprin1_to_string_buffer;
567
a7ca3326 568DEFUN ("prin1-to-string", Fprin1_to_string, Sprin1_to_string, 1, 2, 0,
fd4d156b
RS
569 doc: /* Return a string containing the printed representation of OBJECT.
570OBJECT can be any Lisp object. This function outputs quoting characters
cf393f9b 571when necessary to make output that `read' can handle, whenever possible,
a2612656
EZ
572unless the optional second argument NOESCAPE is non-nil. For complex objects,
573the behavior is controlled by `print-level' and `print-length', which see.
8c1a1077
PJ
574
575OBJECT is any of the Lisp data types: a number, a string, a symbol,
576a list, a buffer, a window, a frame, etc.
577
578A printed representation of an object is text which describes that object. */)
5842a27b 579 (Lisp_Object object, Lisp_Object noescape)
38010d50 580{
081e0581 581 Lisp_Object printcharfun;
fce31d69 582 bool prev_abort_on_gc;
ca2de342
RS
583 /* struct gcpro gcpro1, gcpro2; */
584 Lisp_Object save_deactivate_mark;
d311d28c 585 ptrdiff_t count = SPECPDL_INDEX ();
6b61353c 586 struct buffer *previous;
ca2de342
RS
587
588 specbind (Qinhibit_modification_hooks, Qt);
2a42e8f6 589
6b61353c
KH
590 {
591 PRINTDECLARE;
592
593 /* Save and restore this--we are altering a buffer
594 but we don't want to deactivate the mark just for that.
595 No need for specbind, since errors deactivate the mark. */
596 save_deactivate_mark = Vdeactivate_mark;
597 /* GCPRO2 (object, save_deactivate_mark); */
fce31d69
PE
598 prev_abort_on_gc = abort_on_gc;
599 abort_on_gc = 1;
6b61353c
KH
600
601 printcharfun = Vprin1_to_string_buffer;
602 PRINTPREPARE;
603 print (object, printcharfun, NILP (noescape));
6196cffe 604 /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINISH */
6b61353c
KH
605 PRINTFINISH;
606 }
38010d50 607
6b61353c 608 previous = current_buffer;
38010d50 609 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
3738a371 610 object = Fbuffer_string ();
b51ee131
SM
611 if (SBYTES (object) == SCHARS (object))
612 STRING_SET_UNIBYTE (object);
38010d50 613
28b8f740 614 /* Note that this won't make prepare_to_modify_buffer call
6b61353c
KH
615 ask-user-about-supersession-threat because this buffer
616 does not visit a file. */
38010d50 617 Ferase_buffer ();
6b61353c 618 set_buffer_internal (previous);
2a42e8f6 619
ca2de342
RS
620 Vdeactivate_mark = save_deactivate_mark;
621 /* UNGCPRO; */
38010d50 622
fce31d69 623 abort_on_gc = prev_abort_on_gc;
ca2de342 624 return unbind_to (count, object);
38010d50
JB
625}
626
ad64fc97 627DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
8c1a1077
PJ
628 doc: /* Output the printed representation of OBJECT, any Lisp object.
629No quoting characters are used; no delimiters are printed around
630the contents of strings.
631
632OBJECT is any of the Lisp data types: a number, a string, a symbol,
633a list, a buffer, a window, a frame, etc.
634
635A printed representation of an object is text which describes that object.
636
637Optional argument PRINTCHARFUN is the output stream, which can be one
638of these:
639
640 - a buffer, in which case output is inserted into that buffer at point;
641 - a marker, in which case output is inserted at marker's position;
642 - a function, in which case that function is called once for each
643 character of OBJECT's printed representation;
644 - a symbol, in which case that symbol's function definition is called; or
645 - t, in which case the output is displayed in the echo area.
646
647If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
648is used instead. */)
5842a27b 649 (Lisp_Object object, Lisp_Object printcharfun)
38010d50 650{
081e0581 651 PRINTDECLARE;
38010d50 652
10eebdbb 653 if (NILP (printcharfun))
38010d50
JB
654 printcharfun = Vstandard_output;
655 PRINTPREPARE;
3738a371 656 print (object, printcharfun, 0);
38010d50 657 PRINTFINISH;
3738a371 658 return object;
38010d50
JB
659}
660
a7ca3326 661DEFUN ("print", Fprint, Sprint, 1, 2, 0,
8c1a1077
PJ
662 doc: /* Output the printed representation of OBJECT, with newlines around it.
663Quoting characters are printed when needed to make output that `read'
9474c847 664can handle, whenever this is possible. For complex objects, the behavior
7fab9223 665is controlled by `print-level' and `print-length', which see.
8c1a1077
PJ
666
667OBJECT is any of the Lisp data types: a number, a string, a symbol,
668a list, a buffer, a window, a frame, etc.
669
670A printed representation of an object is text which describes that object.
671
672Optional argument PRINTCHARFUN is the output stream, which can be one
673of these:
674
675 - a buffer, in which case output is inserted into that buffer at point;
676 - a marker, in which case output is inserted at marker's position;
677 - a function, in which case that function is called once for each
678 character of OBJECT's printed representation;
679 - a symbol, in which case that symbol's function definition is called; or
680 - t, in which case the output is displayed in the echo area.
681
682If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
683is used instead. */)
5842a27b 684 (Lisp_Object object, Lisp_Object printcharfun)
38010d50 685{
081e0581 686 PRINTDECLARE;
38010d50
JB
687 struct gcpro gcpro1;
688
10eebdbb 689 if (NILP (printcharfun))
38010d50 690 printcharfun = Vstandard_output;
3738a371 691 GCPRO1 (object);
38010d50 692 PRINTPREPARE;
38010d50 693 PRINTCHAR ('\n');
3738a371 694 print (object, printcharfun, 1);
38010d50
JB
695 PRINTCHAR ('\n');
696 PRINTFINISH;
38010d50 697 UNGCPRO;
3738a371 698 return object;
38010d50
JB
699}
700
701/* The subroutine object for external-debugging-output is kept here
702 for the convenience of the debugger. */
703Lisp_Object Qexternal_debugging_output;
704
4746118a 705DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
8c1a1077
PJ
706 doc: /* Write CHARACTER to stderr.
707You can call print while debugging emacs, and pass it this function
708to make it write to the debugging output. */)
5842a27b 709 (Lisp_Object character)
38010d50 710{
0fd11aa5
PE
711 CHECK_NUMBER (character);
712 putc (XINT (character) & 0xFF, stderr);
cd22039d
RS
713
714#ifdef WINDOWSNT
715 /* Send the output to a debugger (nothing happens if there isn't one). */
945b0111
EZ
716 if (print_output_debug_flag)
717 {
718 char buf[2] = {(char) XINT (character), '\0'};
719 OutputDebugString (buf);
720 }
cd22039d
RS
721#endif
722
38010d50
JB
723 return character;
724}
cf1bb91b 725
c33f8948
RS
726/* This function is never called. Its purpose is to prevent
727 print_output_debug_flag from being optimized away. */
728
c38bf546 729extern void debug_output_compilation_hack (int) EXTERNALLY_VISIBLE;
dae581bf 730void
971de7fb 731debug_output_compilation_hack (int x)
c33f8948
RS
732{
733 print_output_debug_flag = x;
734}
6b61353c 735
cd3587c1 736#if defined (GNU_LINUX)
6b61353c
KH
737
738/* This functionality is not vitally important in general, so we rely on
739 non-portable ability to use stderr as lvalue. */
740
741#define WITH_REDIRECT_DEBUGGING_OUTPUT 1
742
ad64fc97 743static FILE *initial_stderr_stream = NULL;
6b61353c
KH
744
745DEFUN ("redirect-debugging-output", Fredirect_debugging_output, Sredirect_debugging_output,
746 1, 2,
747 "FDebug output file: \nP",
748 doc: /* Redirect debugging output (stderr stream) to file FILE.
749If FILE is nil, reset target to the initial stderr stream.
750Optional arg APPEND non-nil (interactively, with prefix arg) means
28b8f740 751append to existing target file. */)
5842a27b 752 (Lisp_Object file, Lisp_Object append)
6b61353c
KH
753{
754 if (initial_stderr_stream != NULL)
f9467be3 755 {
4d7e6e51 756 block_input ();
f9467be3 757 fclose (stderr);
4d7e6e51 758 unblock_input ();
f9467be3 759 }
6b61353c
KH
760 stderr = initial_stderr_stream;
761 initial_stderr_stream = NULL;
762
763 if (STRINGP (file))
764 {
765 file = Fexpand_file_name (file, Qnil);
766 initial_stderr_stream = stderr;
d4d7173a 767 stderr = fopen (SSDATA (file), NILP (append) ? "w" : "a");
6b61353c
KH
768 if (stderr == NULL)
769 {
770 stderr = initial_stderr_stream;
771 initial_stderr_stream = NULL;
772 report_file_error ("Cannot open debugging output stream",
773 Fcons (file, Qnil));
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;
99027bdd 969 int 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
971de7fb 1066print (Lisp_Object obj, register Lisp_Object printcharfun, int 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))
1303 print_prune_charset_plist = Fcons (Qcharset, Qnil);
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
971de7fb 1316print_object (Lisp_Object obj, register Lisp_Object printcharfun, int 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. */
1398 int need_nonhex = 0;
db300f59 1399 int 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 {
1510 register int confusing;
d5db4077
KR
1511 register unsigned char *p = SDATA (SYMBOL_NAME (obj));
1512 register unsigned char *end = p + SBYTES (SYMBOL_NAME (obj));
2190a05e 1513 register 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;
d311d28c 1707 ptrdiff_t size_in_chars
4b5af5e4
AS
1708 = ((XBOOL_VECTOR (obj)->size + BOOL_VECTOR_BITS_PER_CHAR - 1)
1709 / BOOL_VECTOR_BITS_PER_CHAR);
ed2c35ef
RS
1710
1711 GCPRO1 (obj);
1712
1713 PRINTCHAR ('#');
1714 PRINTCHAR ('&');
99027bdd
PE
1715 len = sprintf (buf, "%"pI"d", XBOOL_VECTOR (obj)->size);
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 }
1755 PRINTCHAR ('\"');
1756
1757 UNGCPRO;
1758 }
ca0569ad
RS
1759 else if (SUBRP (obj))
1760 {
1db5b1ad
JB
1761 strout ("#<subr ", -1, -1, printcharfun);
1762 strout (XSUBR (obj)->symbol_name, -1, -1, printcharfun);
ca0569ad
RS
1763 PRINTCHAR ('>');
1764 }
ca0569ad
RS
1765 else if (WINDOWP (obj))
1766 {
99027bdd 1767 int len;
1db5b1ad 1768 strout ("#<window ", -1, -1, printcharfun);
45942c7d 1769 len = sprintf (buf, "%d", XWINDOW (obj)->sequence_number);
99027bdd 1770 strout (buf, len, len, printcharfun);
d3d50620 1771 if (!NILP (XWINDOW (obj)->buffer))
ca0569ad 1772 {
1db5b1ad 1773 strout (" on ", -1, -1, printcharfun);
d3d50620 1774 print_string (BVAR (XBUFFER (XWINDOW (obj)->buffer), name),
3a45383a 1775 printcharfun);
ca0569ad
RS
1776 }
1777 PRINTCHAR ('>');
1778 }
f76c8b1e
SM
1779 else if (TERMINALP (obj))
1780 {
99027bdd 1781 int len;
f76c8b1e 1782 struct terminal *t = XTERMINAL (obj);
1db5b1ad 1783 strout ("#<terminal ", -1, -1, printcharfun);
99027bdd
PE
1784 len = sprintf (buf, "%d", t->id);
1785 strout (buf, len, len, printcharfun);
f76c8b1e
SM
1786 if (t->name)
1787 {
1db5b1ad
JB
1788 strout (" on ", -1, -1, printcharfun);
1789 strout (t->name, -1, -1, printcharfun);
f76c8b1e
SM
1790 }
1791 PRINTCHAR ('>');
1792 }
7eb03302
GM
1793 else if (HASH_TABLE_P (obj))
1794 {
1795 struct Lisp_Hash_Table *h = XHASH_TABLE (obj);
d311d28c
PE
1796 ptrdiff_t i;
1797 ptrdiff_t real_size, size;
99027bdd 1798 int len;
f19a0f5b 1799#if 0
1db5b1ad 1800 strout ("#<hash-table", -1, -1, printcharfun);
7eb03302
GM
1801 if (SYMBOLP (h->test))
1802 {
1803 PRINTCHAR (' ');
1804 PRINTCHAR ('\'');
1db5b1ad 1805 strout (SDATA (SYMBOL_NAME (h->test)), -1, -1, printcharfun);
7eb03302 1806 PRINTCHAR (' ');
1db5b1ad 1807 strout (SDATA (SYMBOL_NAME (h->weak)), -1, -1, printcharfun);
7eb03302 1808 PRINTCHAR (' ');
99027bdd
PE
1809 len = sprintf (buf, "%"pD"d/%"pD"d", h->count, ASIZE (h->next));
1810 strout (buf, len, len, printcharfun);
7eb03302 1811 }
99027bdd
PE
1812 len = sprintf (buf, " %p", h);
1813 strout (buf, len, len, printcharfun);
7eb03302 1814 PRINTCHAR ('>');
f19a0f5b
TZ
1815#endif
1816 /* Implement a readable output, e.g.:
1817 #s(hash-table size 2 test equal data (k1 v1 k2 v2)) */
b7432bb2 1818 /* Always print the size. */
99027bdd
PE
1819 len = sprintf (buf, "#s(hash-table size %"pD"d", ASIZE (h->next));
1820 strout (buf, len, len, printcharfun);
f19a0f5b 1821
b7432bb2 1822 if (!NILP (h->test.name))
f19a0f5b 1823 {
1db5b1ad 1824 strout (" test ", -1, -1, printcharfun);
b7432bb2 1825 print_object (h->test.name, printcharfun, escapeflag);
f19a0f5b
TZ
1826 }
1827
1828 if (!NILP (h->weak))
1829 {
1db5b1ad 1830 strout (" weakness ", -1, -1, printcharfun);
617a0e83 1831 print_object (h->weak, printcharfun, escapeflag);
f19a0f5b
TZ
1832 }
1833
1834 if (!NILP (h->rehash_size))
1835 {
1db5b1ad 1836 strout (" rehash-size ", -1, -1, printcharfun);
617a0e83 1837 print_object (h->rehash_size, printcharfun, escapeflag);
f19a0f5b
TZ
1838 }
1839
1840 if (!NILP (h->rehash_threshold))
1841 {
1db5b1ad 1842 strout (" rehash-threshold ", -1, -1, printcharfun);
617a0e83 1843 print_object (h->rehash_threshold, printcharfun, escapeflag);
f19a0f5b
TZ
1844 }
1845
1db5b1ad 1846 strout (" data ", -1, -1, printcharfun);
f19a0f5b
TZ
1847
1848 /* Print the data here as a plist. */
b0ca0f33
DN
1849 real_size = HASH_TABLE_SIZE (h);
1850 size = real_size;
f19a0f5b
TZ
1851
1852 /* Don't print more elements than the specified maximum. */
1853 if (NATNUMP (Vprint_length)
1854 && XFASTINT (Vprint_length) < size)
1855 size = XFASTINT (Vprint_length);
42a5b22f 1856
f19a0f5b
TZ
1857 PRINTCHAR ('(');
1858 for (i = 0; i < size; i++)
1859 if (!NILP (HASH_HASH (h, i)))
1860 {
1861 if (i) PRINTCHAR (' ');
617a0e83 1862 print_object (HASH_KEY (h, i), printcharfun, escapeflag);
f19a0f5b 1863 PRINTCHAR (' ');
617a0e83 1864 print_object (HASH_VALUE (h, i), printcharfun, escapeflag);
f19a0f5b
TZ
1865 }
1866
1867 if (size < real_size)
1db5b1ad 1868 strout (" ...", 4, 4, printcharfun);
f19a0f5b
TZ
1869
1870 PRINTCHAR (')');
1871 PRINTCHAR (')');
1872
7eb03302 1873 }
908b0ae5
RS
1874 else if (BUFFERP (obj))
1875 {
e578f381 1876 if (!BUFFER_LIVE_P (XBUFFER (obj)))
1db5b1ad 1877 strout ("#<killed buffer>", -1, -1, printcharfun);
908b0ae5
RS
1878 else if (escapeflag)
1879 {
1db5b1ad 1880 strout ("#<buffer ", -1, -1, printcharfun);
4b4deea2 1881 print_string (BVAR (XBUFFER (obj), name), printcharfun);
908b0ae5
RS
1882 PRINTCHAR ('>');
1883 }
1884 else
4b4deea2 1885 print_string (BVAR (XBUFFER (obj), name), printcharfun);
908b0ae5 1886 }
ca0569ad
RS
1887 else if (WINDOW_CONFIGURATIONP (obj))
1888 {
1db5b1ad 1889 strout ("#<window-configuration>", -1, -1, printcharfun);
ca0569ad 1890 }
ca0569ad
RS
1891 else if (FRAMEP (obj))
1892 {
99027bdd 1893 int len;
e69b0960 1894 Lisp_Object frame_name = XFRAME (obj)->name;
436bc8e0 1895
ca0569ad
RS
1896 strout ((FRAME_LIVE_P (XFRAME (obj))
1897 ? "#<frame " : "#<dead frame "),
1db5b1ad 1898 -1, -1, printcharfun);
436bc8e0
EZ
1899 if (!STRINGP (frame_name))
1900 {
1901 /* A frame could be too young and have no name yet;
1902 don't crash. */
1903 if (SYMBOLP (frame_name))
1904 frame_name = Fsymbol_name (frame_name);
1905 else /* can't happen: name should be either nil or string */
1906 frame_name = build_string ("*INVALID*FRAME*NAME*");
1907 }
1908 print_string (frame_name, printcharfun);
99027bdd
PE
1909 len = sprintf (buf, " %p", XFRAME (obj));
1910 strout (buf, len, len, printcharfun);
ca0569ad
RS
1911 PRINTCHAR ('>');
1912 }
2a7b7982
KH
1913 else if (FONTP (obj))
1914 {
d311d28c 1915 int i;
2a7b7982
KH
1916
1917 if (! FONT_OBJECT_P (obj))
1918 {
1919 if (FONT_SPEC_P (obj))
1db5b1ad 1920 strout ("#<font-spec", -1, -1, printcharfun);
2a7b7982 1921 else
1db5b1ad 1922 strout ("#<font-entity", -1, -1, printcharfun);
2a7b7982
KH
1923 for (i = 0; i < FONT_SPEC_MAX; i++)
1924 {
1925 PRINTCHAR (' ');
1926 if (i < FONT_WEIGHT_INDEX || i > FONT_WIDTH_INDEX)
1927 print_object (AREF (obj, i), printcharfun, escapeflag);
1928 else
1929 print_object (font_style_symbolic (obj, i, 0),
1930 printcharfun, escapeflag);
1931 }
1932 }
1933 else
1934 {
1db5b1ad 1935 strout ("#<font-object ", -1, -1, printcharfun);
2a7b7982
KH
1936 print_object (AREF (obj, FONT_NAME_INDEX), printcharfun,
1937 escapeflag);
1938 }
1939 PRINTCHAR ('>');
1940 }
ca0569ad
RS
1941 else
1942 {
d311d28c 1943 ptrdiff_t size = ASIZE (obj);
ca0569ad
RS
1944 if (COMPILEDP (obj))
1945 {
1946 PRINTCHAR ('#');
1947 size &= PSEUDOVECTOR_SIZE_MASK;
1948 }
8b4b4467 1949 if (CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj))
ed2c35ef
RS
1950 {
1951 /* We print a char-table as if it were a vector,
1952 lumping the parent and default slots in with the
1953 character slots. But we add #^ as a prefix. */
223509a3
KH
1954
1955 /* Make each lowest sub_char_table start a new line.
1956 Otherwise we'll make a line extremely long, which
1957 results in slow redisplay. */
1958 if (SUB_CHAR_TABLE_P (obj)
1959 && XINT (XSUB_CHAR_TABLE (obj)->depth) == 3)
1960 PRINTCHAR ('\n');
ed2c35ef
RS
1961 PRINTCHAR ('#');
1962 PRINTCHAR ('^');
3701b5de
KH
1963 if (SUB_CHAR_TABLE_P (obj))
1964 PRINTCHAR ('^');
ed2c35ef
RS
1965 size &= PSEUDOVECTOR_SIZE_MASK;
1966 }
00d76abc
KH
1967 if (size & PSEUDOVECTOR_FLAG)
1968 goto badtype;
ca0569ad
RS
1969
1970 PRINTCHAR ('[');
38010d50 1971 {
ca0569ad
RS
1972 register int i;
1973 register Lisp_Object tem;
d311d28c 1974 ptrdiff_t real_size = size;
a40384bc
RS
1975
1976 /* Don't print more elements than the specified maximum. */
42ac1ed4
GM
1977 if (NATNUMP (Vprint_length)
1978 && XFASTINT (Vprint_length) < size)
1979 size = XFASTINT (Vprint_length);
a40384bc 1980
ca0569ad
RS
1981 for (i = 0; i < size; i++)
1982 {
1983 if (i) PRINTCHAR (' ');
28be1ada 1984 tem = AREF (obj, i);
0f25ecc6 1985 print_object (tem, printcharfun, escapeflag);
ca0569ad 1986 }
d6ac884e 1987 if (size < real_size)
1db5b1ad 1988 strout (" ...", 4, 4, printcharfun);
38010d50 1989 }
ca0569ad
RS
1990 PRINTCHAR (']');
1991 }
1992 break;
1993
ca0569ad 1994 case Lisp_Misc:
5db20f08 1995 switch (XMISCTYPE (obj))
38010d50 1996 {
00d76abc 1997 case Lisp_Misc_Marker:
1db5b1ad 1998 strout ("#<marker ", -1, -1, printcharfun);
087e3c46
KH
1999 /* Do you think this is necessary? */
2000 if (XMARKER (obj)->insertion_type != 0)
1db5b1ad 2001 strout ("(moves after insertion) ", -1, -1, printcharfun);
cd3587c1 2002 if (! XMARKER (obj)->buffer)
1db5b1ad 2003 strout ("in no buffer", -1, -1, printcharfun);
ca0569ad
RS
2004 else
2005 {
99027bdd
PE
2006 int len = sprintf (buf, "at %"pD"d", marker_position (obj));
2007 strout (buf, len, len, printcharfun);
1db5b1ad 2008 strout (" in ", -1, -1, printcharfun);
4b4deea2 2009 print_string (BVAR (XMARKER (obj)->buffer, name), printcharfun);
ca0569ad 2010 }
38010d50 2011 PRINTCHAR ('>');
908b0ae5 2012 break;
00d76abc
KH
2013
2014 case Lisp_Misc_Overlay:
1db5b1ad 2015 strout ("#<overlay ", -1, -1, printcharfun);
cd3587c1 2016 if (! XMARKER (OVERLAY_START (obj))->buffer)
1db5b1ad 2017 strout ("in no buffer", -1, -1, printcharfun);
ca0569ad
RS
2018 else
2019 {
99027bdd
PE
2020 int len = sprintf (buf, "from %"pD"d to %"pD"d in ",
2021 marker_position (OVERLAY_START (obj)),
2022 marker_position (OVERLAY_END (obj)));
2023 strout (buf, len, len, printcharfun);
4b4deea2 2024 print_string (BVAR (XMARKER (OVERLAY_START (obj))->buffer, name),
ca0569ad
RS
2025 printcharfun);
2026 }
2027 PRINTCHAR ('>');
908b0ae5 2028 break;
00d76abc 2029
73ebd38f
DA
2030 /* Remaining cases shouldn't happen in normal usage, but let's
2031 print them anyway for the benefit of the debugger. */
2032
00d76abc 2033 case Lisp_Misc_Free:
1db5b1ad 2034 strout ("#<misc free cell>", -1, -1, printcharfun);
00d76abc
KH
2035 break;
2036
c069fee4 2037 case Lisp_Misc_Save_Value:
99027bdd 2038 {
6cda572a
DA
2039 int i;
2040 struct Lisp_Save_Value *v = XSAVE_VALUE (obj);
2041
2042 strout ("#<save-value ", -1, -1, printcharfun);
73ebd38f
DA
2043
2044 if (v->area)
6cda572a 2045 {
73ebd38f
DA
2046 ptrdiff_t amount = v->data[1].integer;
2047
2048#if GC_MARK_STACK
2049
2050 /* If GC_MARK_STACK, valid_lisp_object_p is quite reliable,
2051 and so we try to print up to 8 objects we have saved.
2052 Although valid_lisp_object_p is slow, this shouldn't be
2053 a real bottleneck because we do not use this code under
2054 normal circumstances. */
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
2079 /* If !GC_MARK_STACK, we have no reliable way to find
2080 whether Lisp_Object pointers points to an initialized
2081 objects, and so we do not ever trying to print them. */
2082
2083 i = sprintf (buf, "with %"pD"d objects", amount);
2084 strout (buf, i, i, printcharfun);
2085
2086#endif /* GC_MARK_STACK */
6cda572a
DA
2087 }
2088 else
2089 {
73ebd38f
DA
2090 /* Print each `data[N]' slot according to its type. */
2091
2092#define PRINTX(index) \
2093 do { \
2094 i = 0; \
2095 if (v->type ## index == SAVE_UNUSED) \
2096 i = sprintf (buf, "<unused>"); \
2097 else if (v->type ## index == SAVE_INTEGER) \
2098 i = sprintf (buf, "<integer %"pD"d>", v->data[index].integer); \
2099 else if (v->type ## index == SAVE_POINTER) \
2100 i = sprintf (buf, "<pointer %p>", v->data[index].pointer); \
2101 else /* SAVE_OBJECT */ \
2102 print_object (v->data[index].object, printcharfun, escapeflag); \
2103 if (i) \
2104 strout (buf, i, i, printcharfun); \
2105 } while (0)
2106
2107 PRINTX (0);
2108 PRINTCHAR (' ');
2109 PRINTX (1);
2110 PRINTCHAR (' ');
2111 PRINTX (2);
2112 PRINTCHAR (' ');
2113 PRINTX (3);
2114
2115#undef PRINTX
2116
6cda572a
DA
2117 }
2118 PRINTCHAR ('>');
99027bdd 2119 }
c069fee4
KS
2120 break;
2121
00d76abc
KH
2122 default:
2123 goto badtype;
e0f93814 2124 }
00d76abc 2125 break;
ca0569ad
RS
2126
2127 default:
00d76abc 2128 badtype:
ca0569ad 2129 {
99027bdd 2130 int len;
ca0569ad 2131 /* We're in trouble if this happens!
1088b922 2132 Probably should just emacs_abort (). */
1db5b1ad 2133 strout ("#<EMACS BUG: INVALID DATATYPE ", -1, -1, printcharfun);
00d76abc 2134 if (MISCP (obj))
99027bdd 2135 len = sprintf (buf, "(MISC 0x%04x)", (int) XMISCTYPE (obj));
00d76abc 2136 else if (VECTORLIKEP (obj))
99027bdd 2137 len = sprintf (buf, "(PVEC 0x%08"pD"x)", ASIZE (obj));
00d76abc 2138 else
99027bdd
PE
2139 len = sprintf (buf, "(0x%02x)", (int) XTYPE (obj));
2140 strout (buf, len, len, printcharfun);
ca0569ad 2141 strout (" Save your buffers immediately and please report this bug>",
1db5b1ad 2142 -1, -1, printcharfun);
ca0569ad 2143 }
38010d50
JB
2144 }
2145
2146 print_depth--;
2147}
2148\f
7651e1f5
RS
2149
2150/* Print a description of INTERVAL using PRINTCHARFUN.
2151 This is part of printing a string that has text properties. */
2152
12fbe755 2153static void
971de7fb 2154print_interval (INTERVAL interval, Lisp_Object printcharfun)
7651e1f5 2155{
71ea13cb
KH
2156 if (NILP (interval->plist))
2157 return;
30503c0b 2158 PRINTCHAR (' ');
0f25ecc6 2159 print_object (make_number (interval->position), printcharfun, 1);
7651e1f5 2160 PRINTCHAR (' ');
0f25ecc6 2161 print_object (make_number (interval->position + LENGTH (interval)),
cd3587c1 2162 printcharfun, 1);
7651e1f5 2163 PRINTCHAR (' ');
0f25ecc6 2164 print_object (interval->plist, printcharfun, 1);
7651e1f5
RS
2165}
2166
7651e1f5 2167\f
38010d50 2168void
971de7fb 2169syms_of_print (void)
38010d50 2170{
cd3520a4 2171 DEFSYM (Qtemp_buffer_setup_hook, "temp-buffer-setup-hook");
d9c21094 2172
29208e82 2173 DEFVAR_LISP ("standard-output", Vstandard_output,
8c1a1077
PJ
2174 doc: /* Output stream `print' uses by default for outputting a character.
2175This may be any function of one argument.
2176It may also be a buffer (output is inserted before point)
2177or a marker (output is inserted and the marker is advanced)
2178or the symbol t (output appears in the echo area). */);
38010d50 2179 Vstandard_output = Qt;
cd3520a4 2180 DEFSYM (Qstandard_output, "standard-output");
38010d50 2181
29208e82 2182 DEFVAR_LISP ("float-output-format", Vfloat_output_format,
8c1a1077
PJ
2183 doc: /* The format descriptor string used to print floats.
2184This is a %-spec like those accepted by `printf' in C,
2185but with some restrictions. It must start with the two characters `%.'.
2186After that comes an integer precision specification,
2187and then a letter which controls the format.
2188The letters allowed are `e', `f' and `g'.
2189Use `e' for exponential notation \"DIG.DIGITSeEXPT\"
2190Use `f' for decimal point notation \"DIGITS.DIGITS\".
2191Use `g' to choose the shorter of those two formats for the number at hand.
2192The precision in any of these cases is the number of digits following
2193the decimal point. With `f', a precision of 0 means to omit the
2194decimal point. 0 is not allowed with `e' or `g'.
2195
2196A value of nil means to use the shortest notation
2197that represents the number without losing information. */);
38010d50 2198 Vfloat_output_format = Qnil;
cd3520a4 2199 DEFSYM (Qfloat_output_format, "float-output-format");
38010d50 2200
29208e82 2201 DEFVAR_LISP ("print-length", Vprint_length,
8c1a1077
PJ
2202 doc: /* Maximum length of list to print before abbreviating.
2203A value of nil means no limit. See also `eval-expression-print-length'. */);
38010d50
JB
2204 Vprint_length = Qnil;
2205
29208e82 2206 DEFVAR_LISP ("print-level", Vprint_level,
8c1a1077
PJ
2207 doc: /* Maximum depth of list nesting to print before abbreviating.
2208A value of nil means no limit. See also `eval-expression-print-level'. */);
38010d50
JB
2209 Vprint_level = Qnil;
2210
29208e82 2211 DEFVAR_BOOL ("print-escape-newlines", print_escape_newlines,
8c1a1077
PJ
2212 doc: /* Non-nil means print newlines in strings as `\\n'.
2213Also print formfeeds as `\\f'. */);
38010d50
JB
2214 print_escape_newlines = 0;
2215
29208e82 2216 DEFVAR_BOOL ("print-escape-nonascii", print_escape_nonascii,
8c1a1077
PJ
2217 doc: /* Non-nil means print unibyte non-ASCII chars in strings as \\OOO.
2218\(OOO is the octal representation of the character code.)
249c0f71
RS
2219Only single-byte characters are affected, and only in `prin1'.
2220When the output goes in a multibyte buffer, this feature is
2221enabled regardless of the value of the variable. */);
38940e93
RS
2222 print_escape_nonascii = 0;
2223
29208e82 2224 DEFVAR_BOOL ("print-escape-multibyte", print_escape_multibyte,
8c1a1077
PJ
2225 doc: /* Non-nil means print multibyte characters in strings as \\xXXXX.
2226\(XXXX is the hex representation of the character code.)
2227This affects only `prin1'. */);
835d0be6
RS
2228 print_escape_multibyte = 0;
2229
29208e82 2230 DEFVAR_BOOL ("print-quoted", print_quoted,
8c1a1077 2231 doc: /* Non-nil means print quoted forms with reader syntax.
db75cb5f 2232I.e., (quote foo) prints as 'foo, (function foo) as #'foo. */);
2f100b5c
EN
2233 print_quoted = 0;
2234
29208e82 2235 DEFVAR_LISP ("print-gensym", Vprint_gensym,
8c1a1077
PJ
2236 doc: /* Non-nil means print uninterned symbols so they will read as uninterned.
2237I.e., the value of (make-symbol \"foobar\") prints as #:foobar.
2238When the uninterned symbol appears within a recursive data structure,
2239and the symbol appears more than once, in addition use the #N# and #N=
2240constructs as needed, so that multiple references to the same symbol are
2241shared once again when the text is read back. */);
e0f69431
RS
2242 Vprint_gensym = Qnil;
2243
29208e82 2244 DEFVAR_LISP ("print-circle", Vprint_circle,
fb7ada5f 2245 doc: /* Non-nil means print recursive structures using #N= and #N# syntax.
8c1a1077
PJ
2246If nil, printing proceeds recursively and may lead to
2247`max-lisp-eval-depth' being exceeded or an error may occur:
2248\"Apparently circular structure being printed.\" Also see
2249`print-length' and `print-level'.
2250If non-nil, shared substructures anywhere in the structure are printed
2251with `#N=' before the first occurrence (in the order of the print
2252representation) and `#N#' in place of each subsequent occurrence,
2253where N is a positive decimal integer. */);
0f25ecc6
RS
2254 Vprint_circle = Qnil;
2255
29208e82 2256 DEFVAR_LISP ("print-continuous-numbering", Vprint_continuous_numbering,
fb7ada5f 2257 doc: /* Non-nil means number continuously across print calls.
8c1a1077
PJ
2258This affects the numbers printed for #N= labels and #M# references.
2259See also `print-circle', `print-gensym', and `print-number-table'.
2260This variable should not be set with `setq'; bind it with a `let' instead. */);
0f25ecc6
RS
2261 Vprint_continuous_numbering = Qnil;
2262
29208e82 2263 DEFVAR_LISP ("print-number-table", Vprint_number_table,
8c1a1077
PJ
2264 doc: /* A vector used internally to produce `#N=' labels and `#N#' references.
2265The Lisp printer uses this vector to detect Lisp objects referenced more
e6d4cddd
RS
2266than once.
2267
2268When you bind `print-continuous-numbering' to t, you should probably
2269also bind `print-number-table' to nil. This ensures that the value of
2270`print-number-table' can be garbage-collected once the printing is
2271done. If all elements of `print-number-table' are nil, it means that
2272the printing done so far has not found any shared structure or objects
2273that need to be recorded in the table. */);
0f25ecc6 2274 Vprint_number_table = Qnil;
081e0581 2275
29208e82 2276 DEFVAR_LISP ("print-charset-text-property", Vprint_charset_text_property,
71ea13cb
KH
2277 doc: /* A flag to control printing of `charset' text property on printing a string.
2278The value must be nil, t, or `default'.
2279
2280If the value is nil, don't print the text property `charset'.
2281
2282If the value is t, always print the text property `charset'.
2283
2284If the value is `default', print the text property `charset' only when
2285the value is different from what is guessed in the current charset
dedbd91c 2286priorities. */);
71ea13cb
KH
2287 Vprint_charset_text_property = Qdefault;
2288
38010d50
JB
2289 /* prin1_to_string_buffer initialized in init_buffer_once in buffer.c */
2290 staticpro (&Vprin1_to_string_buffer);
2291
2292 defsubr (&Sprin1);
2293 defsubr (&Sprin1_to_string);
113620cc 2294 defsubr (&Serror_message_string);
38010d50
JB
2295 defsubr (&Sprinc);
2296 defsubr (&Sprint);
2297 defsubr (&Sterpri);
2298 defsubr (&Swrite_char);
2299 defsubr (&Sexternal_debugging_output);
6b61353c
KH
2300#ifdef WITH_REDIRECT_DEBUGGING_OUTPUT
2301 defsubr (&Sredirect_debugging_output);
2302#endif
38010d50 2303
cd3520a4
JB
2304 DEFSYM (Qexternal_debugging_output, "external-debugging-output");
2305 DEFSYM (Qprint_escape_newlines, "print-escape-newlines");
2306 DEFSYM (Qprint_escape_multibyte, "print-escape-multibyte");
2307 DEFSYM (Qprint_escape_nonascii, "print-escape-nonascii");
835d0be6 2308
71ea13cb
KH
2309 print_prune_charset_plist = Qnil;
2310 staticpro (&print_prune_charset_plist);
38010d50 2311}