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