(Finsert_file_contents): Use delete_all_overlays.
[bpt/emacs.git] / src / print.c
CommitLineData
38010d50 1/* Lisp object printing and output streams.
26a59e42 2 Copyright (C) 1985, 86, 88, 93, 94, 95, 97, 98, 1999, 2000, 01, 2003
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
RS
508 else
509 for (i = 0; i < size_byte; i++)
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;
fd531951
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
EN
761 PRINTDECLARE;
762 Lisp_Object printcharfun;
ca2de342
RS
763 /* struct gcpro gcpro1, gcpro2; */
764 Lisp_Object save_deactivate_mark;
765 int count = specpdl_ptr - specpdl;
766
767 specbind (Qinhibit_modification_hooks, Qt);
2a42e8f6
KH
768
769 /* Save and restore this--we are altering a buffer
770 but we don't want to deactivate the mark just for that.
771 No need for specbind, since errors deactivate the mark. */
ca2de342
RS
772 save_deactivate_mark = Vdeactivate_mark;
773 /* GCPRO2 (object, save_deactivate_mark); */
774 abort_on_gc++;
38010d50
JB
775
776 printcharfun = Vprin1_to_string_buffer;
777 PRINTPREPARE;
3738a371 778 print (object, printcharfun, NILP (noescape));
38010d50
JB
779 /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
780 PRINTFINISH;
781 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
3738a371 782 object = Fbuffer_string ();
b51ee131
SM
783 if (SBYTES (object) == SCHARS (object))
784 STRING_SET_UNIBYTE (object);
38010d50 785
38010d50
JB
786 Ferase_buffer ();
787 set_buffer_internal (old);
2a42e8f6 788
ca2de342
RS
789 Vdeactivate_mark = save_deactivate_mark;
790 /* UNGCPRO; */
38010d50 791
ca2de342
RS
792 abort_on_gc--;
793 return unbind_to (count, object);
38010d50
JB
794}
795
796DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
8c1a1077
PJ
797 doc: /* Output the printed representation of OBJECT, any Lisp object.
798No quoting characters are used; no delimiters are printed around
799the contents of strings.
800
801OBJECT is any of the Lisp data types: a number, a string, a symbol,
802a list, a buffer, a window, a frame, etc.
803
804A printed representation of an object is text which describes that object.
805
806Optional argument PRINTCHARFUN is the output stream, which can be one
807of these:
808
809 - a buffer, in which case output is inserted into that buffer at point;
810 - a marker, in which case output is inserted at marker's position;
811 - a function, in which case that function is called once for each
812 character of OBJECT's printed representation;
813 - a symbol, in which case that symbol's function definition is called; or
814 - t, in which case the output is displayed in the echo area.
815
816If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
817is used instead. */)
818 (object, printcharfun)
3738a371 819 Lisp_Object object, printcharfun;
38010d50 820{
081e0581 821 PRINTDECLARE;
38010d50 822
10eebdbb 823 if (NILP (printcharfun))
38010d50
JB
824 printcharfun = Vstandard_output;
825 PRINTPREPARE;
3738a371 826 print (object, printcharfun, 0);
38010d50 827 PRINTFINISH;
3738a371 828 return object;
38010d50
JB
829}
830
831DEFUN ("print", Fprint, Sprint, 1, 2, 0,
8c1a1077
PJ
832 doc: /* Output the printed representation of OBJECT, with newlines around it.
833Quoting characters are printed when needed to make output that `read'
9474c847 834can handle, whenever this is possible. For complex objects, the behavior
7fab9223 835is controlled by `print-level' and `print-length', which see.
8c1a1077
PJ
836
837OBJECT is any of the Lisp data types: a number, a string, a symbol,
838a list, a buffer, a window, a frame, etc.
839
840A printed representation of an object is text which describes that object.
841
842Optional argument PRINTCHARFUN is the output stream, which can be one
843of these:
844
845 - a buffer, in which case output is inserted into that buffer at point;
846 - a marker, in which case output is inserted at marker's position;
847 - a function, in which case that function is called once for each
848 character of OBJECT's printed representation;
849 - a symbol, in which case that symbol's function definition is called; or
850 - t, in which case the output is displayed in the echo area.
851
852If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
853is used instead. */)
854 (object, printcharfun)
3738a371 855 Lisp_Object object, printcharfun;
38010d50 856{
081e0581 857 PRINTDECLARE;
38010d50
JB
858 struct gcpro gcpro1;
859
860#ifdef MAX_PRINT_CHARS
861 print_chars = 0;
862 max_print = MAX_PRINT_CHARS;
863#endif /* MAX_PRINT_CHARS */
10eebdbb 864 if (NILP (printcharfun))
38010d50 865 printcharfun = Vstandard_output;
3738a371 866 GCPRO1 (object);
38010d50 867 PRINTPREPARE;
38010d50 868 PRINTCHAR ('\n');
3738a371 869 print (object, printcharfun, 1);
38010d50
JB
870 PRINTCHAR ('\n');
871 PRINTFINISH;
872#ifdef MAX_PRINT_CHARS
873 max_print = 0;
874 print_chars = 0;
875#endif /* MAX_PRINT_CHARS */
876 UNGCPRO;
3738a371 877 return object;
38010d50
JB
878}
879
880/* The subroutine object for external-debugging-output is kept here
881 for the convenience of the debugger. */
882Lisp_Object Qexternal_debugging_output;
883
4746118a 884DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
8c1a1077
PJ
885 doc: /* Write CHARACTER to stderr.
886You can call print while debugging emacs, and pass it this function
887to make it write to the debugging output. */)
888 (character)
4746118a 889 Lisp_Object character;
38010d50 890{
b7826503 891 CHECK_NUMBER (character);
38010d50 892 putc (XINT (character), stderr);
cd22039d
RS
893
894#ifdef WINDOWSNT
895 /* Send the output to a debugger (nothing happens if there isn't one). */
896 {
897 char buf[2] = {(char) XINT (character), '\0'};
898 OutputDebugString (buf);
899 }
900#endif
901
38010d50
JB
902 return character;
903}
cf1bb91b
RS
904
905/* This is the interface for debugging printing. */
906
907void
908debug_print (arg)
909 Lisp_Object arg;
910{
911 Fprin1 (arg, Qexternal_debugging_output);
3684eb78 912 fprintf (stderr, "\r\n");
cf1bb91b 913}
38010d50 914\f
113620cc
KH
915DEFUN ("error-message-string", Ferror_message_string, Serror_message_string,
916 1, 1, 0,
8c1a1077
PJ
917 doc: /* Convert an error value (ERROR-SYMBOL . DATA) to an error message. */)
918 (obj)
113620cc
KH
919 Lisp_Object obj;
920{
921 struct buffer *old = current_buffer;
63fbf4ff 922 Lisp_Object value;
113620cc
KH
923 struct gcpro gcpro1;
924
0872e11f
RS
925 /* If OBJ is (error STRING), just return STRING.
926 That is not only faster, it also avoids the need to allocate
927 space here when the error is due to memory full. */
94b342ce
KR
928 if (CONSP (obj) && EQ (XCAR (obj), Qerror)
929 && CONSP (XCDR (obj))
930 && STRINGP (XCAR (XCDR (obj)))
931 && NILP (XCDR (XCDR (obj))))
932 return XCAR (XCDR (obj));
0872e11f 933
240e806c 934 print_error_message (obj, Vprin1_to_string_buffer, 0, Qnil);
113620cc
KH
935
936 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
937 value = Fbuffer_string ();
938
939 GCPRO1 (value);
940 Ferase_buffer ();
941 set_buffer_internal (old);
942 UNGCPRO;
943
944 return value;
945}
946
c02279de
GM
947/* Print an error message for the error DATA onto Lisp output stream
948 STREAM (suitable for the print functions). */
113620cc 949
dc22f25e 950void
240e806c 951print_error_message (data, stream, context, caller)
113620cc 952 Lisp_Object data, stream;
240e806c
RS
953 char *context;
954 Lisp_Object caller;
113620cc
KH
955{
956 Lisp_Object errname, errmsg, file_error, tail;
957 struct gcpro gcpro1;
958 int i;
959
240e806c
RS
960 if (context != 0)
961 write_string_1 (context, -1, stream);
962
963 /* If we know from where the error was signaled, show it in
964 *Messages*. */
965 if (!NILP (caller) && SYMBOLP (caller))
966 {
967 const char *name = SDATA (SYMBOL_NAME (caller));
968 message_dolog (name, strlen (name), 0, 0);
969 message_dolog (": ", 2, 0, 0);
970 }
971
113620cc
KH
972 errname = Fcar (data);
973
974 if (EQ (errname, Qerror))
975 {
976 data = Fcdr (data);
c02279de
GM
977 if (!CONSP (data))
978 data = Qnil;
113620cc
KH
979 errmsg = Fcar (data);
980 file_error = Qnil;
981 }
982 else
983 {
c02279de 984 Lisp_Object error_conditions;
113620cc 985 errmsg = Fget (errname, Qerror_message);
c02279de
GM
986 error_conditions = Fget (errname, Qerror_conditions);
987 file_error = Fmemq (Qfile_error, error_conditions);
113620cc
KH
988 }
989
990 /* Print an error message including the data items. */
991
992 tail = Fcdr_safe (data);
993 GCPRO1 (tail);
994
995 /* For file-error, make error message by concatenating
996 all the data items. They are all strings. */
8c29413d 997 if (!NILP (file_error) && CONSP (tail))
94b342ce 998 errmsg = XCAR (tail), tail = XCDR (tail);
113620cc
KH
999
1000 if (STRINGP (errmsg))
1001 Fprinc (errmsg, stream);
1002 else
1003 write_string_1 ("peculiar error", -1, stream);
1004
c02279de 1005 for (i = 0; CONSP (tail); tail = XCDR (tail), i++)
113620cc 1006 {
c02279de
GM
1007 Lisp_Object obj;
1008
113620cc 1009 write_string_1 (i ? ", " : ": ", 2, stream);
c02279de
GM
1010 obj = XCAR (tail);
1011 if (!NILP (file_error) || EQ (errname, Qend_of_file))
1012 Fprinc (obj, stream);
113620cc 1013 else
c02279de 1014 Fprin1 (obj, stream);
113620cc 1015 }
177c0ea7 1016
113620cc
KH
1017 UNGCPRO;
1018}
38010d50 1019
c02279de
GM
1020
1021\f
38010d50 1022/*
edb2a707 1023 * The buffer should be at least as large as the max string size of the
8e6208c5 1024 * largest float, printed in the biggest notation. This is undoubtedly
38010d50
JB
1025 * 20d float_output_format, with the negative of the C-constant "HUGE"
1026 * from <math.h>.
177c0ea7 1027 *
38010d50 1028 * On the vax the worst case is -1e38 in 20d format which takes 61 bytes.
177c0ea7 1029 *
38010d50
JB
1030 * I assume that IEEE-754 format numbers can take 329 bytes for the worst
1031 * case of -1e307 in 20d float_output_format. What is one to do (short of
1032 * re-writing _doprnt to be more sane)?
1033 * -wsr
1034 */
edb2a707
RS
1035
1036void
1037float_to_string (buf, data)
8b24d146 1038 unsigned char *buf;
38010d50
JB
1039 double data;
1040{
c7b14277 1041 unsigned char *cp;
322890c4 1042 int width;
177c0ea7 1043
7f45de2d
RS
1044 /* Check for plus infinity in a way that won't lose
1045 if there is no plus infinity. */
1046 if (data == data / 2 && data > 1.0)
1047 {
1048 strcpy (buf, "1.0e+INF");
1049 return;
1050 }
1051 /* Likewise for minus infinity. */
1052 if (data == data / 2 && data < -1.0)
1053 {
1054 strcpy (buf, "-1.0e+INF");
1055 return;
1056 }
1057 /* Check for NaN in a way that won't fail if there are no NaNs. */
1058 if (! (data * 0.0 >= 0.0))
1059 {
68c45bf0
PE
1060 /* Prepend "-" if the NaN's sign bit is negative.
1061 The sign bit of a double is the bit that is 1 in -0.0. */
1062 int i;
1063 union { double d; char c[sizeof (double)]; } u_data, u_minus_zero;
1064 u_data.d = data;
1065 u_minus_zero.d = - 0.0;
1066 for (i = 0; i < sizeof (double); i++)
1067 if (u_data.c[i] & u_minus_zero.c[i])
1068 {
1069 *buf++ = '-';
1070 break;
1071 }
177c0ea7 1072
7f45de2d
RS
1073 strcpy (buf, "0.0e+NaN");
1074 return;
1075 }
1076
10eebdbb 1077 if (NILP (Vfloat_output_format)
d4ae1f7e 1078 || !STRINGP (Vfloat_output_format))
38010d50 1079 lose:
322890c4 1080 {
f356c3fb
PE
1081 /* Generate the fewest number of digits that represent the
1082 floating point value without losing information.
1083 The following method is simple but a bit slow.
1084 For ideas about speeding things up, please see:
1085
1086 Guy L Steele Jr & Jon L White, How to print floating-point numbers
1087 accurately. SIGPLAN notices 25, 6 (June 1990), 112-126.
1088
1089 Robert G Burger & R Kent Dybvig, Printing floating point numbers
1090 quickly and accurately, SIGPLAN notices 31, 5 (May 1996), 108-116. */
1091
1092 width = fabs (data) < DBL_MIN ? 1 : DBL_DIG;
1093 do
1094 sprintf (buf, "%.*g", width, data);
1095 while (width++ < DOUBLE_DIGITS_BOUND && atof (buf) != data);
322890c4 1096 }
38010d50
JB
1097 else /* oink oink */
1098 {
1099 /* Check that the spec we have is fully valid.
1100 This means not only valid for printf,
1101 but meant for floats, and reasonable. */
d5db4077 1102 cp = SDATA (Vfloat_output_format);
38010d50
JB
1103
1104 if (cp[0] != '%')
1105 goto lose;
1106 if (cp[1] != '.')
1107 goto lose;
1108
1109 cp += 2;
c7b14277
JB
1110
1111 /* Check the width specification. */
322890c4 1112 width = -1;
c7b14277 1113 if ('0' <= *cp && *cp <= '9')
381cd4bb
KH
1114 {
1115 width = 0;
1116 do
1117 width = (width * 10) + (*cp++ - '0');
1118 while (*cp >= '0' && *cp <= '9');
1119
1120 /* A precision of zero is valid only for %f. */
1121 if (width > DBL_DIG
1122 || (width == 0 && *cp != 'f'))
1123 goto lose;
1124 }
38010d50
JB
1125
1126 if (*cp != 'e' && *cp != 'f' && *cp != 'g')
1127 goto lose;
1128
38010d50
JB
1129 if (cp[1] != 0)
1130 goto lose;
1131
d5db4077 1132 sprintf (buf, SDATA (Vfloat_output_format), data);
38010d50 1133 }
edb2a707 1134
c7b14277
JB
1135 /* Make sure there is a decimal point with digit after, or an
1136 exponent, so that the value is readable as a float. But don't do
322890c4
RS
1137 this with "%.0f"; it's valid for that not to produce a decimal
1138 point. Note that width can be 0 only for %.0f. */
1139 if (width != 0)
0601fd3d 1140 {
c7b14277
JB
1141 for (cp = buf; *cp; cp++)
1142 if ((*cp < '0' || *cp > '9') && *cp != '-')
1143 break;
0601fd3d 1144
c7b14277
JB
1145 if (*cp == '.' && cp[1] == 0)
1146 {
1147 cp[1] = '0';
1148 cp[2] = 0;
1149 }
1150
1151 if (*cp == 0)
1152 {
1153 *cp++ = '.';
1154 *cp++ = '0';
1155 *cp++ = 0;
1156 }
edb2a707 1157 }
38010d50 1158}
cc94f3b2 1159
38010d50
JB
1160\f
1161static void
1162print (obj, printcharfun, escapeflag)
38010d50 1163 Lisp_Object obj;
38010d50
JB
1164 register Lisp_Object printcharfun;
1165 int escapeflag;
1166{
0f25ecc6 1167 print_depth = 0;
0330bb60 1168 old_backquote_output = 0;
38010d50 1169
0f25ecc6
RS
1170 /* Reset print_number_index and Vprint_number_table only when
1171 the variable Vprint_continuous_numbering is nil. Otherwise,
1172 the values of these variables will be kept between several
1173 print functions. */
1174 if (NILP (Vprint_continuous_numbering))
1175 {
1176 print_number_index = 0;
1177 Vprint_number_table = Qnil;
1178 }
38010d50 1179
0f25ecc6
RS
1180 /* Construct Vprint_number_table for print-gensym and print-circle. */
1181 if (!NILP (Vprint_gensym) || !NILP (Vprint_circle))
ec838c39 1182 {
73fb36f1 1183 int i, start, index;
73fb36f1 1184 start = index = print_number_index;
e6d4cddd
RS
1185 /* Construct Vprint_number_table.
1186 This increments print_number_index for the objects added. */
0f25ecc6 1187 print_preprocess (obj);
e6d4cddd 1188
0f25ecc6 1189 /* Remove unnecessary objects, which appear only once in OBJ;
e6d4cddd 1190 that is, whose status is Qnil. Compactify the necessary objects. */
73fb36f1 1191 for (i = start; i < print_number_index; i++)
0f25ecc6
RS
1192 if (!NILP (PRINT_NUMBER_STATUS (Vprint_number_table, i)))
1193 {
1194 PRINT_NUMBER_OBJECT (Vprint_number_table, index)
1195 = PRINT_NUMBER_OBJECT (Vprint_number_table, i);
0f25ecc6
RS
1196 index++;
1197 }
e6d4cddd
RS
1198
1199 /* Clear out objects outside the active part of the table. */
1200 for (i = index; i < print_number_index; i++)
1201 PRINT_NUMBER_OBJECT (Vprint_number_table, i) = Qnil;
1202
1203 /* Reset the status field for the next print step. Now this
1204 field means whether the object has already been printed. */
1205 for (i = start; i < print_number_index; i++)
1206 PRINT_NUMBER_STATUS (Vprint_number_table, i) = Qnil;
1207
0f25ecc6
RS
1208 print_number_index = index;
1209 }
1210
1211 print_object (obj, printcharfun, escapeflag);
1212}
1213
1214/* Construct Vprint_number_table according to the structure of OBJ.
1215 OBJ itself and all its elements will be added to Vprint_number_table
1216 recursively if it is a list, vector, compiled function, char-table,
1217 string (its text properties will be traced), or a symbol that has
1218 no obarray (this is for the print-gensym feature).
1219 The status fields of Vprint_number_table mean whether each object appears
1220 more than once in OBJ: Qnil at the first time, and Qt after that . */
1221static void
1222print_preprocess (obj)
1223 Lisp_Object obj;
1224{
1225 int i, size;
1226
1227 loop:
1228 if (STRINGP (obj) || CONSP (obj) || VECTORP (obj)
1229 || COMPILEDP (obj) || CHAR_TABLE_P (obj)
1230 || (! NILP (Vprint_gensym)
bf9f2aab
GM
1231 && SYMBOLP (obj)
1232 && !SYMBOL_INTERNED_P (obj)))
0f25ecc6 1233 {
aca2020b
KH
1234 /* In case print-circle is nil and print-gensym is t,
1235 add OBJ to Vprint_number_table only when OBJ is a symbol. */
1236 if (! NILP (Vprint_circle) || SYMBOLP (obj))
0f25ecc6 1237 {
0f25ecc6 1238 for (i = 0; i < print_number_index; i++)
7c752c80 1239 if (EQ (PRINT_NUMBER_OBJECT (Vprint_number_table, i), obj))
aca2020b
KH
1240 {
1241 /* OBJ appears more than once. Let's remember that. */
1242 PRINT_NUMBER_STATUS (Vprint_number_table, i) = Qt;
1243 return;
1244 }
1245
1246 /* OBJ is not yet recorded. Let's add to the table. */
1247 if (print_number_index == 0)
1248 {
1249 /* Initialize the table. */
1250 Vprint_number_table = Fmake_vector (make_number (40), Qnil);
1251 }
1252 else if (XVECTOR (Vprint_number_table)->size == print_number_index * 2)
0f25ecc6 1253 {
aca2020b
KH
1254 /* Reallocate the table. */
1255 int i = print_number_index * 4;
1256 Lisp_Object old_table = Vprint_number_table;
1257 Vprint_number_table = Fmake_vector (make_number (i), Qnil);
1258 for (i = 0; i < print_number_index; i++)
1259 {
1260 PRINT_NUMBER_OBJECT (Vprint_number_table, i)
1261 = PRINT_NUMBER_OBJECT (old_table, i);
1262 PRINT_NUMBER_STATUS (Vprint_number_table, i)
1263 = PRINT_NUMBER_STATUS (old_table, i);
1264 }
0f25ecc6 1265 }
aca2020b
KH
1266 PRINT_NUMBER_OBJECT (Vprint_number_table, print_number_index) = obj;
1267 /* If Vprint_continuous_numbering is non-nil and OBJ is a gensym,
1268 always print the gensym with a number. This is a special for
1269 the lisp function byte-compile-output-docform. */
bf9f2aab
GM
1270 if (!NILP (Vprint_continuous_numbering)
1271 && SYMBOLP (obj)
1272 && !SYMBOL_INTERNED_P (obj))
aca2020b
KH
1273 PRINT_NUMBER_STATUS (Vprint_number_table, print_number_index) = Qt;
1274 print_number_index++;
0f25ecc6 1275 }
0f25ecc6
RS
1276
1277 switch (XGCTYPE (obj))
1278 {
1279 case Lisp_String:
0f25ecc6 1280 /* A string may have text properties, which can be circular. */
d5db4077 1281 traverse_intervals_noorder (STRING_INTERVALS (obj),
8bbfc258 1282 print_preprocess_string, Qnil);
0f25ecc6
RS
1283 break;
1284
1285 case Lisp_Cons:
1286 print_preprocess (XCAR (obj));
1287 obj = XCDR (obj);
1288 goto loop;
1289
1290 case Lisp_Vectorlike:
1291 size = XVECTOR (obj)->size & PSEUDOVECTOR_SIZE_MASK;
1292 for (i = 0; i < size; i++)
1293 print_preprocess (XVECTOR (obj)->contents[i]);
ee5263af
GM
1294 break;
1295
1296 default:
1297 break;
0f25ecc6
RS
1298 }
1299 }
1300}
1301
0f25ecc6
RS
1302static void
1303print_preprocess_string (interval, arg)
1304 INTERVAL interval;
1305 Lisp_Object arg;
1306{
1307 print_preprocess (interval->plist);
1308}
0f25ecc6
RS
1309
1310static void
1311print_object (obj, printcharfun, escapeflag)
1312 Lisp_Object obj;
1313 register Lisp_Object printcharfun;
1314 int escapeflag;
1315{
1316 char buf[30];
1317
1318 QUIT;
1319
1320 /* Detect circularities and truncate them. */
1321 if (STRINGP (obj) || CONSP (obj) || VECTORP (obj)
1322 || COMPILEDP (obj) || CHAR_TABLE_P (obj)
1323 || (! NILP (Vprint_gensym)
bf9f2aab
GM
1324 && SYMBOLP (obj)
1325 && !SYMBOL_INTERNED_P (obj)))
0f25ecc6
RS
1326 {
1327 if (NILP (Vprint_circle) && NILP (Vprint_gensym))
1328 {
1329 /* Simple but incomplete way. */
1330 int i;
1331 for (i = 0; i < print_depth; i++)
1332 if (EQ (obj, being_printed[i]))
1333 {
1334 sprintf (buf, "#%d", i);
1335 strout (buf, -1, -1, printcharfun, 0);
1336 return;
1337 }
1338 being_printed[print_depth] = obj;
1339 }
1340 else
1341 {
1342 /* With the print-circle feature. */
1343 int i;
1344 for (i = 0; i < print_number_index; i++)
7c752c80 1345 if (EQ (PRINT_NUMBER_OBJECT (Vprint_number_table, i), obj))
0f25ecc6
RS
1346 {
1347 if (NILP (PRINT_NUMBER_STATUS (Vprint_number_table, i)))
1348 {
1349 /* Add a prefix #n= if OBJ has not yet been printed;
1350 that is, its status field is nil. */
1351 sprintf (buf, "#%d=", i + 1);
1352 strout (buf, -1, -1, printcharfun, 0);
1353 /* OBJ is going to be printed. Set the status to t. */
1354 PRINT_NUMBER_STATUS (Vprint_number_table, i) = Qt;
1355 break;
1356 }
1357 else
1358 {
1359 /* Just print #n# if OBJ has already been printed. */
1360 sprintf (buf, "#%d#", i + 1);
1361 strout (buf, -1, -1, printcharfun, 0);
1362 return;
1363 }
1364 }
1365 }
ec838c39 1366 }
ec838c39 1367
38010d50
JB
1368 print_depth++;
1369
ec838c39 1370 if (print_depth > PRINT_CIRCLE)
38010d50
JB
1371 error ("Apparently circular structure being printed");
1372#ifdef MAX_PRINT_CHARS
1373 if (max_print && print_chars > max_print)
1374 {
1375 PRINTCHAR ('\n');
1376 print_chars = 0;
1377 }
1378#endif /* MAX_PRINT_CHARS */
1379
ca0569ad 1380 switch (XGCTYPE (obj))
38010d50 1381 {
ca0569ad 1382 case Lisp_Int:
b8180922
RS
1383 if (sizeof (int) == sizeof (EMACS_INT))
1384 sprintf (buf, "%d", XINT (obj));
1385 else if (sizeof (long) == sizeof (EMACS_INT))
63fbf4ff 1386 sprintf (buf, "%ld", (long) XINT (obj));
b8180922
RS
1387 else
1388 abort ();
dc2a0b79 1389 strout (buf, -1, -1, printcharfun, 0);
ca0569ad
RS
1390 break;
1391
ca0569ad
RS
1392 case Lisp_Float:
1393 {
1394 char pigbuf[350]; /* see comments in float_to_string */
38010d50 1395
94b342ce 1396 float_to_string (pigbuf, XFLOAT_DATA (obj));
dc2a0b79 1397 strout (pigbuf, -1, -1, printcharfun, 0);
ca0569ad
RS
1398 }
1399 break;
ca0569ad
RS
1400
1401 case Lisp_String:
38010d50
JB
1402 if (!escapeflag)
1403 print_string (obj, printcharfun);
1404 else
1405 {
dc2a0b79 1406 register int i, i_byte;
38010d50 1407 struct gcpro gcpro1;
872a36d2 1408 unsigned char *str;
dc2a0b79 1409 int size_byte;
453fa987
RS
1410 /* 1 means we must ensure that the next character we output
1411 cannot be taken as part of a hex character escape. */
1412 int need_nonhex = 0;
db300f59 1413 int multibyte = STRING_MULTIBYTE (obj);
38010d50 1414
7651e1f5
RS
1415 GCPRO1 (obj);
1416
d5db4077 1417 if (!NULL_INTERVAL_P (STRING_INTERVALS (obj)))
7651e1f5
RS
1418 {
1419 PRINTCHAR ('#');
1420 PRINTCHAR ('(');
1421 }
38010d50
JB
1422
1423 PRINTCHAR ('\"');
d5db4077
KR
1424 str = SDATA (obj);
1425 size_byte = SBYTES (obj);
dc2a0b79
RS
1426
1427 for (i = 0, i_byte = 0; i_byte < size_byte;)
38010d50 1428 {
6ddd6eee
RS
1429 /* Here, we must convert each multi-byte form to the
1430 corresponding character code before handing it to PRINTCHAR. */
1431 int len;
dc2a0b79
RS
1432 int c;
1433
db300f59 1434 if (multibyte)
872a36d2 1435 {
765fe1d0
KH
1436 c = STRING_CHAR_AND_LENGTH (str + i_byte,
1437 size_byte - i_byte, len);
da1ad4e7
KH
1438 if (CHAR_VALID_P (c, 0))
1439 i_byte += len;
1440 else
1441 c = str[i_byte++];
872a36d2 1442 }
dc2a0b79 1443 else
872a36d2 1444 c = str[i_byte++];
dc2a0b79 1445
38010d50 1446 QUIT;
6ddd6eee 1447
38010d50
JB
1448 if (c == '\n' && print_escape_newlines)
1449 {
1450 PRINTCHAR ('\\');
1451 PRINTCHAR ('n');
1452 }
c6f7982f
RM
1453 else if (c == '\f' && print_escape_newlines)
1454 {
1455 PRINTCHAR ('\\');
1456 PRINTCHAR ('f');
1457 }
ae7367d3
RS
1458 else if (multibyte
1459 && ! ASCII_BYTE_P (c)
1460 && (SINGLE_BYTE_CHAR_P (c) || print_escape_multibyte))
dc2a0b79
RS
1461 {
1462 /* When multibyte is disabled,
ae7367d3
RS
1463 print multibyte string chars using hex escapes.
1464 For a char code that could be in a unibyte string,
1465 when found in a multibyte string, always use a hex escape
1466 so it reads back as multibyte. */
dc2a0b79
RS
1467 unsigned char outbuf[50];
1468 sprintf (outbuf, "\\x%x", c);
1469 strout (outbuf, -1, -1, printcharfun, 0);
453fa987 1470 need_nonhex = 1;
dc2a0b79 1471 }
db300f59
RS
1472 else if (! multibyte
1473 && SINGLE_BYTE_CHAR_P (c) && ! ASCII_BYTE_P (c)
835d0be6 1474 && print_escape_nonascii)
974a6ff5 1475 {
835d0be6
RS
1476 /* When printing in a multibyte buffer
1477 or when explicitly requested,
974a6ff5
KH
1478 print single-byte non-ASCII string chars
1479 using octal escapes. */
1480 unsigned char outbuf[5];
1481 sprintf (outbuf, "\\%03o", c);
1482 strout (outbuf, -1, -1, printcharfun, 0);
1483 }
38010d50
JB
1484 else
1485 {
453fa987
RS
1486 /* If we just had a hex escape, and this character
1487 could be taken as part of it,
1488 output `\ ' to prevent that. */
1b62edd6
KH
1489 if (need_nonhex)
1490 {
1491 need_nonhex = 0;
1492 if ((c >= 'a' && c <= 'f')
453fa987 1493 || (c >= 'A' && c <= 'F')
1b62edd6
KH
1494 || (c >= '0' && c <= '9'))
1495 strout ("\\ ", -1, -1, printcharfun, 0);
1496 }
453fa987 1497
38010d50
JB
1498 if (c == '\"' || c == '\\')
1499 PRINTCHAR ('\\');
1500 PRINTCHAR (c);
1501 }
1502 }
1503 PRINTCHAR ('\"');
7651e1f5 1504
d5db4077 1505 if (!NULL_INTERVAL_P (STRING_INTERVALS (obj)))
7651e1f5 1506 {
d5db4077 1507 traverse_intervals (STRING_INTERVALS (obj),
8bbfc258 1508 0, print_interval, printcharfun);
7651e1f5
RS
1509 PRINTCHAR (')');
1510 }
7651e1f5 1511
38010d50
JB
1512 UNGCPRO;
1513 }
ca0569ad 1514 break;
38010d50 1515
ca0569ad
RS
1516 case Lisp_Symbol:
1517 {
1518 register int confusing;
d5db4077
KR
1519 register unsigned char *p = SDATA (SYMBOL_NAME (obj));
1520 register unsigned char *end = p + SBYTES (SYMBOL_NAME (obj));
2190a05e 1521 register int c;
dc2a0b79
RS
1522 int i, i_byte, size_byte;
1523 Lisp_Object name;
1524
76d0b3ae 1525 name = SYMBOL_NAME (obj);
ca0569ad
RS
1526
1527 if (p != end && (*p == '-' || *p == '+')) p++;
1528 if (p == end)
1529 confusing = 0;
d27497e3
RS
1530 /* If symbol name begins with a digit, and ends with a digit,
1531 and contains nothing but digits and `e', it could be treated
1532 as a number. So set CONFUSING.
1533
1534 Symbols that contain periods could also be taken as numbers,
1535 but periods are always escaped, so we don't have to worry
1536 about them here. */
1537 else if (*p >= '0' && *p <= '9'
1538 && end[-1] >= '0' && end[-1] <= '9')
ca0569ad 1539 {
e837058b
RS
1540 while (p != end && ((*p >= '0' && *p <= '9')
1541 /* Needed for \2e10. */
1542 || *p == 'e'))
ca0569ad
RS
1543 p++;
1544 confusing = (end == p);
1545 }
d27497e3
RS
1546 else
1547 confusing = 0;
ca0569ad 1548
bf9f2aab 1549 if (! NILP (Vprint_gensym) && !SYMBOL_INTERNED_P (obj))
081e0581 1550 {
081e0581
EN
1551 PRINTCHAR ('#');
1552 PRINTCHAR (':');
1553 }
1554
d5db4077 1555 size_byte = SBYTES (name);
dc2a0b79
RS
1556
1557 for (i = 0, i_byte = 0; i_byte < size_byte;)
ca0569ad 1558 {
6ddd6eee
RS
1559 /* Here, we must convert each multi-byte form to the
1560 corresponding character code before handing it to PRINTCHAR. */
eba90784 1561 FETCH_STRING_CHAR_ADVANCE (c, name, i, i_byte);
ca0569ad 1562 QUIT;
09eddb56 1563
ca0569ad
RS
1564 if (escapeflag)
1565 {
09eddb56
RS
1566 if (c == '\"' || c == '\\' || c == '\''
1567 || c == ';' || c == '#' || c == '(' || c == ')'
1568 || c == ',' || c =='.' || c == '`'
1569 || c == '[' || c == ']' || c == '?' || c <= 040
1570 || confusing)
ca0569ad
RS
1571 PRINTCHAR ('\\'), confusing = 0;
1572 }
1573 PRINTCHAR (c);
1574 }
1575 }
1576 break;
1577
1578 case Lisp_Cons:
38010d50 1579 /* If deeper than spec'd depth, print placeholder. */
d4ae1f7e 1580 if (INTEGERP (Vprint_level)
38010d50 1581 && print_depth > XINT (Vprint_level))
dc2a0b79 1582 strout ("...", -1, -1, printcharfun, 0);
2f100b5c
EN
1583 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1584 && (EQ (XCAR (obj), Qquote)))
1585 {
1586 PRINTCHAR ('\'');
0f25ecc6 1587 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
2f100b5c
EN
1588 }
1589 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1590 && (EQ (XCAR (obj), Qfunction)))
1591 {
1592 PRINTCHAR ('#');
1593 PRINTCHAR ('\'');
0f25ecc6 1594 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
2f100b5c
EN
1595 }
1596 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
0330bb60 1597 && ! old_backquote_output
2f100b5c
EN
1598 && ((EQ (XCAR (obj), Qbackquote)
1599 || EQ (XCAR (obj), Qcomma)
1600 || EQ (XCAR (obj), Qcomma_at)
1601 || EQ (XCAR (obj), Qcomma_dot))))
1602 {
0f25ecc6
RS
1603 print_object (XCAR (obj), printcharfun, 0);
1604 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
2f100b5c 1605 }
e0f93814 1606 else
38010d50 1607 {
e0f93814 1608 PRINTCHAR ('(');
177c0ea7 1609
0330bb60
RS
1610 /* If the first element is a backquote form,
1611 print it old-style so it won't be misunderstood. */
1612 if (print_quoted && CONSP (XCAR (obj))
1613 && CONSP (XCDR (XCAR (obj)))
1614 && NILP (XCDR (XCDR (XCAR (obj))))
1615 && EQ (XCAR (XCAR (obj)), Qbackquote))
1616 {
1617 Lisp_Object tem;
1618 tem = XCAR (obj);
1619 PRINTCHAR ('(');
1620
1621 print_object (Qbackquote, printcharfun, 0);
1622 PRINTCHAR (' ');
1623
1624 ++old_backquote_output;
1625 print_object (XCAR (XCDR (tem)), printcharfun, 0);
1626 --old_backquote_output;
1627 PRINTCHAR (')');
1628
1629 obj = XCDR (obj);
1630 }
1631
38010d50 1632 {
42ac1ed4 1633 int print_length, i;
1eab22b5 1634 Lisp_Object halftail = obj;
e0f93814 1635
9ab8560d 1636 /* Negative values of print-length are invalid in CL.
42ac1ed4
GM
1637 Treat them like nil, as CMUCL does. */
1638 if (NATNUMP (Vprint_length))
1639 print_length = XFASTINT (Vprint_length);
1640 else
1641 print_length = 0;
1642
1643 i = 0;
e0f93814 1644 while (CONSP (obj))
38010d50 1645 {
1eab22b5 1646 /* Detect circular list. */
0f25ecc6 1647 if (NILP (Vprint_circle))
1eab22b5 1648 {
0f25ecc6
RS
1649 /* Simple but imcomplete way. */
1650 if (i != 0 && EQ (obj, halftail))
1651 {
1652 sprintf (buf, " . #%d", i / 2);
1653 strout (buf, -1, -1, printcharfun, 0);
1654 goto end_of_list;
1655 }
1656 }
1657 else
1658 {
1659 /* With the print-circle feature. */
1660 if (i != 0)
1661 {
1662 int i;
1663 for (i = 0; i < print_number_index; i++)
42ac1ed4
GM
1664 if (EQ (PRINT_NUMBER_OBJECT (Vprint_number_table, i),
1665 obj))
0f25ecc6
RS
1666 {
1667 if (NILP (PRINT_NUMBER_STATUS (Vprint_number_table, i)))
1668 {
1669 strout (" . ", 3, 3, printcharfun, 0);
1670 print_object (obj, printcharfun, escapeflag);
1671 }
1672 else
1673 {
1674 sprintf (buf, " . #%d#", i + 1);
1675 strout (buf, -1, -1, printcharfun, 0);
1676 }
1677 goto end_of_list;
1678 }
1679 }
1eab22b5 1680 }
177c0ea7 1681
e0f93814
KH
1682 if (i++)
1683 PRINTCHAR (' ');
177c0ea7 1684
f4fe72d5 1685 if (print_length && i > print_length)
e0f93814 1686 {
dc2a0b79 1687 strout ("...", 3, 3, printcharfun, 0);
0f25ecc6 1688 goto end_of_list;
e0f93814 1689 }
177c0ea7 1690
0f25ecc6 1691 print_object (XCAR (obj), printcharfun, escapeflag);
177c0ea7 1692
2f100b5c 1693 obj = XCDR (obj);
1eab22b5
RS
1694 if (!(i & 1))
1695 halftail = XCDR (halftail);
38010d50 1696 }
38010d50 1697 }
42ac1ed4
GM
1698
1699 /* OBJ non-nil here means it's the end of a dotted list. */
2f100b5c 1700 if (!NILP (obj))
e0f93814 1701 {
dc2a0b79 1702 strout (" . ", 3, 3, printcharfun, 0);
0f25ecc6 1703 print_object (obj, printcharfun, escapeflag);
e0f93814 1704 }
177c0ea7 1705
0f25ecc6 1706 end_of_list:
e0f93814 1707 PRINTCHAR (')');
38010d50 1708 }
ca0569ad
RS
1709 break;
1710
1711 case Lisp_Vectorlike:
1712 if (PROCESSP (obj))
1713 {
1714 if (escapeflag)
1715 {
dc2a0b79 1716 strout ("#<process ", -1, -1, printcharfun, 0);
ca0569ad
RS
1717 print_string (XPROCESS (obj)->name, printcharfun);
1718 PRINTCHAR ('>');
1719 }
1720 else
1721 print_string (XPROCESS (obj)->name, printcharfun);
1722 }
ed2c35ef
RS
1723 else if (BOOL_VECTOR_P (obj))
1724 {
1725 register int i;
1726 register unsigned char c;
1727 struct gcpro gcpro1;
ed2c35ef 1728 int size_in_chars
1bad7c59 1729 = (XBOOL_VECTOR (obj)->size + BITS_PER_CHAR - 1) / BITS_PER_CHAR;
ed2c35ef
RS
1730
1731 GCPRO1 (obj);
1732
1733 PRINTCHAR ('#');
1734 PRINTCHAR ('&');
1735 sprintf (buf, "%d", XBOOL_VECTOR (obj)->size);
dc2a0b79 1736 strout (buf, -1, -1, printcharfun, 0);
ed2c35ef 1737 PRINTCHAR ('\"');
a40384bc 1738
42ac1ed4 1739 /* Don't print more characters than the specified maximum.
9ab8560d 1740 Negative values of print-length are invalid. Treat them
42ac1ed4
GM
1741 like a print-length of nil. */
1742 if (NATNUMP (Vprint_length)
1743 && XFASTINT (Vprint_length) < size_in_chars)
1744 size_in_chars = XFASTINT (Vprint_length);
a40384bc 1745
ed2c35ef
RS
1746 for (i = 0; i < size_in_chars; i++)
1747 {
1748 QUIT;
1749 c = XBOOL_VECTOR (obj)->data[i];
1750 if (c == '\n' && print_escape_newlines)
1751 {
1752 PRINTCHAR ('\\');
1753 PRINTCHAR ('n');
1754 }
1755 else if (c == '\f' && print_escape_newlines)
1756 {
1757 PRINTCHAR ('\\');
1758 PRINTCHAR ('f');
1759 }
1760 else
1761 {
1762 if (c == '\"' || c == '\\')
1763 PRINTCHAR ('\\');
1764 PRINTCHAR (c);
1765 }
1766 }
1767 PRINTCHAR ('\"');
1768
1769 UNGCPRO;
1770 }
ca0569ad
RS
1771 else if (SUBRP (obj))
1772 {
dc2a0b79
RS
1773 strout ("#<subr ", -1, -1, printcharfun, 0);
1774 strout (XSUBR (obj)->symbol_name, -1, -1, printcharfun, 0);
ca0569ad
RS
1775 PRINTCHAR ('>');
1776 }
ca0569ad
RS
1777 else if (WINDOWP (obj))
1778 {
dc2a0b79 1779 strout ("#<window ", -1, -1, printcharfun, 0);
ca0569ad 1780 sprintf (buf, "%d", XFASTINT (XWINDOW (obj)->sequence_number));
dc2a0b79 1781 strout (buf, -1, -1, printcharfun, 0);
ca0569ad
RS
1782 if (!NILP (XWINDOW (obj)->buffer))
1783 {
dc2a0b79 1784 strout (" on ", -1, -1, printcharfun, 0);
ca0569ad
RS
1785 print_string (XBUFFER (XWINDOW (obj)->buffer)->name, printcharfun);
1786 }
1787 PRINTCHAR ('>');
1788 }
7eb03302
GM
1789 else if (HASH_TABLE_P (obj))
1790 {
1791 struct Lisp_Hash_Table *h = XHASH_TABLE (obj);
1792 strout ("#<hash-table", -1, -1, printcharfun, 0);
1793 if (SYMBOLP (h->test))
1794 {
1795 PRINTCHAR (' ');
1796 PRINTCHAR ('\'');
d5db4077 1797 strout (SDATA (SYMBOL_NAME (h->test)), -1, -1, printcharfun, 0);
7eb03302 1798 PRINTCHAR (' ');
d5db4077 1799 strout (SDATA (SYMBOL_NAME (h->weak)), -1, -1, printcharfun, 0);
7eb03302
GM
1800 PRINTCHAR (' ');
1801 sprintf (buf, "%d/%d", XFASTINT (h->count),
1802 XVECTOR (h->next)->size);
1803 strout (buf, -1, -1, printcharfun, 0);
1804 }
1805 sprintf (buf, " 0x%lx", (unsigned long) h);
1806 strout (buf, -1, -1, printcharfun, 0);
1807 PRINTCHAR ('>');
1808 }
908b0ae5
RS
1809 else if (BUFFERP (obj))
1810 {
1811 if (NILP (XBUFFER (obj)->name))
dc2a0b79 1812 strout ("#<killed buffer>", -1, -1, printcharfun, 0);
908b0ae5
RS
1813 else if (escapeflag)
1814 {
dc2a0b79 1815 strout ("#<buffer ", -1, -1, printcharfun, 0);
908b0ae5
RS
1816 print_string (XBUFFER (obj)->name, printcharfun);
1817 PRINTCHAR ('>');
1818 }
1819 else
1820 print_string (XBUFFER (obj)->name, printcharfun);
1821 }
ca0569ad
RS
1822 else if (WINDOW_CONFIGURATIONP (obj))
1823 {
dc2a0b79 1824 strout ("#<window-configuration>", -1, -1, printcharfun, 0);
ca0569ad 1825 }
ca0569ad
RS
1826 else if (FRAMEP (obj))
1827 {
1828 strout ((FRAME_LIVE_P (XFRAME (obj))
1829 ? "#<frame " : "#<dead frame "),
dc2a0b79 1830 -1, -1, printcharfun, 0);
ca0569ad 1831 print_string (XFRAME (obj)->name, printcharfun);
aab3aa14 1832 sprintf (buf, " 0x%lx", (unsigned long) (XFRAME (obj)));
dc2a0b79 1833 strout (buf, -1, -1, printcharfun, 0);
ca0569ad
RS
1834 PRINTCHAR ('>');
1835 }
ca0569ad
RS
1836 else
1837 {
1838 int size = XVECTOR (obj)->size;
1839 if (COMPILEDP (obj))
1840 {
1841 PRINTCHAR ('#');
1842 size &= PSEUDOVECTOR_SIZE_MASK;
1843 }
ed2c35ef
RS
1844 if (CHAR_TABLE_P (obj))
1845 {
1846 /* We print a char-table as if it were a vector,
1847 lumping the parent and default slots in with the
1848 character slots. But we add #^ as a prefix. */
1849 PRINTCHAR ('#');
1850 PRINTCHAR ('^');
3701b5de
KH
1851 if (SUB_CHAR_TABLE_P (obj))
1852 PRINTCHAR ('^');
ed2c35ef
RS
1853 size &= PSEUDOVECTOR_SIZE_MASK;
1854 }
00d76abc
KH
1855 if (size & PSEUDOVECTOR_FLAG)
1856 goto badtype;
ca0569ad
RS
1857
1858 PRINTCHAR ('[');
38010d50 1859 {
ca0569ad
RS
1860 register int i;
1861 register Lisp_Object tem;
d6ac884e 1862 int real_size = size;
a40384bc
RS
1863
1864 /* Don't print more elements than the specified maximum. */
42ac1ed4
GM
1865 if (NATNUMP (Vprint_length)
1866 && XFASTINT (Vprint_length) < size)
1867 size = XFASTINT (Vprint_length);
a40384bc 1868
ca0569ad
RS
1869 for (i = 0; i < size; i++)
1870 {
1871 if (i) PRINTCHAR (' ');
1872 tem = XVECTOR (obj)->contents[i];
0f25ecc6 1873 print_object (tem, printcharfun, escapeflag);
ca0569ad 1874 }
d6ac884e
KH
1875 if (size < real_size)
1876 strout (" ...", 4, 4, printcharfun, 0);
38010d50 1877 }
ca0569ad
RS
1878 PRINTCHAR (']');
1879 }
1880 break;
1881
ca0569ad 1882 case Lisp_Misc:
5db20f08 1883 switch (XMISCTYPE (obj))
38010d50 1884 {
00d76abc 1885 case Lisp_Misc_Marker:
dc2a0b79 1886 strout ("#<marker ", -1, -1, printcharfun, 0);
087e3c46
KH
1887 /* Do you think this is necessary? */
1888 if (XMARKER (obj)->insertion_type != 0)
210ebd3d 1889 strout ("(moves after insertion) ", -1, -1, printcharfun, 0);
ca0569ad 1890 if (!(XMARKER (obj)->buffer))
dc2a0b79 1891 strout ("in no buffer", -1, -1, printcharfun, 0);
ca0569ad
RS
1892 else
1893 {
1894 sprintf (buf, "at %d", marker_position (obj));
dc2a0b79
RS
1895 strout (buf, -1, -1, printcharfun, 0);
1896 strout (" in ", -1, -1, printcharfun, 0);
ca0569ad
RS
1897 print_string (XMARKER (obj)->buffer->name, printcharfun);
1898 }
38010d50 1899 PRINTCHAR ('>');
908b0ae5 1900 break;
00d76abc
KH
1901
1902 case Lisp_Misc_Overlay:
dc2a0b79 1903 strout ("#<overlay ", -1, -1, printcharfun, 0);
ca0569ad 1904 if (!(XMARKER (OVERLAY_START (obj))->buffer))
dc2a0b79 1905 strout ("in no buffer", -1, -1, printcharfun, 0);
ca0569ad
RS
1906 else
1907 {
1908 sprintf (buf, "from %d to %d in ",
1909 marker_position (OVERLAY_START (obj)),
1910 marker_position (OVERLAY_END (obj)));
dc2a0b79 1911 strout (buf, -1, -1, printcharfun, 0);
ca0569ad
RS
1912 print_string (XMARKER (OVERLAY_START (obj))->buffer->name,
1913 printcharfun);
1914 }
1915 PRINTCHAR ('>');
908b0ae5 1916 break;
00d76abc
KH
1917
1918 /* Remaining cases shouldn't happen in normal usage, but let's print
1919 them anyway for the benefit of the debugger. */
1920 case Lisp_Misc_Free:
dc2a0b79 1921 strout ("#<misc free cell>", -1, -1, printcharfun, 0);
00d76abc
KH
1922 break;
1923
1924 case Lisp_Misc_Intfwd:
1925 sprintf (buf, "#<intfwd to %d>", *XINTFWD (obj)->intvar);
dc2a0b79 1926 strout (buf, -1, -1, printcharfun, 0);
00d76abc
KH
1927 break;
1928
1929 case Lisp_Misc_Boolfwd:
1930 sprintf (buf, "#<boolfwd to %s>",
1931 (*XBOOLFWD (obj)->boolvar ? "t" : "nil"));
dc2a0b79 1932 strout (buf, -1, -1, printcharfun, 0);
00d76abc
KH
1933 break;
1934
1935 case Lisp_Misc_Objfwd:
dc2a0b79 1936 strout ("#<objfwd to ", -1, -1, printcharfun, 0);
0f25ecc6 1937 print_object (*XOBJFWD (obj)->objvar, printcharfun, escapeflag);
00d76abc
KH
1938 PRINTCHAR ('>');
1939 break;
1940
1941 case Lisp_Misc_Buffer_Objfwd:
dc2a0b79 1942 strout ("#<buffer_objfwd to ", -1, -1, printcharfun, 0);
f6cd0527
GM
1943 print_object (PER_BUFFER_VALUE (current_buffer,
1944 XBUFFER_OBJFWD (obj)->offset),
c3279ad4 1945 printcharfun, escapeflag);
3ac613c1
KH
1946 PRINTCHAR ('>');
1947 break;
1948
fb917148 1949 case Lisp_Misc_Kboard_Objfwd:
dc2a0b79 1950 strout ("#<kboard_objfwd to ", -1, -1, printcharfun, 0);
0f25ecc6
RS
1951 print_object (*(Lisp_Object *)((char *) current_kboard
1952 + XKBOARD_OBJFWD (obj)->offset),
c3279ad4 1953 printcharfun, escapeflag);
00d76abc
KH
1954 PRINTCHAR ('>');
1955 break;
1956
1957 case Lisp_Misc_Buffer_Local_Value:
dc2a0b79 1958 strout ("#<buffer_local_value ", -1, -1, printcharfun, 0);
00d76abc
KH
1959 goto do_buffer_local;
1960 case Lisp_Misc_Some_Buffer_Local_Value:
dc2a0b79 1961 strout ("#<some_buffer_local_value ", -1, -1, printcharfun, 0);
00d76abc 1962 do_buffer_local:
dc2a0b79 1963 strout ("[realvalue] ", -1, -1, printcharfun, 0);
0f25ecc6
RS
1964 print_object (XBUFFER_LOCAL_VALUE (obj)->realvalue,
1965 printcharfun, escapeflag);
03153771
RS
1966 if (XBUFFER_LOCAL_VALUE (obj)->found_for_buffer)
1967 strout ("[local in buffer] ", -1, -1, printcharfun, 0);
1968 else
1969 strout ("[buffer] ", -1, -1, printcharfun, 0);
0f25ecc6
RS
1970 print_object (XBUFFER_LOCAL_VALUE (obj)->buffer,
1971 printcharfun, escapeflag);
03153771
RS
1972 if (XBUFFER_LOCAL_VALUE (obj)->check_frame)
1973 {
1974 if (XBUFFER_LOCAL_VALUE (obj)->found_for_frame)
1975 strout ("[local in frame] ", -1, -1, printcharfun, 0);
1976 else
1977 strout ("[frame] ", -1, -1, printcharfun, 0);
0f25ecc6
RS
1978 print_object (XBUFFER_LOCAL_VALUE (obj)->frame,
1979 printcharfun, escapeflag);
03153771 1980 }
dc2a0b79 1981 strout ("[alist-elt] ", -1, -1, printcharfun, 0);
94b342ce 1982 print_object (XCAR (XBUFFER_LOCAL_VALUE (obj)->cdr),
0f25ecc6 1983 printcharfun, escapeflag);
dc2a0b79 1984 strout ("[default-value] ", -1, -1, printcharfun, 0);
94b342ce 1985 print_object (XCDR (XBUFFER_LOCAL_VALUE (obj)->cdr),
0f25ecc6 1986 printcharfun, escapeflag);
00d76abc
KH
1987 PRINTCHAR ('>');
1988 break;
1989
1990 default:
1991 goto badtype;
e0f93814 1992 }
00d76abc 1993 break;
ca0569ad
RS
1994
1995 default:
00d76abc 1996 badtype:
ca0569ad
RS
1997 {
1998 /* We're in trouble if this happens!
1999 Probably should just abort () */
dc2a0b79 2000 strout ("#<EMACS BUG: INVALID DATATYPE ", -1, -1, printcharfun, 0);
00d76abc 2001 if (MISCP (obj))
5db20f08 2002 sprintf (buf, "(MISC 0x%04x)", (int) XMISCTYPE (obj));
00d76abc
KH
2003 else if (VECTORLIKEP (obj))
2004 sprintf (buf, "(PVEC 0x%08x)", (int) XVECTOR (obj)->size);
2005 else
2006 sprintf (buf, "(0x%02x)", (int) XTYPE (obj));
dc2a0b79 2007 strout (buf, -1, -1, printcharfun, 0);
ca0569ad 2008 strout (" Save your buffers immediately and please report this bug>",
dc2a0b79 2009 -1, -1, printcharfun, 0);
ca0569ad 2010 }
38010d50
JB
2011 }
2012
2013 print_depth--;
2014}
2015\f
7651e1f5
RS
2016
2017/* Print a description of INTERVAL using PRINTCHARFUN.
2018 This is part of printing a string that has text properties. */
2019
2020void
2021print_interval (interval, printcharfun)
2022 INTERVAL interval;
2023 Lisp_Object printcharfun;
2024{
30503c0b 2025 PRINTCHAR (' ');
0f25ecc6 2026 print_object (make_number (interval->position), printcharfun, 1);
7651e1f5 2027 PRINTCHAR (' ');
0f25ecc6 2028 print_object (make_number (interval->position + LENGTH (interval)),
7651e1f5
RS
2029 printcharfun, 1);
2030 PRINTCHAR (' ');
0f25ecc6 2031 print_object (interval->plist, printcharfun, 1);
7651e1f5
RS
2032}
2033
7651e1f5 2034\f
38010d50
JB
2035void
2036syms_of_print ()
2037{
d9c21094
RS
2038 Qtemp_buffer_setup_hook = intern ("temp-buffer-setup-hook");
2039 staticpro (&Qtemp_buffer_setup_hook);
2040
38010d50 2041 DEFVAR_LISP ("standard-output", &Vstandard_output,
8c1a1077
PJ
2042 doc: /* Output stream `print' uses by default for outputting a character.
2043This may be any function of one argument.
2044It may also be a buffer (output is inserted before point)
2045or a marker (output is inserted and the marker is advanced)
2046or the symbol t (output appears in the echo area). */);
38010d50
JB
2047 Vstandard_output = Qt;
2048 Qstandard_output = intern ("standard-output");
2049 staticpro (&Qstandard_output);
2050
38010d50 2051 DEFVAR_LISP ("float-output-format", &Vfloat_output_format,
8c1a1077
PJ
2052 doc: /* The format descriptor string used to print floats.
2053This is a %-spec like those accepted by `printf' in C,
2054but with some restrictions. It must start with the two characters `%.'.
2055After that comes an integer precision specification,
2056and then a letter which controls the format.
2057The letters allowed are `e', `f' and `g'.
2058Use `e' for exponential notation \"DIG.DIGITSeEXPT\"
2059Use `f' for decimal point notation \"DIGITS.DIGITS\".
2060Use `g' to choose the shorter of those two formats for the number at hand.
2061The precision in any of these cases is the number of digits following
2062the decimal point. With `f', a precision of 0 means to omit the
2063decimal point. 0 is not allowed with `e' or `g'.
2064
2065A value of nil means to use the shortest notation
2066that represents the number without losing information. */);
38010d50
JB
2067 Vfloat_output_format = Qnil;
2068 Qfloat_output_format = intern ("float-output-format");
2069 staticpro (&Qfloat_output_format);
38010d50
JB
2070
2071 DEFVAR_LISP ("print-length", &Vprint_length,
8c1a1077
PJ
2072 doc: /* Maximum length of list to print before abbreviating.
2073A value of nil means no limit. See also `eval-expression-print-length'. */);
38010d50
JB
2074 Vprint_length = Qnil;
2075
2076 DEFVAR_LISP ("print-level", &Vprint_level,
8c1a1077
PJ
2077 doc: /* Maximum depth of list nesting to print before abbreviating.
2078A value of nil means no limit. See also `eval-expression-print-level'. */);
38010d50
JB
2079 Vprint_level = Qnil;
2080
2081 DEFVAR_BOOL ("print-escape-newlines", &print_escape_newlines,
8c1a1077
PJ
2082 doc: /* Non-nil means print newlines in strings as `\\n'.
2083Also print formfeeds as `\\f'. */);
38010d50
JB
2084 print_escape_newlines = 0;
2085
38940e93 2086 DEFVAR_BOOL ("print-escape-nonascii", &print_escape_nonascii,
8c1a1077
PJ
2087 doc: /* Non-nil means print unibyte non-ASCII chars in strings as \\OOO.
2088\(OOO is the octal representation of the character code.)
249c0f71
RS
2089Only single-byte characters are affected, and only in `prin1'.
2090When the output goes in a multibyte buffer, this feature is
2091enabled regardless of the value of the variable. */);
38940e93
RS
2092 print_escape_nonascii = 0;
2093
835d0be6 2094 DEFVAR_BOOL ("print-escape-multibyte", &print_escape_multibyte,
8c1a1077
PJ
2095 doc: /* Non-nil means print multibyte characters in strings as \\xXXXX.
2096\(XXXX is the hex representation of the character code.)
2097This affects only `prin1'. */);
835d0be6
RS
2098 print_escape_multibyte = 0;
2099
2f100b5c 2100 DEFVAR_BOOL ("print-quoted", &print_quoted,
8c1a1077
PJ
2101 doc: /* Non-nil means print quoted forms with reader syntax.
2102I.e., (quote foo) prints as 'foo, (function foo) as #'foo, and backquoted
2103forms print as in the new syntax. */);
2f100b5c
EN
2104 print_quoted = 0;
2105
e0f69431 2106 DEFVAR_LISP ("print-gensym", &Vprint_gensym,
8c1a1077
PJ
2107 doc: /* Non-nil means print uninterned symbols so they will read as uninterned.
2108I.e., the value of (make-symbol \"foobar\") prints as #:foobar.
2109When the uninterned symbol appears within a recursive data structure,
2110and the symbol appears more than once, in addition use the #N# and #N=
2111constructs as needed, so that multiple references to the same symbol are
2112shared once again when the text is read back. */);
e0f69431
RS
2113 Vprint_gensym = Qnil;
2114
0f25ecc6 2115 DEFVAR_LISP ("print-circle", &Vprint_circle,
8c1a1077
PJ
2116 doc: /* *Non-nil means print recursive structures using #N= and #N# syntax.
2117If nil, printing proceeds recursively and may lead to
2118`max-lisp-eval-depth' being exceeded or an error may occur:
2119\"Apparently circular structure being printed.\" Also see
2120`print-length' and `print-level'.
2121If non-nil, shared substructures anywhere in the structure are printed
2122with `#N=' before the first occurrence (in the order of the print
2123representation) and `#N#' in place of each subsequent occurrence,
2124where N is a positive decimal integer. */);
0f25ecc6
RS
2125 Vprint_circle = Qnil;
2126
2127 DEFVAR_LISP ("print-continuous-numbering", &Vprint_continuous_numbering,
8c1a1077
PJ
2128 doc: /* *Non-nil means number continuously across print calls.
2129This affects the numbers printed for #N= labels and #M# references.
2130See also `print-circle', `print-gensym', and `print-number-table'.
2131This variable should not be set with `setq'; bind it with a `let' instead. */);
0f25ecc6
RS
2132 Vprint_continuous_numbering = Qnil;
2133
2134 DEFVAR_LISP ("print-number-table", &Vprint_number_table,
8c1a1077
PJ
2135 doc: /* A vector used internally to produce `#N=' labels and `#N#' references.
2136The Lisp printer uses this vector to detect Lisp objects referenced more
e6d4cddd
RS
2137than once.
2138
2139When you bind `print-continuous-numbering' to t, you should probably
2140also bind `print-number-table' to nil. This ensures that the value of
2141`print-number-table' can be garbage-collected once the printing is
2142done. If all elements of `print-number-table' are nil, it means that
2143the printing done so far has not found any shared structure or objects
2144that need to be recorded in the table. */);
0f25ecc6 2145 Vprint_number_table = Qnil;
081e0581 2146
38010d50
JB
2147 /* prin1_to_string_buffer initialized in init_buffer_once in buffer.c */
2148 staticpro (&Vprin1_to_string_buffer);
2149
2150 defsubr (&Sprin1);
2151 defsubr (&Sprin1_to_string);
113620cc 2152 defsubr (&Serror_message_string);
38010d50
JB
2153 defsubr (&Sprinc);
2154 defsubr (&Sprint);
2155 defsubr (&Sterpri);
2156 defsubr (&Swrite_char);
2157 defsubr (&Sexternal_debugging_output);
2158
2159 Qexternal_debugging_output = intern ("external-debugging-output");
2160 staticpro (&Qexternal_debugging_output);
2161
2f100b5c
EN
2162 Qprint_escape_newlines = intern ("print-escape-newlines");
2163 staticpro (&Qprint_escape_newlines);
2164
835d0be6
RS
2165 Qprint_escape_multibyte = intern ("print-escape-multibyte");
2166 staticpro (&Qprint_escape_multibyte);
2167
2168 Qprint_escape_nonascii = intern ("print-escape-nonascii");
2169 staticpro (&Qprint_escape_nonascii);
2170
38010d50 2171 defsubr (&Swith_output_to_temp_buffer);
38010d50 2172}