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