Merge from emacs-23; up to 2010-06-02T00:10:42Z!yamaoka@jpl.org.
[emacs.git] / src / print.c
blob299cfd41814b73b5066b8dd96ac65fb824d4132b
1 /* Lisp object printing and output streams.
3 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2011
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include <stdio.h>
24 #include <setjmp.h>
25 #include "lisp.h"
26 #include "buffer.h"
27 #include "character.h"
28 #include "charset.h"
29 #include "keyboard.h"
30 #include "frame.h"
31 #include "window.h"
32 #include "process.h"
33 #include "dispextern.h"
34 #include "termchar.h"
35 #include "intervals.h"
36 #include "blockinput.h"
37 #include "termhooks.h" /* For struct terminal. */
38 #include "font.h"
40 Lisp_Object Qstandard_output;
42 Lisp_Object Qtemp_buffer_setup_hook;
44 /* These are used to print like we read. */
46 Lisp_Object Qfloat_output_format;
48 #include <math.h>
50 #if STDC_HEADERS
51 #include <float.h>
52 #endif
53 #include <ftoastr.h>
55 /* Default to values appropriate for IEEE floating point. */
56 #ifndef DBL_DIG
57 #define DBL_DIG 15
58 #endif
60 /* Avoid actual stack overflow in print. */
61 int print_depth;
63 /* Level of nesting inside outputting backquote in new style. */
64 int new_backquote_output;
66 /* Detect most circularities to print finite output. */
67 #define PRINT_CIRCLE 200
68 Lisp_Object being_printed[PRINT_CIRCLE];
70 /* When printing into a buffer, first we put the text in this
71 block, then insert it all at once. */
72 char *print_buffer;
74 /* Size allocated in print_buffer. */
75 EMACS_INT print_buffer_size;
76 /* Chars stored in print_buffer. */
77 EMACS_INT print_buffer_pos;
78 /* Bytes stored in print_buffer. */
79 EMACS_INT print_buffer_pos_byte;
81 Lisp_Object Qprint_escape_newlines;
82 Lisp_Object Qprint_escape_multibyte, Qprint_escape_nonascii;
84 /* Vprint_number_table is a table, that keeps objects that are going to
85 be printed, to allow use of #n= and #n# to express sharing.
86 For any given object, the table can give the following values:
87 t the object will be printed only once.
88 -N the object will be printed several times and will take number N.
89 N the object has been printed so we can refer to it as #N#.
90 print_number_index holds the largest N already used.
91 N has to be striclty larger than 0 since we need to distinguish -N. */
92 int print_number_index;
93 void print_interval (INTERVAL interval, Lisp_Object printcharfun);
95 /* GDB resets this to zero on W32 to disable OutputDebugString calls. */
96 int print_output_debug_flag EXTERNALLY_VISIBLE = 1;
99 /* Low level output routines for characters and strings */
101 /* Lisp functions to do output using a stream
102 must have the stream in a variable called printcharfun
103 and must start with PRINTPREPARE, end with PRINTFINISH,
104 and use PRINTDECLARE to declare common variables.
105 Use PRINTCHAR to output one character,
106 or call strout to output a block of characters. */
108 #define PRINTDECLARE \
109 struct buffer *old = current_buffer; \
110 EMACS_INT old_point = -1, start_point = -1; \
111 EMACS_INT old_point_byte = -1, start_point_byte = -1; \
112 int specpdl_count = SPECPDL_INDEX (); \
113 int free_print_buffer = 0; \
114 int multibyte = !NILP (BVAR (current_buffer, enable_multibyte_characters)); \
115 Lisp_Object original
117 #define PRINTPREPARE \
118 original = printcharfun; \
119 if (NILP (printcharfun)) printcharfun = Qt; \
120 if (BUFFERP (printcharfun)) \
122 if (XBUFFER (printcharfun) != current_buffer) \
123 Fset_buffer (printcharfun); \
124 printcharfun = Qnil; \
126 if (MARKERP (printcharfun)) \
128 EMACS_INT marker_pos; \
129 if (! XMARKER (printcharfun)->buffer) \
130 error ("Marker does not point anywhere"); \
131 if (XMARKER (printcharfun)->buffer != current_buffer) \
132 set_buffer_internal (XMARKER (printcharfun)->buffer); \
133 marker_pos = marker_position (printcharfun); \
134 if (marker_pos < BEGV || marker_pos > ZV) \
135 error ("Marker is outside the accessible part of the buffer"); \
136 old_point = PT; \
137 old_point_byte = PT_BYTE; \
138 SET_PT_BOTH (marker_pos, \
139 marker_byte_position (printcharfun)); \
140 start_point = PT; \
141 start_point_byte = PT_BYTE; \
142 printcharfun = Qnil; \
144 if (NILP (printcharfun)) \
146 Lisp_Object string; \
147 if (NILP (BVAR (current_buffer, enable_multibyte_characters)) \
148 && ! print_escape_multibyte) \
149 specbind (Qprint_escape_multibyte, Qt); \
150 if (! NILP (BVAR (current_buffer, enable_multibyte_characters)) \
151 && ! print_escape_nonascii) \
152 specbind (Qprint_escape_nonascii, Qt); \
153 if (print_buffer != 0) \
155 string = make_string_from_bytes (print_buffer, \
156 print_buffer_pos, \
157 print_buffer_pos_byte); \
158 record_unwind_protect (print_unwind, string); \
160 else \
162 print_buffer_size = 1000; \
163 print_buffer = (char *) xmalloc (print_buffer_size); \
164 free_print_buffer = 1; \
166 print_buffer_pos = 0; \
167 print_buffer_pos_byte = 0; \
169 if (EQ (printcharfun, Qt) && ! noninteractive) \
170 setup_echo_area_for_printing (multibyte);
172 #define PRINTFINISH \
173 if (NILP (printcharfun)) \
175 if (print_buffer_pos != print_buffer_pos_byte \
176 && NILP (BVAR (current_buffer, enable_multibyte_characters))) \
178 unsigned char *temp \
179 = (unsigned char *) alloca (print_buffer_pos + 1); \
180 copy_text ((unsigned char *) print_buffer, temp, \
181 print_buffer_pos_byte, 1, 0); \
182 insert_1_both ((char *) temp, print_buffer_pos, \
183 print_buffer_pos, 0, 1, 0); \
185 else \
186 insert_1_both (print_buffer, print_buffer_pos, \
187 print_buffer_pos_byte, 0, 1, 0); \
188 signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
190 if (free_print_buffer) \
192 xfree (print_buffer); \
193 print_buffer = 0; \
195 unbind_to (specpdl_count, Qnil); \
196 if (MARKERP (original)) \
197 set_marker_both (original, Qnil, PT, PT_BYTE); \
198 if (old_point >= 0) \
199 SET_PT_BOTH (old_point + (old_point >= start_point \
200 ? PT - start_point : 0), \
201 old_point_byte + (old_point_byte >= start_point_byte \
202 ? PT_BYTE - start_point_byte : 0)); \
203 if (old != current_buffer) \
204 set_buffer_internal (old);
206 #define PRINTCHAR(ch) printchar (ch, printcharfun)
208 /* This is used to restore the saved contents of print_buffer
209 when there is a recursive call to print. */
211 static Lisp_Object
212 print_unwind (Lisp_Object saved_text)
214 memcpy (print_buffer, SDATA (saved_text), SCHARS (saved_text));
215 return Qnil;
219 /* Print character CH using method FUN. FUN nil means print to
220 print_buffer. FUN t means print to echo area or stdout if
221 non-interactive. If FUN is neither nil nor t, call FUN with CH as
222 argument. */
224 static void
225 printchar (unsigned int ch, Lisp_Object fun)
227 if (!NILP (fun) && !EQ (fun, Qt))
228 call1 (fun, make_number (ch));
229 else
231 unsigned char str[MAX_MULTIBYTE_LENGTH];
232 int len = CHAR_STRING (ch, str);
234 QUIT;
236 if (NILP (fun))
238 if (print_buffer_pos_byte + len >= print_buffer_size)
239 print_buffer = (char *) xrealloc (print_buffer,
240 print_buffer_size *= 2);
241 memcpy (print_buffer + print_buffer_pos_byte, str, len);
242 print_buffer_pos += 1;
243 print_buffer_pos_byte += len;
245 else if (noninteractive)
247 fwrite (str, 1, len, stdout);
248 noninteractive_need_newline = 1;
250 else
252 int multibyte_p
253 = !NILP (BVAR (current_buffer, enable_multibyte_characters));
255 setup_echo_area_for_printing (multibyte_p);
256 insert_char (ch);
257 message_dolog ((char *) str, len, 0, multibyte_p);
263 /* Output SIZE characters, SIZE_BYTE bytes from string PTR using
264 method PRINTCHARFUN. If SIZE < 0, use the string length of PTR for
265 both SIZE and SIZE_BYTE. PRINTCHARFUN nil means output to
266 print_buffer. PRINTCHARFUN t means output to the echo area or to
267 stdout if non-interactive. If neither nil nor t, call Lisp
268 function PRINTCHARFUN for each character printed. MULTIBYTE
269 non-zero means PTR contains multibyte characters.
271 In the case where PRINTCHARFUN is nil, it is safe for PTR to point
272 to data in a Lisp string. Otherwise that is not safe. */
274 static void
275 strout (const char *ptr, EMACS_INT size, EMACS_INT size_byte,
276 Lisp_Object printcharfun, int multibyte)
278 if (size < 0)
279 size_byte = size = strlen (ptr);
281 if (NILP (printcharfun))
283 if (print_buffer_pos_byte + size_byte > print_buffer_size)
285 print_buffer_size = print_buffer_size * 2 + size_byte;
286 print_buffer = (char *) xrealloc (print_buffer,
287 print_buffer_size);
289 memcpy (print_buffer + print_buffer_pos_byte, ptr, size_byte);
290 print_buffer_pos += size;
291 print_buffer_pos_byte += size_byte;
293 else if (noninteractive && EQ (printcharfun, Qt))
295 fwrite (ptr, 1, size_byte, stdout);
296 noninteractive_need_newline = 1;
298 else if (EQ (printcharfun, Qt))
300 /* Output to echo area. We're trying to avoid a little overhead
301 here, that's the reason we don't call printchar to do the
302 job. */
303 int i;
304 int multibyte_p
305 = !NILP (BVAR (current_buffer, enable_multibyte_characters));
307 setup_echo_area_for_printing (multibyte_p);
308 message_dolog (ptr, size_byte, 0, multibyte_p);
310 if (size == size_byte)
312 for (i = 0; i < size; ++i)
313 insert_char ((unsigned char) *ptr++);
315 else
317 int len;
318 for (i = 0; i < size_byte; i += len)
320 int ch = STRING_CHAR_AND_LENGTH ((const unsigned char *) ptr + i,
321 len);
322 insert_char (ch);
326 else
328 /* PRINTCHARFUN is a Lisp function. */
329 EMACS_INT i = 0;
331 if (size == size_byte)
333 while (i < size_byte)
335 int ch = ptr[i++];
336 PRINTCHAR (ch);
339 else
341 while (i < size_byte)
343 /* Here, we must convert each multi-byte form to the
344 corresponding character code before handing it to
345 PRINTCHAR. */
346 int len;
347 int ch = STRING_CHAR_AND_LENGTH ((const unsigned char *) ptr + i,
348 len);
349 PRINTCHAR (ch);
350 i += len;
356 /* Print the contents of a string STRING using PRINTCHARFUN.
357 It isn't safe to use strout in many cases,
358 because printing one char can relocate. */
360 static void
361 print_string (Lisp_Object string, Lisp_Object printcharfun)
363 if (EQ (printcharfun, Qt) || NILP (printcharfun))
365 EMACS_INT chars;
367 if (print_escape_nonascii)
368 string = string_escape_byte8 (string);
370 if (STRING_MULTIBYTE (string))
371 chars = SCHARS (string);
372 else if (! print_escape_nonascii
373 && (EQ (printcharfun, Qt)
374 ? ! NILP (BVAR (&buffer_defaults, enable_multibyte_characters))
375 : ! NILP (BVAR (current_buffer, enable_multibyte_characters))))
377 /* If unibyte string STRING contains 8-bit codes, we must
378 convert STRING to a multibyte string containing the same
379 character codes. */
380 Lisp_Object newstr;
381 EMACS_INT bytes;
383 chars = SBYTES (string);
384 bytes = parse_str_to_multibyte (SDATA (string), chars);
385 if (chars < bytes)
387 newstr = make_uninit_multibyte_string (chars, bytes);
388 memcpy (SDATA (newstr), SDATA (string), chars);
389 str_to_multibyte (SDATA (newstr), bytes, chars);
390 string = newstr;
393 else
394 chars = SBYTES (string);
396 if (EQ (printcharfun, Qt))
398 /* Output to echo area. */
399 EMACS_INT nbytes = SBYTES (string);
400 char *buffer;
402 /* Copy the string contents so that relocation of STRING by
403 GC does not cause trouble. */
404 USE_SAFE_ALLOCA;
406 SAFE_ALLOCA (buffer, char *, nbytes);
407 memcpy (buffer, SDATA (string), nbytes);
409 strout (buffer, chars, SBYTES (string),
410 printcharfun, STRING_MULTIBYTE (string));
412 SAFE_FREE ();
414 else
415 /* No need to copy, since output to print_buffer can't GC. */
416 strout (SSDATA (string),
417 chars, SBYTES (string),
418 printcharfun, STRING_MULTIBYTE (string));
420 else
422 /* Otherwise, string may be relocated by printing one char.
423 So re-fetch the string address for each character. */
424 EMACS_INT i;
425 EMACS_INT size = SCHARS (string);
426 EMACS_INT size_byte = SBYTES (string);
427 struct gcpro gcpro1;
428 GCPRO1 (string);
429 if (size == size_byte)
430 for (i = 0; i < size; i++)
431 PRINTCHAR (SREF (string, i));
432 else
433 for (i = 0; i < size_byte; )
435 /* Here, we must convert each multi-byte form to the
436 corresponding character code before handing it to PRINTCHAR. */
437 int len;
438 int ch = STRING_CHAR_AND_LENGTH (SDATA (string) + i, len);
439 PRINTCHAR (ch);
440 i += len;
442 UNGCPRO;
446 DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
447 doc: /* Output character CHARACTER to stream PRINTCHARFUN.
448 PRINTCHARFUN defaults to the value of `standard-output' (which see). */)
449 (Lisp_Object character, Lisp_Object printcharfun)
451 PRINTDECLARE;
453 if (NILP (printcharfun))
454 printcharfun = Vstandard_output;
455 CHECK_NUMBER (character);
456 PRINTPREPARE;
457 PRINTCHAR (XINT (character));
458 PRINTFINISH;
459 return character;
462 /* Used from outside of print.c to print a block of SIZE
463 single-byte chars at DATA on the default output stream.
464 Do not use this on the contents of a Lisp string. */
466 void
467 write_string (const char *data, int size)
469 PRINTDECLARE;
470 Lisp_Object printcharfun;
472 printcharfun = Vstandard_output;
474 PRINTPREPARE;
475 strout (data, size, size, printcharfun, 0);
476 PRINTFINISH;
479 /* Used to print a block of SIZE single-byte chars at DATA on a
480 specified stream PRINTCHARFUN.
481 Do not use this on the contents of a Lisp string. */
483 static void
484 write_string_1 (const char *data, int size, Lisp_Object printcharfun)
486 PRINTDECLARE;
488 PRINTPREPARE;
489 strout (data, size, size, printcharfun, 0);
490 PRINTFINISH;
494 void
495 temp_output_buffer_setup (const char *bufname)
497 int count = SPECPDL_INDEX ();
498 register struct buffer *old = current_buffer;
499 register Lisp_Object buf;
501 record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
503 Fset_buffer (Fget_buffer_create (build_string (bufname)));
505 Fkill_all_local_variables ();
506 delete_all_overlays (current_buffer);
507 BVAR (current_buffer, directory) = BVAR (old, directory);
508 BVAR (current_buffer, read_only) = Qnil;
509 BVAR (current_buffer, filename) = Qnil;
510 BVAR (current_buffer, undo_list) = Qt;
511 eassert (current_buffer->overlays_before == NULL);
512 eassert (current_buffer->overlays_after == NULL);
513 BVAR (current_buffer, enable_multibyte_characters)
514 = BVAR (&buffer_defaults, enable_multibyte_characters);
515 specbind (Qinhibit_read_only, Qt);
516 specbind (Qinhibit_modification_hooks, Qt);
517 Ferase_buffer ();
518 XSETBUFFER (buf, current_buffer);
520 Frun_hooks (1, &Qtemp_buffer_setup_hook);
522 unbind_to (count, Qnil);
524 specbind (Qstandard_output, buf);
527 Lisp_Object
528 internal_with_output_to_temp_buffer (const char *bufname, Lisp_Object (*function) (Lisp_Object), Lisp_Object args)
530 int count = SPECPDL_INDEX ();
531 Lisp_Object buf, val;
532 struct gcpro gcpro1;
534 GCPRO1 (args);
535 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
536 temp_output_buffer_setup (bufname);
537 buf = Vstandard_output;
538 UNGCPRO;
540 val = (*function) (args);
542 GCPRO1 (val);
543 temp_output_buffer_show (buf);
544 UNGCPRO;
546 return unbind_to (count, val);
549 DEFUN ("with-output-to-temp-buffer",
550 Fwith_output_to_temp_buffer, Swith_output_to_temp_buffer,
551 1, UNEVALLED, 0,
552 doc: /* Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
554 This construct makes buffer BUFNAME empty before running BODY.
555 It does not make the buffer current for BODY.
556 Instead it binds `standard-output' to that buffer, so that output
557 generated with `prin1' and similar functions in BODY goes into
558 the buffer.
560 At the end of BODY, this marks buffer BUFNAME unmodifed and displays
561 it in a window, but does not select it. The normal way to do this is
562 by calling `display-buffer', then running `temp-buffer-show-hook'.
563 However, if `temp-buffer-show-function' is non-nil, it calls that
564 function instead (and does not run `temp-buffer-show-hook'). The
565 function gets one argument, the buffer to display.
567 The return value of `with-output-to-temp-buffer' is the value of the
568 last form in BODY. If BODY does not finish normally, the buffer
569 BUFNAME is not displayed.
571 This runs the hook `temp-buffer-setup-hook' before BODY,
572 with the buffer BUFNAME temporarily current. It runs the hook
573 `temp-buffer-show-hook' after displaying buffer BUFNAME, with that
574 buffer temporarily current, and the window that was used to display it
575 temporarily selected. But it doesn't run `temp-buffer-show-hook'
576 if it uses `temp-buffer-show-function'.
578 usage: (with-output-to-temp-buffer BUFNAME BODY...) */)
579 (Lisp_Object args)
581 struct gcpro gcpro1;
582 Lisp_Object name;
583 int count = SPECPDL_INDEX ();
584 Lisp_Object buf, val;
586 GCPRO1(args);
587 name = Feval (Fcar (args));
588 CHECK_STRING (name);
589 temp_output_buffer_setup (SSDATA (name));
590 buf = Vstandard_output;
591 UNGCPRO;
593 val = Fprogn (XCDR (args));
595 GCPRO1 (val);
596 temp_output_buffer_show (buf);
597 UNGCPRO;
599 return unbind_to (count, val);
603 static void print (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag);
604 static void print_preprocess (Lisp_Object obj);
605 static void print_preprocess_string (INTERVAL interval, Lisp_Object arg);
606 static void print_object (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag);
608 DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
609 doc: /* Output a newline to stream PRINTCHARFUN.
610 If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used. */)
611 (Lisp_Object printcharfun)
613 PRINTDECLARE;
615 if (NILP (printcharfun))
616 printcharfun = Vstandard_output;
617 PRINTPREPARE;
618 PRINTCHAR ('\n');
619 PRINTFINISH;
620 return Qt;
623 DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
624 doc: /* Output the printed representation of OBJECT, any Lisp object.
625 Quoting characters are printed when needed to make output that `read'
626 can handle, whenever this is possible. For complex objects, the behavior
627 is controlled by `print-level' and `print-length', which see.
629 OBJECT is any of the Lisp data types: a number, a string, a symbol,
630 a list, a buffer, a window, a frame, etc.
632 A printed representation of an object is text which describes that object.
634 Optional argument PRINTCHARFUN is the output stream, which can be one
635 of these:
637 - a buffer, in which case output is inserted into that buffer at point;
638 - a marker, in which case output is inserted at marker's position;
639 - a function, in which case that function is called once for each
640 character of OBJECT's printed representation;
641 - a symbol, in which case that symbol's function definition is called; or
642 - t, in which case the output is displayed in the echo area.
644 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
645 is used instead. */)
646 (Lisp_Object object, Lisp_Object printcharfun)
648 PRINTDECLARE;
650 if (NILP (printcharfun))
651 printcharfun = Vstandard_output;
652 PRINTPREPARE;
653 print (object, printcharfun, 1);
654 PRINTFINISH;
655 return object;
658 /* a buffer which is used to hold output being built by prin1-to-string */
659 Lisp_Object Vprin1_to_string_buffer;
661 DEFUN ("prin1-to-string", Fprin1_to_string, Sprin1_to_string, 1, 2, 0,
662 doc: /* Return a string containing the printed representation of OBJECT.
663 OBJECT can be any Lisp object. This function outputs quoting characters
664 when necessary to make output that `read' can handle, whenever possible,
665 unless the optional second argument NOESCAPE is non-nil. For complex objects,
666 the behavior is controlled by `print-level' and `print-length', which see.
668 OBJECT is any of the Lisp data types: a number, a string, a symbol,
669 a list, a buffer, a window, a frame, etc.
671 A printed representation of an object is text which describes that object. */)
672 (Lisp_Object object, Lisp_Object noescape)
674 Lisp_Object printcharfun;
675 /* struct gcpro gcpro1, gcpro2; */
676 Lisp_Object save_deactivate_mark;
677 int count = SPECPDL_INDEX ();
678 struct buffer *previous;
680 specbind (Qinhibit_modification_hooks, Qt);
683 PRINTDECLARE;
685 /* Save and restore this--we are altering a buffer
686 but we don't want to deactivate the mark just for that.
687 No need for specbind, since errors deactivate the mark. */
688 save_deactivate_mark = Vdeactivate_mark;
689 /* GCPRO2 (object, save_deactivate_mark); */
690 abort_on_gc++;
692 printcharfun = Vprin1_to_string_buffer;
693 PRINTPREPARE;
694 print (object, printcharfun, NILP (noescape));
695 /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
696 PRINTFINISH;
699 previous = current_buffer;
700 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
701 object = Fbuffer_string ();
702 if (SBYTES (object) == SCHARS (object))
703 STRING_SET_UNIBYTE (object);
705 /* Note that this won't make prepare_to_modify_buffer call
706 ask-user-about-supersession-threat because this buffer
707 does not visit a file. */
708 Ferase_buffer ();
709 set_buffer_internal (previous);
711 Vdeactivate_mark = save_deactivate_mark;
712 /* UNGCPRO; */
714 abort_on_gc--;
715 return unbind_to (count, object);
718 DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
719 doc: /* Output the printed representation of OBJECT, any Lisp object.
720 No quoting characters are used; no delimiters are printed around
721 the contents of strings.
723 OBJECT is any of the Lisp data types: a number, a string, a symbol,
724 a list, a buffer, a window, a frame, etc.
726 A printed representation of an object is text which describes that object.
728 Optional argument PRINTCHARFUN is the output stream, which can be one
729 of these:
731 - a buffer, in which case output is inserted into that buffer at point;
732 - a marker, in which case output is inserted at marker's position;
733 - a function, in which case that function is called once for each
734 character of OBJECT's printed representation;
735 - a symbol, in which case that symbol's function definition is called; or
736 - t, in which case the output is displayed in the echo area.
738 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
739 is used instead. */)
740 (Lisp_Object object, Lisp_Object printcharfun)
742 PRINTDECLARE;
744 if (NILP (printcharfun))
745 printcharfun = Vstandard_output;
746 PRINTPREPARE;
747 print (object, printcharfun, 0);
748 PRINTFINISH;
749 return object;
752 DEFUN ("print", Fprint, Sprint, 1, 2, 0,
753 doc: /* Output the printed representation of OBJECT, with newlines around it.
754 Quoting characters are printed when needed to make output that `read'
755 can handle, whenever this is possible. For complex objects, the behavior
756 is controlled by `print-level' and `print-length', which see.
758 OBJECT is any of the Lisp data types: a number, a string, a symbol,
759 a list, a buffer, a window, a frame, etc.
761 A printed representation of an object is text which describes that object.
763 Optional argument PRINTCHARFUN is the output stream, which can be one
764 of these:
766 - a buffer, in which case output is inserted into that buffer at point;
767 - a marker, in which case output is inserted at marker's position;
768 - a function, in which case that function is called once for each
769 character of OBJECT's printed representation;
770 - a symbol, in which case that symbol's function definition is called; or
771 - t, in which case the output is displayed in the echo area.
773 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
774 is used instead. */)
775 (Lisp_Object object, Lisp_Object printcharfun)
777 PRINTDECLARE;
778 struct gcpro gcpro1;
780 if (NILP (printcharfun))
781 printcharfun = Vstandard_output;
782 GCPRO1 (object);
783 PRINTPREPARE;
784 PRINTCHAR ('\n');
785 print (object, printcharfun, 1);
786 PRINTCHAR ('\n');
787 PRINTFINISH;
788 UNGCPRO;
789 return object;
792 /* The subroutine object for external-debugging-output is kept here
793 for the convenience of the debugger. */
794 Lisp_Object Qexternal_debugging_output;
796 DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
797 doc: /* Write CHARACTER to stderr.
798 You can call print while debugging emacs, and pass it this function
799 to make it write to the debugging output. */)
800 (Lisp_Object character)
802 CHECK_NUMBER (character);
803 putc ((int) XINT (character), stderr);
805 #ifdef WINDOWSNT
806 /* Send the output to a debugger (nothing happens if there isn't one). */
807 if (print_output_debug_flag)
809 char buf[2] = {(char) XINT (character), '\0'};
810 OutputDebugString (buf);
812 #endif
814 return character;
817 /* This function is never called. Its purpose is to prevent
818 print_output_debug_flag from being optimized away. */
820 void
821 debug_output_compilation_hack (int x)
823 print_output_debug_flag = x;
826 #if defined (GNU_LINUX)
828 /* This functionality is not vitally important in general, so we rely on
829 non-portable ability to use stderr as lvalue. */
831 #define WITH_REDIRECT_DEBUGGING_OUTPUT 1
833 FILE *initial_stderr_stream = NULL;
835 DEFUN ("redirect-debugging-output", Fredirect_debugging_output, Sredirect_debugging_output,
836 1, 2,
837 "FDebug output file: \nP",
838 doc: /* Redirect debugging output (stderr stream) to file FILE.
839 If FILE is nil, reset target to the initial stderr stream.
840 Optional arg APPEND non-nil (interactively, with prefix arg) means
841 append to existing target file. */)
842 (Lisp_Object file, Lisp_Object append)
844 if (initial_stderr_stream != NULL)
846 BLOCK_INPUT;
847 fclose (stderr);
848 UNBLOCK_INPUT;
850 stderr = initial_stderr_stream;
851 initial_stderr_stream = NULL;
853 if (STRINGP (file))
855 file = Fexpand_file_name (file, Qnil);
856 initial_stderr_stream = stderr;
857 stderr = fopen (SDATA (file), NILP (append) ? "w" : "a");
858 if (stderr == NULL)
860 stderr = initial_stderr_stream;
861 initial_stderr_stream = NULL;
862 report_file_error ("Cannot open debugging output stream",
863 Fcons (file, Qnil));
866 return Qnil;
868 #endif /* GNU_LINUX */
871 /* This is the interface for debugging printing. */
873 void
874 debug_print (Lisp_Object arg)
876 Fprin1 (arg, Qexternal_debugging_output);
877 fprintf (stderr, "\r\n");
880 void
881 safe_debug_print (Lisp_Object arg)
883 int valid = valid_lisp_object_p (arg);
885 if (valid > 0)
886 debug_print (arg);
887 else
888 fprintf (stderr, "#<%s_LISP_OBJECT 0x%08lx>\r\n",
889 !valid ? "INVALID" : "SOME",
890 (unsigned long) XHASH (arg)
895 DEFUN ("error-message-string", Ferror_message_string, Serror_message_string,
896 1, 1, 0,
897 doc: /* Convert an error value (ERROR-SYMBOL . DATA) to an error message.
898 See Info anchor `(elisp)Definition of signal' for some details on how this
899 error message is constructed. */)
900 (Lisp_Object obj)
902 struct buffer *old = current_buffer;
903 Lisp_Object value;
904 struct gcpro gcpro1;
906 /* If OBJ is (error STRING), just return STRING.
907 That is not only faster, it also avoids the need to allocate
908 space here when the error is due to memory full. */
909 if (CONSP (obj) && EQ (XCAR (obj), Qerror)
910 && CONSP (XCDR (obj))
911 && STRINGP (XCAR (XCDR (obj)))
912 && NILP (XCDR (XCDR (obj))))
913 return XCAR (XCDR (obj));
915 print_error_message (obj, Vprin1_to_string_buffer, 0, Qnil);
917 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
918 value = Fbuffer_string ();
920 GCPRO1 (value);
921 Ferase_buffer ();
922 set_buffer_internal (old);
923 UNGCPRO;
925 return value;
928 /* Print an error message for the error DATA onto Lisp output stream
929 STREAM (suitable for the print functions).
930 CONTEXT is a C string describing the context of the error.
931 CALLER is the Lisp function inside which the error was signaled. */
933 void
934 print_error_message (Lisp_Object data, Lisp_Object stream, const char *context,
935 Lisp_Object caller)
937 Lisp_Object errname, errmsg, file_error, tail;
938 struct gcpro gcpro1;
939 int i;
941 if (context != 0)
942 write_string_1 (context, -1, stream);
944 /* If we know from where the error was signaled, show it in
945 *Messages*. */
946 if (!NILP (caller) && SYMBOLP (caller))
948 Lisp_Object cname = SYMBOL_NAME (caller);
949 char *name = alloca (SBYTES (cname));
950 memcpy (name, SDATA (cname), SBYTES (cname));
951 message_dolog (name, SBYTES (cname), 0, 0);
952 message_dolog (": ", 2, 0, 0);
955 errname = Fcar (data);
957 if (EQ (errname, Qerror))
959 data = Fcdr (data);
960 if (!CONSP (data))
961 data = Qnil;
962 errmsg = Fcar (data);
963 file_error = Qnil;
965 else
967 Lisp_Object error_conditions;
968 errmsg = Fget (errname, Qerror_message);
969 error_conditions = Fget (errname, Qerror_conditions);
970 file_error = Fmemq (Qfile_error, error_conditions);
973 /* Print an error message including the data items. */
975 tail = Fcdr_safe (data);
976 GCPRO1 (tail);
978 /* For file-error, make error message by concatenating
979 all the data items. They are all strings. */
980 if (!NILP (file_error) && CONSP (tail))
981 errmsg = XCAR (tail), tail = XCDR (tail);
983 if (STRINGP (errmsg))
984 Fprinc (errmsg, stream);
985 else
986 write_string_1 ("peculiar error", -1, stream);
988 for (i = 0; CONSP (tail); tail = XCDR (tail), i++)
990 Lisp_Object obj;
992 write_string_1 (i ? ", " : ": ", 2, stream);
993 obj = XCAR (tail);
994 if (!NILP (file_error) || EQ (errname, Qend_of_file))
995 Fprinc (obj, stream);
996 else
997 Fprin1 (obj, stream);
1000 UNGCPRO;
1006 * The buffer should be at least as large as the max string size of the
1007 * largest float, printed in the biggest notation. This is undoubtedly
1008 * 20d float_output_format, with the negative of the C-constant "HUGE"
1009 * from <math.h>.
1011 * On the vax the worst case is -1e38 in 20d format which takes 61 bytes.
1013 * I assume that IEEE-754 format numbers can take 329 bytes for the worst
1014 * case of -1e307 in 20d float_output_format. What is one to do (short of
1015 * re-writing _doprnt to be more sane)?
1016 * -wsr
1017 * Given the above, the buffer must be least FLOAT_TO_STRING_BUFSIZE bytes.
1020 void
1021 float_to_string (char *buf, double data)
1023 char *cp;
1024 int width;
1026 /* Check for plus infinity in a way that won't lose
1027 if there is no plus infinity. */
1028 if (data == data / 2 && data > 1.0)
1030 strcpy (buf, "1.0e+INF");
1031 return;
1033 /* Likewise for minus infinity. */
1034 if (data == data / 2 && data < -1.0)
1036 strcpy (buf, "-1.0e+INF");
1037 return;
1039 /* Check for NaN in a way that won't fail if there are no NaNs. */
1040 if (! (data * 0.0 >= 0.0))
1042 /* Prepend "-" if the NaN's sign bit is negative.
1043 The sign bit of a double is the bit that is 1 in -0.0. */
1044 int i;
1045 union { double d; char c[sizeof (double)]; } u_data, u_minus_zero;
1046 u_data.d = data;
1047 u_minus_zero.d = - 0.0;
1048 for (i = 0; i < sizeof (double); i++)
1049 if (u_data.c[i] & u_minus_zero.c[i])
1051 *buf++ = '-';
1052 break;
1055 strcpy (buf, "0.0e+NaN");
1056 return;
1059 if (NILP (Vfloat_output_format)
1060 || !STRINGP (Vfloat_output_format))
1061 lose:
1063 /* Generate the fewest number of digits that represent the
1064 floating point value without losing information. */
1065 dtoastr (buf, FLOAT_TO_STRING_BUFSIZE - 2, 0, 0, data);
1066 /* The decimal point must be printed, or the byte compiler can
1067 get confused (Bug#8033). */
1068 width = 1;
1070 else /* oink oink */
1072 /* Check that the spec we have is fully valid.
1073 This means not only valid for printf,
1074 but meant for floats, and reasonable. */
1075 cp = SSDATA (Vfloat_output_format);
1077 if (cp[0] != '%')
1078 goto lose;
1079 if (cp[1] != '.')
1080 goto lose;
1082 cp += 2;
1084 /* Check the width specification. */
1085 width = -1;
1086 if ('0' <= *cp && *cp <= '9')
1088 width = 0;
1090 width = (width * 10) + (*cp++ - '0');
1091 while (*cp >= '0' && *cp <= '9');
1093 /* A precision of zero is valid only for %f. */
1094 if (width > DBL_DIG
1095 || (width == 0 && *cp != 'f'))
1096 goto lose;
1099 if (*cp != 'e' && *cp != 'f' && *cp != 'g')
1100 goto lose;
1102 if (cp[1] != 0)
1103 goto lose;
1105 sprintf (buf, SSDATA (Vfloat_output_format), data);
1108 /* Make sure there is a decimal point with digit after, or an
1109 exponent, so that the value is readable as a float. But don't do
1110 this with "%.0f"; it's valid for that not to produce a decimal
1111 point. Note that width can be 0 only for %.0f. */
1112 if (width != 0)
1114 for (cp = buf; *cp; cp++)
1115 if ((*cp < '0' || *cp > '9') && *cp != '-')
1116 break;
1118 if (*cp == '.' && cp[1] == 0)
1120 cp[1] = '0';
1121 cp[2] = 0;
1123 else if (*cp == 0)
1125 *cp++ = '.';
1126 *cp++ = '0';
1127 *cp++ = 0;
1133 static void
1134 print (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag)
1136 new_backquote_output = 0;
1138 /* Reset print_number_index and Vprint_number_table only when
1139 the variable Vprint_continuous_numbering is nil. Otherwise,
1140 the values of these variables will be kept between several
1141 print functions. */
1142 if (NILP (Vprint_continuous_numbering)
1143 || NILP (Vprint_number_table))
1145 print_number_index = 0;
1146 Vprint_number_table = Qnil;
1149 /* Construct Vprint_number_table for print-gensym and print-circle. */
1150 if (!NILP (Vprint_gensym) || !NILP (Vprint_circle))
1152 /* Construct Vprint_number_table.
1153 This increments print_number_index for the objects added. */
1154 print_depth = 0;
1155 print_preprocess (obj);
1157 if (HASH_TABLE_P (Vprint_number_table))
1158 { /* Remove unnecessary objects, which appear only once in OBJ;
1159 that is, whose status is Qt.
1160 Maybe a better way to do that is to copy elements to
1161 a new hash table. */
1162 struct Lisp_Hash_Table *h = XHASH_TABLE (Vprint_number_table);
1163 int i;
1165 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1166 if (!NILP (HASH_HASH (h, i))
1167 && EQ (HASH_VALUE (h, i), Qt))
1168 Fremhash (HASH_KEY (h, i), Vprint_number_table);
1172 print_depth = 0;
1173 print_object (obj, printcharfun, escapeflag);
1176 /* Construct Vprint_number_table according to the structure of OBJ.
1177 OBJ itself and all its elements will be added to Vprint_number_table
1178 recursively if it is a list, vector, compiled function, char-table,
1179 string (its text properties will be traced), or a symbol that has
1180 no obarray (this is for the print-gensym feature).
1181 The status fields of Vprint_number_table mean whether each object appears
1182 more than once in OBJ: Qnil at the first time, and Qt after that . */
1183 static void
1184 print_preprocess (Lisp_Object obj)
1186 int i;
1187 EMACS_INT size;
1188 int loop_count = 0;
1189 Lisp_Object halftail;
1191 /* Give up if we go so deep that print_object will get an error. */
1192 /* See similar code in print_object. */
1193 if (print_depth >= PRINT_CIRCLE)
1194 error ("Apparently circular structure being printed");
1196 /* Avoid infinite recursion for circular nested structure
1197 in the case where Vprint_circle is nil. */
1198 if (NILP (Vprint_circle))
1200 for (i = 0; i < print_depth; i++)
1201 if (EQ (obj, being_printed[i]))
1202 return;
1203 being_printed[print_depth] = obj;
1206 print_depth++;
1207 halftail = obj;
1209 loop:
1210 if (STRINGP (obj) || CONSP (obj) || VECTORP (obj)
1211 || COMPILEDP (obj) || CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj)
1212 || HASH_TABLE_P (obj)
1213 || (! NILP (Vprint_gensym)
1214 && SYMBOLP (obj)
1215 && !SYMBOL_INTERNED_P (obj)))
1217 if (!HASH_TABLE_P (Vprint_number_table))
1219 Lisp_Object args[2];
1220 args[0] = QCtest;
1221 args[1] = Qeq;
1222 Vprint_number_table = Fmake_hash_table (2, args);
1225 /* In case print-circle is nil and print-gensym is t,
1226 add OBJ to Vprint_number_table only when OBJ is a symbol. */
1227 if (! NILP (Vprint_circle) || SYMBOLP (obj))
1229 Lisp_Object num = Fgethash (obj, Vprint_number_table, Qnil);
1230 if (!NILP (num)
1231 /* If Vprint_continuous_numbering is non-nil and OBJ is a gensym,
1232 always print the gensym with a number. This is a special for
1233 the lisp function byte-compile-output-docform. */
1234 || (!NILP (Vprint_continuous_numbering)
1235 && SYMBOLP (obj)
1236 && !SYMBOL_INTERNED_P (obj)))
1237 { /* OBJ appears more than once. Let's remember that. */
1238 if (!INTEGERP (num))
1240 print_number_index++;
1241 /* Negative number indicates it hasn't been printed yet. */
1242 Fputhash (obj, make_number (- print_number_index),
1243 Vprint_number_table);
1245 print_depth--;
1246 return;
1248 else
1249 /* OBJ is not yet recorded. Let's add to the table. */
1250 Fputhash (obj, Qt, Vprint_number_table);
1253 switch (XTYPE (obj))
1255 case Lisp_String:
1256 /* A string may have text properties, which can be circular. */
1257 traverse_intervals_noorder (STRING_INTERVALS (obj),
1258 print_preprocess_string, Qnil);
1259 break;
1261 case Lisp_Cons:
1262 /* Use HALFTAIL and LOOP_COUNT to detect circular lists,
1263 just as in print_object. */
1264 if (loop_count && EQ (obj, halftail))
1265 break;
1266 print_preprocess (XCAR (obj));
1267 obj = XCDR (obj);
1268 loop_count++;
1269 if (!(loop_count & 1))
1270 halftail = XCDR (halftail);
1271 goto loop;
1273 case Lisp_Vectorlike:
1274 size = XVECTOR (obj)->size;
1275 if (size & PSEUDOVECTOR_FLAG)
1276 size &= PSEUDOVECTOR_SIZE_MASK;
1277 for (i = 0; i < size; i++)
1278 print_preprocess (XVECTOR (obj)->contents[i]);
1279 if (HASH_TABLE_P (obj))
1280 { /* For hash tables, the key_and_value slot is past
1281 `size' because it needs to be marked specially in case
1282 the table is weak. */
1283 struct Lisp_Hash_Table *h = XHASH_TABLE (obj);
1284 print_preprocess (h->key_and_value);
1286 break;
1288 default:
1289 break;
1292 print_depth--;
1295 static void
1296 print_preprocess_string (INTERVAL interval, Lisp_Object arg)
1298 print_preprocess (interval->plist);
1301 static void print_check_string_charset_prop (INTERVAL interval, Lisp_Object string);
1303 #define PRINT_STRING_NON_CHARSET_FOUND 1
1304 #define PRINT_STRING_UNSAFE_CHARSET_FOUND 2
1306 /* Bitwise or of the above macros. */
1307 static int print_check_string_result;
1309 static void
1310 print_check_string_charset_prop (INTERVAL interval, Lisp_Object string)
1312 Lisp_Object val;
1314 if (NILP (interval->plist)
1315 || (print_check_string_result == (PRINT_STRING_NON_CHARSET_FOUND
1316 | PRINT_STRING_UNSAFE_CHARSET_FOUND)))
1317 return;
1318 for (val = interval->plist; CONSP (val) && ! EQ (XCAR (val), Qcharset);
1319 val = XCDR (XCDR (val)));
1320 if (! CONSP (val))
1322 print_check_string_result |= PRINT_STRING_NON_CHARSET_FOUND;
1323 return;
1325 if (! (print_check_string_result & PRINT_STRING_NON_CHARSET_FOUND))
1327 if (! EQ (val, interval->plist)
1328 || CONSP (XCDR (XCDR (val))))
1329 print_check_string_result |= PRINT_STRING_NON_CHARSET_FOUND;
1331 if (NILP (Vprint_charset_text_property)
1332 || ! (print_check_string_result & PRINT_STRING_UNSAFE_CHARSET_FOUND))
1334 int i, c;
1335 EMACS_INT charpos = interval->position;
1336 EMACS_INT bytepos = string_char_to_byte (string, charpos);
1337 Lisp_Object charset;
1339 charset = XCAR (XCDR (val));
1340 for (i = 0; i < LENGTH (interval); i++)
1342 FETCH_STRING_CHAR_ADVANCE (c, string, charpos, bytepos);
1343 if (! ASCII_CHAR_P (c)
1344 && ! EQ (CHARSET_NAME (CHAR_CHARSET (c)), charset))
1346 print_check_string_result |= PRINT_STRING_UNSAFE_CHARSET_FOUND;
1347 break;
1353 /* The value is (charset . nil). */
1354 static Lisp_Object print_prune_charset_plist;
1356 static Lisp_Object
1357 print_prune_string_charset (Lisp_Object string)
1359 print_check_string_result = 0;
1360 traverse_intervals (STRING_INTERVALS (string), 0,
1361 print_check_string_charset_prop, string);
1362 if (! (print_check_string_result & PRINT_STRING_UNSAFE_CHARSET_FOUND))
1364 string = Fcopy_sequence (string);
1365 if (print_check_string_result & PRINT_STRING_NON_CHARSET_FOUND)
1367 if (NILP (print_prune_charset_plist))
1368 print_prune_charset_plist = Fcons (Qcharset, Qnil);
1369 Fremove_text_properties (make_number (0),
1370 make_number (SCHARS (string)),
1371 print_prune_charset_plist, string);
1373 else
1374 Fset_text_properties (make_number (0), make_number (SCHARS (string)),
1375 Qnil, string);
1377 return string;
1380 static void
1381 print_object (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag)
1383 char buf[40];
1385 QUIT;
1387 /* See similar code in print_preprocess. */
1388 if (print_depth >= PRINT_CIRCLE)
1389 error ("Apparently circular structure being printed");
1391 /* Detect circularities and truncate them. */
1392 if (STRINGP (obj) || CONSP (obj) || VECTORP (obj)
1393 || COMPILEDP (obj) || CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj)
1394 || HASH_TABLE_P (obj)
1395 || (! NILP (Vprint_gensym)
1396 && SYMBOLP (obj)
1397 && !SYMBOL_INTERNED_P (obj)))
1399 if (NILP (Vprint_circle) && NILP (Vprint_gensym))
1401 /* Simple but incomplete way. */
1402 int i;
1403 for (i = 0; i < print_depth; i++)
1404 if (EQ (obj, being_printed[i]))
1406 sprintf (buf, "#%d", i);
1407 strout (buf, -1, -1, printcharfun, 0);
1408 return;
1410 being_printed[print_depth] = obj;
1412 else
1414 /* With the print-circle feature. */
1415 Lisp_Object num = Fgethash (obj, Vprint_number_table, Qnil);
1416 if (INTEGERP (num))
1418 int n = XINT (num);
1419 if (n < 0)
1420 { /* Add a prefix #n= if OBJ has not yet been printed;
1421 that is, its status field is nil. */
1422 sprintf (buf, "#%d=", -n);
1423 strout (buf, -1, -1, printcharfun, 0);
1424 /* OBJ is going to be printed. Remember that fact. */
1425 Fputhash (obj, make_number (- n), Vprint_number_table);
1427 else
1429 /* Just print #n# if OBJ has already been printed. */
1430 sprintf (buf, "#%d#", n);
1431 strout (buf, -1, -1, printcharfun, 0);
1432 return;
1438 print_depth++;
1440 switch (XTYPE (obj))
1442 case_Lisp_Int:
1443 if (sizeof (int) == sizeof (EMACS_INT))
1444 sprintf (buf, "%d", (int) XINT (obj));
1445 else if (sizeof (long) == sizeof (EMACS_INT))
1446 sprintf (buf, "%ld", (long) XINT (obj));
1447 else
1448 abort ();
1449 strout (buf, -1, -1, printcharfun, 0);
1450 break;
1452 case Lisp_Float:
1454 char pigbuf[FLOAT_TO_STRING_BUFSIZE];
1456 float_to_string (pigbuf, XFLOAT_DATA (obj));
1457 strout (pigbuf, -1, -1, printcharfun, 0);
1459 break;
1461 case Lisp_String:
1462 if (!escapeflag)
1463 print_string (obj, printcharfun);
1464 else
1466 register EMACS_INT i, i_byte;
1467 struct gcpro gcpro1;
1468 unsigned char *str;
1469 EMACS_INT size_byte;
1470 /* 1 means we must ensure that the next character we output
1471 cannot be taken as part of a hex character escape. */
1472 int need_nonhex = 0;
1473 int multibyte = STRING_MULTIBYTE (obj);
1475 GCPRO1 (obj);
1477 if (! EQ (Vprint_charset_text_property, Qt))
1478 obj = print_prune_string_charset (obj);
1480 if (!NULL_INTERVAL_P (STRING_INTERVALS (obj)))
1482 PRINTCHAR ('#');
1483 PRINTCHAR ('(');
1486 PRINTCHAR ('\"');
1487 str = SDATA (obj);
1488 size_byte = SBYTES (obj);
1490 for (i = 0, i_byte = 0; i_byte < size_byte;)
1492 /* Here, we must convert each multi-byte form to the
1493 corresponding character code before handing it to PRINTCHAR. */
1494 int len;
1495 int c;
1497 if (multibyte)
1499 c = STRING_CHAR_AND_LENGTH (str + i_byte, len);
1500 i_byte += len;
1502 else
1503 c = str[i_byte++];
1505 QUIT;
1507 if (c == '\n' && print_escape_newlines)
1509 PRINTCHAR ('\\');
1510 PRINTCHAR ('n');
1512 else if (c == '\f' && print_escape_newlines)
1514 PRINTCHAR ('\\');
1515 PRINTCHAR ('f');
1517 else if (multibyte
1518 && (CHAR_BYTE8_P (c)
1519 || (! ASCII_CHAR_P (c) && print_escape_multibyte)))
1521 /* When multibyte is disabled,
1522 print multibyte string chars using hex escapes.
1523 For a char code that could be in a unibyte string,
1524 when found in a multibyte string, always use a hex escape
1525 so it reads back as multibyte. */
1526 char outbuf[50];
1528 if (CHAR_BYTE8_P (c))
1529 sprintf (outbuf, "\\%03o", CHAR_TO_BYTE8 (c));
1530 else
1532 sprintf (outbuf, "\\x%04x", c);
1533 need_nonhex = 1;
1535 strout (outbuf, -1, -1, printcharfun, 0);
1537 else if (! multibyte
1538 && SINGLE_BYTE_CHAR_P (c) && ! ASCII_BYTE_P (c)
1539 && print_escape_nonascii)
1541 /* When printing in a multibyte buffer
1542 or when explicitly requested,
1543 print single-byte non-ASCII string chars
1544 using octal escapes. */
1545 char outbuf[5];
1546 sprintf (outbuf, "\\%03o", c);
1547 strout (outbuf, -1, -1, printcharfun, 0);
1549 else
1551 /* If we just had a hex escape, and this character
1552 could be taken as part of it,
1553 output `\ ' to prevent that. */
1554 if (need_nonhex)
1556 need_nonhex = 0;
1557 if ((c >= 'a' && c <= 'f')
1558 || (c >= 'A' && c <= 'F')
1559 || (c >= '0' && c <= '9'))
1560 strout ("\\ ", -1, -1, printcharfun, 0);
1563 if (c == '\"' || c == '\\')
1564 PRINTCHAR ('\\');
1565 PRINTCHAR (c);
1568 PRINTCHAR ('\"');
1570 if (!NULL_INTERVAL_P (STRING_INTERVALS (obj)))
1572 traverse_intervals (STRING_INTERVALS (obj),
1573 0, print_interval, printcharfun);
1574 PRINTCHAR (')');
1577 UNGCPRO;
1579 break;
1581 case Lisp_Symbol:
1583 register int confusing;
1584 register unsigned char *p = SDATA (SYMBOL_NAME (obj));
1585 register unsigned char *end = p + SBYTES (SYMBOL_NAME (obj));
1586 register int c;
1587 int i, i_byte;
1588 EMACS_INT size_byte;
1589 Lisp_Object name;
1591 name = SYMBOL_NAME (obj);
1593 if (p != end && (*p == '-' || *p == '+')) p++;
1594 if (p == end)
1595 confusing = 0;
1596 /* If symbol name begins with a digit, and ends with a digit,
1597 and contains nothing but digits and `e', it could be treated
1598 as a number. So set CONFUSING.
1600 Symbols that contain periods could also be taken as numbers,
1601 but periods are always escaped, so we don't have to worry
1602 about them here. */
1603 else if (*p >= '0' && *p <= '9'
1604 && end[-1] >= '0' && end[-1] <= '9')
1606 while (p != end && ((*p >= '0' && *p <= '9')
1607 /* Needed for \2e10. */
1608 || *p == 'e' || *p == 'E'))
1609 p++;
1610 confusing = (end == p);
1612 else
1613 confusing = 0;
1615 if (! NILP (Vprint_gensym) && !SYMBOL_INTERNED_P (obj))
1617 PRINTCHAR ('#');
1618 PRINTCHAR (':');
1621 size_byte = SBYTES (name);
1623 for (i = 0, i_byte = 0; i_byte < size_byte;)
1625 /* Here, we must convert each multi-byte form to the
1626 corresponding character code before handing it to PRINTCHAR. */
1627 FETCH_STRING_CHAR_ADVANCE (c, name, i, i_byte);
1628 QUIT;
1630 if (escapeflag)
1632 if (c == '\"' || c == '\\' || c == '\''
1633 || c == ';' || c == '#' || c == '(' || c == ')'
1634 || c == ',' || c =='.' || c == '`'
1635 || c == '[' || c == ']' || c == '?' || c <= 040
1636 || confusing)
1637 PRINTCHAR ('\\'), confusing = 0;
1639 PRINTCHAR (c);
1642 break;
1644 case Lisp_Cons:
1645 /* If deeper than spec'd depth, print placeholder. */
1646 if (INTEGERP (Vprint_level)
1647 && print_depth > XINT (Vprint_level))
1648 strout ("...", -1, -1, printcharfun, 0);
1649 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1650 && (EQ (XCAR (obj), Qquote)))
1652 PRINTCHAR ('\'');
1653 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1655 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1656 && (EQ (XCAR (obj), Qfunction)))
1658 PRINTCHAR ('#');
1659 PRINTCHAR ('\'');
1660 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1662 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1663 && ((EQ (XCAR (obj), Qbackquote))))
1665 print_object (XCAR (obj), printcharfun, 0);
1666 new_backquote_output++;
1667 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1668 new_backquote_output--;
1670 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1671 && new_backquote_output
1672 && ((EQ (XCAR (obj), Qbackquote)
1673 || EQ (XCAR (obj), Qcomma)
1674 || EQ (XCAR (obj), Qcomma_at)
1675 || EQ (XCAR (obj), Qcomma_dot))))
1677 print_object (XCAR (obj), printcharfun, 0);
1678 new_backquote_output--;
1679 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1680 new_backquote_output++;
1682 else
1684 PRINTCHAR ('(');
1686 /* If the first element is a backquote form,
1687 print it old-style so it won't be misunderstood. */
1688 if (print_quoted && CONSP (XCAR (obj))
1689 && CONSP (XCDR (XCAR (obj)))
1690 && NILP (XCDR (XCDR (XCAR (obj))))
1691 && EQ (XCAR (XCAR (obj)), Qbackquote))
1693 Lisp_Object tem;
1694 tem = XCAR (obj);
1695 PRINTCHAR ('(');
1697 print_object (Qbackquote, printcharfun, 0);
1698 PRINTCHAR (' ');
1700 print_object (XCAR (XCDR (tem)), printcharfun, 0);
1701 PRINTCHAR (')');
1703 obj = XCDR (obj);
1707 EMACS_INT print_length;
1708 int i;
1709 Lisp_Object halftail = obj;
1711 /* Negative values of print-length are invalid in CL.
1712 Treat them like nil, as CMUCL does. */
1713 if (NATNUMP (Vprint_length))
1714 print_length = XFASTINT (Vprint_length);
1715 else
1716 print_length = 0;
1718 i = 0;
1719 while (CONSP (obj))
1721 /* Detect circular list. */
1722 if (NILP (Vprint_circle))
1724 /* Simple but imcomplete way. */
1725 if (i != 0 && EQ (obj, halftail))
1727 sprintf (buf, " . #%d", i / 2);
1728 strout (buf, -1, -1, printcharfun, 0);
1729 goto end_of_list;
1732 else
1734 /* With the print-circle feature. */
1735 if (i != 0)
1737 Lisp_Object num = Fgethash (obj, Vprint_number_table, Qnil);
1738 if (INTEGERP (num))
1740 strout (" . ", 3, 3, printcharfun, 0);
1741 print_object (obj, printcharfun, escapeflag);
1742 goto end_of_list;
1747 if (i++)
1748 PRINTCHAR (' ');
1750 if (print_length && i > print_length)
1752 strout ("...", 3, 3, printcharfun, 0);
1753 goto end_of_list;
1756 print_object (XCAR (obj), printcharfun, escapeflag);
1758 obj = XCDR (obj);
1759 if (!(i & 1))
1760 halftail = XCDR (halftail);
1764 /* OBJ non-nil here means it's the end of a dotted list. */
1765 if (!NILP (obj))
1767 strout (" . ", 3, 3, printcharfun, 0);
1768 print_object (obj, printcharfun, escapeflag);
1771 end_of_list:
1772 PRINTCHAR (')');
1774 break;
1776 case Lisp_Vectorlike:
1777 if (PROCESSP (obj))
1779 if (escapeflag)
1781 strout ("#<process ", -1, -1, printcharfun, 0);
1782 print_string (XPROCESS (obj)->name, printcharfun);
1783 PRINTCHAR ('>');
1785 else
1786 print_string (XPROCESS (obj)->name, printcharfun);
1788 else if (BOOL_VECTOR_P (obj))
1790 register int i;
1791 register unsigned char c;
1792 struct gcpro gcpro1;
1793 EMACS_INT size_in_chars
1794 = ((XBOOL_VECTOR (obj)->size + BOOL_VECTOR_BITS_PER_CHAR - 1)
1795 / BOOL_VECTOR_BITS_PER_CHAR);
1797 GCPRO1 (obj);
1799 PRINTCHAR ('#');
1800 PRINTCHAR ('&');
1801 sprintf (buf, "%ld", (long) XBOOL_VECTOR (obj)->size);
1802 strout (buf, -1, -1, printcharfun, 0);
1803 PRINTCHAR ('\"');
1805 /* Don't print more characters than the specified maximum.
1806 Negative values of print-length are invalid. Treat them
1807 like a print-length of nil. */
1808 if (NATNUMP (Vprint_length)
1809 && XFASTINT (Vprint_length) < size_in_chars)
1810 size_in_chars = XFASTINT (Vprint_length);
1812 for (i = 0; i < size_in_chars; i++)
1814 QUIT;
1815 c = XBOOL_VECTOR (obj)->data[i];
1816 if (c == '\n' && print_escape_newlines)
1818 PRINTCHAR ('\\');
1819 PRINTCHAR ('n');
1821 else if (c == '\f' && print_escape_newlines)
1823 PRINTCHAR ('\\');
1824 PRINTCHAR ('f');
1826 else if (c > '\177')
1828 /* Use octal escapes to avoid encoding issues. */
1829 PRINTCHAR ('\\');
1830 PRINTCHAR ('0' + ((c >> 6) & 3));
1831 PRINTCHAR ('0' + ((c >> 3) & 7));
1832 PRINTCHAR ('0' + (c & 7));
1834 else
1836 if (c == '\"' || c == '\\')
1837 PRINTCHAR ('\\');
1838 PRINTCHAR (c);
1841 PRINTCHAR ('\"');
1843 UNGCPRO;
1845 else if (SUBRP (obj))
1847 strout ("#<subr ", -1, -1, printcharfun, 0);
1848 strout (XSUBR (obj)->symbol_name, -1, -1, printcharfun, 0);
1849 PRINTCHAR ('>');
1851 else if (WINDOWP (obj))
1853 strout ("#<window ", -1, -1, printcharfun, 0);
1854 sprintf (buf, "%ld", (long) XFASTINT (XWINDOW (obj)->sequence_number));
1855 strout (buf, -1, -1, printcharfun, 0);
1856 if (!NILP (XWINDOW (obj)->buffer))
1858 strout (" on ", -1, -1, printcharfun, 0);
1859 print_string (BVAR (XBUFFER (XWINDOW (obj)->buffer), name), printcharfun);
1861 PRINTCHAR ('>');
1863 else if (TERMINALP (obj))
1865 struct terminal *t = XTERMINAL (obj);
1866 strout ("#<terminal ", -1, -1, printcharfun, 0);
1867 sprintf (buf, "%d", t->id);
1868 strout (buf, -1, -1, printcharfun, 0);
1869 if (t->name)
1871 strout (" on ", -1, -1, printcharfun, 0);
1872 strout (t->name, -1, -1, printcharfun, 0);
1874 PRINTCHAR ('>');
1876 else if (HASH_TABLE_P (obj))
1878 struct Lisp_Hash_Table *h = XHASH_TABLE (obj);
1879 int i;
1880 EMACS_INT real_size, size;
1881 #if 0
1882 strout ("#<hash-table", -1, -1, printcharfun, 0);
1883 if (SYMBOLP (h->test))
1885 PRINTCHAR (' ');
1886 PRINTCHAR ('\'');
1887 strout (SDATA (SYMBOL_NAME (h->test)), -1, -1, printcharfun, 0);
1888 PRINTCHAR (' ');
1889 strout (SDATA (SYMBOL_NAME (h->weak)), -1, -1, printcharfun, 0);
1890 PRINTCHAR (' ');
1891 sprintf (buf, "%ld/%ld", (long) h->count,
1892 (long) XVECTOR (h->next)->size);
1893 strout (buf, -1, -1, printcharfun, 0);
1895 sprintf (buf, " 0x%lx", (unsigned long) h);
1896 strout (buf, -1, -1, printcharfun, 0);
1897 PRINTCHAR ('>');
1898 #endif
1899 /* Implement a readable output, e.g.:
1900 #s(hash-table size 2 test equal data (k1 v1 k2 v2)) */
1901 /* Always print the size. */
1902 sprintf (buf, "#s(hash-table size %ld",
1903 (long) XVECTOR (h->next)->size);
1904 strout (buf, -1, -1, printcharfun, 0);
1906 if (!NILP (h->test))
1908 strout (" test ", -1, -1, printcharfun, 0);
1909 print_object (h->test, printcharfun, 0);
1912 if (!NILP (h->weak))
1914 strout (" weakness ", -1, -1, printcharfun, 0);
1915 print_object (h->weak, printcharfun, 0);
1918 if (!NILP (h->rehash_size))
1920 strout (" rehash-size ", -1, -1, printcharfun, 0);
1921 print_object (h->rehash_size, printcharfun, 0);
1924 if (!NILP (h->rehash_threshold))
1926 strout (" rehash-threshold ", -1, -1, printcharfun, 0);
1927 print_object (h->rehash_threshold, printcharfun, 0);
1930 strout (" data ", -1, -1, printcharfun, 0);
1932 /* Print the data here as a plist. */
1933 real_size = HASH_TABLE_SIZE (h);
1934 size = real_size;
1936 /* Don't print more elements than the specified maximum. */
1937 if (NATNUMP (Vprint_length)
1938 && XFASTINT (Vprint_length) < size)
1939 size = XFASTINT (Vprint_length);
1941 PRINTCHAR ('(');
1942 for (i = 0; i < size; i++)
1943 if (!NILP (HASH_HASH (h, i)))
1945 if (i) PRINTCHAR (' ');
1946 print_object (HASH_KEY (h, i), printcharfun, 1);
1947 PRINTCHAR (' ');
1948 print_object (HASH_VALUE (h, i), printcharfun, 1);
1951 if (size < real_size)
1952 strout (" ...", 4, 4, printcharfun, 0);
1954 PRINTCHAR (')');
1955 PRINTCHAR (')');
1958 else if (BUFFERP (obj))
1960 if (NILP (BVAR (XBUFFER (obj), name)))
1961 strout ("#<killed buffer>", -1, -1, printcharfun, 0);
1962 else if (escapeflag)
1964 strout ("#<buffer ", -1, -1, printcharfun, 0);
1965 print_string (BVAR (XBUFFER (obj), name), printcharfun);
1966 PRINTCHAR ('>');
1968 else
1969 print_string (BVAR (XBUFFER (obj), name), printcharfun);
1971 else if (WINDOW_CONFIGURATIONP (obj))
1973 strout ("#<window-configuration>", -1, -1, printcharfun, 0);
1975 else if (FRAMEP (obj))
1977 strout ((FRAME_LIVE_P (XFRAME (obj))
1978 ? "#<frame " : "#<dead frame "),
1979 -1, -1, printcharfun, 0);
1980 print_string (XFRAME (obj)->name, printcharfun);
1981 sprintf (buf, " 0x%lx", (unsigned long) (XFRAME (obj)));
1982 strout (buf, -1, -1, printcharfun, 0);
1983 PRINTCHAR ('>');
1985 else if (FONTP (obj))
1987 EMACS_INT i;
1989 if (! FONT_OBJECT_P (obj))
1991 if (FONT_SPEC_P (obj))
1992 strout ("#<font-spec", -1, -1, printcharfun, 0);
1993 else
1994 strout ("#<font-entity", -1, -1, printcharfun, 0);
1995 for (i = 0; i < FONT_SPEC_MAX; i++)
1997 PRINTCHAR (' ');
1998 if (i < FONT_WEIGHT_INDEX || i > FONT_WIDTH_INDEX)
1999 print_object (AREF (obj, i), printcharfun, escapeflag);
2000 else
2001 print_object (font_style_symbolic (obj, i, 0),
2002 printcharfun, escapeflag);
2005 else
2007 strout ("#<font-object ", -1, -1, printcharfun, 0);
2008 print_object (AREF (obj, FONT_NAME_INDEX), printcharfun,
2009 escapeflag);
2011 PRINTCHAR ('>');
2013 else
2015 EMACS_INT size = XVECTOR (obj)->size;
2016 if (COMPILEDP (obj))
2018 PRINTCHAR ('#');
2019 size &= PSEUDOVECTOR_SIZE_MASK;
2021 if (CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj))
2023 /* We print a char-table as if it were a vector,
2024 lumping the parent and default slots in with the
2025 character slots. But we add #^ as a prefix. */
2027 /* Make each lowest sub_char_table start a new line.
2028 Otherwise we'll make a line extremely long, which
2029 results in slow redisplay. */
2030 if (SUB_CHAR_TABLE_P (obj)
2031 && XINT (XSUB_CHAR_TABLE (obj)->depth) == 3)
2032 PRINTCHAR ('\n');
2033 PRINTCHAR ('#');
2034 PRINTCHAR ('^');
2035 if (SUB_CHAR_TABLE_P (obj))
2036 PRINTCHAR ('^');
2037 size &= PSEUDOVECTOR_SIZE_MASK;
2039 if (size & PSEUDOVECTOR_FLAG)
2040 goto badtype;
2042 PRINTCHAR ('[');
2044 register int i;
2045 register Lisp_Object tem;
2046 EMACS_INT real_size = size;
2048 /* Don't print more elements than the specified maximum. */
2049 if (NATNUMP (Vprint_length)
2050 && XFASTINT (Vprint_length) < size)
2051 size = XFASTINT (Vprint_length);
2053 for (i = 0; i < size; i++)
2055 if (i) PRINTCHAR (' ');
2056 tem = XVECTOR (obj)->contents[i];
2057 print_object (tem, printcharfun, escapeflag);
2059 if (size < real_size)
2060 strout (" ...", 4, 4, printcharfun, 0);
2062 PRINTCHAR (']');
2064 break;
2066 case Lisp_Misc:
2067 switch (XMISCTYPE (obj))
2069 case Lisp_Misc_Marker:
2070 strout ("#<marker ", -1, -1, printcharfun, 0);
2071 /* Do you think this is necessary? */
2072 if (XMARKER (obj)->insertion_type != 0)
2073 strout ("(moves after insertion) ", -1, -1, printcharfun, 0);
2074 if (! XMARKER (obj)->buffer)
2075 strout ("in no buffer", -1, -1, printcharfun, 0);
2076 else
2078 sprintf (buf, "at %ld", (long)marker_position (obj));
2079 strout (buf, -1, -1, printcharfun, 0);
2080 strout (" in ", -1, -1, printcharfun, 0);
2081 print_string (BVAR (XMARKER (obj)->buffer, name), printcharfun);
2083 PRINTCHAR ('>');
2084 break;
2086 case Lisp_Misc_Overlay:
2087 strout ("#<overlay ", -1, -1, printcharfun, 0);
2088 if (! XMARKER (OVERLAY_START (obj))->buffer)
2089 strout ("in no buffer", -1, -1, printcharfun, 0);
2090 else
2092 sprintf (buf, "from %ld to %ld in ",
2093 (long)marker_position (OVERLAY_START (obj)),
2094 (long)marker_position (OVERLAY_END (obj)));
2095 strout (buf, -1, -1, printcharfun, 0);
2096 print_string (BVAR (XMARKER (OVERLAY_START (obj))->buffer, name),
2097 printcharfun);
2099 PRINTCHAR ('>');
2100 break;
2102 /* Remaining cases shouldn't happen in normal usage, but let's print
2103 them anyway for the benefit of the debugger. */
2104 case Lisp_Misc_Free:
2105 strout ("#<misc free cell>", -1, -1, printcharfun, 0);
2106 break;
2108 case Lisp_Misc_Save_Value:
2109 strout ("#<save_value ", -1, -1, printcharfun, 0);
2110 sprintf(buf, "ptr=0x%08lx int=%d",
2111 (unsigned long) XSAVE_VALUE (obj)->pointer,
2112 XSAVE_VALUE (obj)->integer);
2113 strout (buf, -1, -1, printcharfun, 0);
2114 PRINTCHAR ('>');
2115 break;
2117 default:
2118 goto badtype;
2120 break;
2122 default:
2123 badtype:
2125 /* We're in trouble if this happens!
2126 Probably should just abort () */
2127 strout ("#<EMACS BUG: INVALID DATATYPE ", -1, -1, printcharfun, 0);
2128 if (MISCP (obj))
2129 sprintf (buf, "(MISC 0x%04x)", (int) XMISCTYPE (obj));
2130 else if (VECTORLIKEP (obj))
2131 sprintf (buf, "(PVEC 0x%08x)", (int) XVECTOR (obj)->size);
2132 else
2133 sprintf (buf, "(0x%02x)", (int) XTYPE (obj));
2134 strout (buf, -1, -1, printcharfun, 0);
2135 strout (" Save your buffers immediately and please report this bug>",
2136 -1, -1, printcharfun, 0);
2140 print_depth--;
2144 /* Print a description of INTERVAL using PRINTCHARFUN.
2145 This is part of printing a string that has text properties. */
2147 void
2148 print_interval (INTERVAL interval, Lisp_Object printcharfun)
2150 if (NILP (interval->plist))
2151 return;
2152 PRINTCHAR (' ');
2153 print_object (make_number (interval->position), printcharfun, 1);
2154 PRINTCHAR (' ');
2155 print_object (make_number (interval->position + LENGTH (interval)),
2156 printcharfun, 1);
2157 PRINTCHAR (' ');
2158 print_object (interval->plist, printcharfun, 1);
2162 void
2163 syms_of_print (void)
2165 Qtemp_buffer_setup_hook = intern_c_string ("temp-buffer-setup-hook");
2166 staticpro (&Qtemp_buffer_setup_hook);
2168 DEFVAR_LISP ("standard-output", Vstandard_output,
2169 doc: /* Output stream `print' uses by default for outputting a character.
2170 This may be any function of one argument.
2171 It may also be a buffer (output is inserted before point)
2172 or a marker (output is inserted and the marker is advanced)
2173 or the symbol t (output appears in the echo area). */);
2174 Vstandard_output = Qt;
2175 Qstandard_output = intern_c_string ("standard-output");
2176 staticpro (&Qstandard_output);
2178 DEFVAR_LISP ("float-output-format", Vfloat_output_format,
2179 doc: /* The format descriptor string used to print floats.
2180 This is a %-spec like those accepted by `printf' in C,
2181 but with some restrictions. It must start with the two characters `%.'.
2182 After that comes an integer precision specification,
2183 and then a letter which controls the format.
2184 The letters allowed are `e', `f' and `g'.
2185 Use `e' for exponential notation \"DIG.DIGITSeEXPT\"
2186 Use `f' for decimal point notation \"DIGITS.DIGITS\".
2187 Use `g' to choose the shorter of those two formats for the number at hand.
2188 The precision in any of these cases is the number of digits following
2189 the decimal point. With `f', a precision of 0 means to omit the
2190 decimal point. 0 is not allowed with `e' or `g'.
2192 A value of nil means to use the shortest notation
2193 that represents the number without losing information. */);
2194 Vfloat_output_format = Qnil;
2195 Qfloat_output_format = intern_c_string ("float-output-format");
2196 staticpro (&Qfloat_output_format);
2198 DEFVAR_LISP ("print-length", Vprint_length,
2199 doc: /* Maximum length of list to print before abbreviating.
2200 A value of nil means no limit. See also `eval-expression-print-length'. */);
2201 Vprint_length = Qnil;
2203 DEFVAR_LISP ("print-level", Vprint_level,
2204 doc: /* Maximum depth of list nesting to print before abbreviating.
2205 A value of nil means no limit. See also `eval-expression-print-level'. */);
2206 Vprint_level = Qnil;
2208 DEFVAR_BOOL ("print-escape-newlines", print_escape_newlines,
2209 doc: /* Non-nil means print newlines in strings as `\\n'.
2210 Also print formfeeds as `\\f'. */);
2211 print_escape_newlines = 0;
2213 DEFVAR_BOOL ("print-escape-nonascii", print_escape_nonascii,
2214 doc: /* Non-nil means print unibyte non-ASCII chars in strings as \\OOO.
2215 \(OOO is the octal representation of the character code.)
2216 Only single-byte characters are affected, and only in `prin1'.
2217 When the output goes in a multibyte buffer, this feature is
2218 enabled regardless of the value of the variable. */);
2219 print_escape_nonascii = 0;
2221 DEFVAR_BOOL ("print-escape-multibyte", print_escape_multibyte,
2222 doc: /* Non-nil means print multibyte characters in strings as \\xXXXX.
2223 \(XXXX is the hex representation of the character code.)
2224 This affects only `prin1'. */);
2225 print_escape_multibyte = 0;
2227 DEFVAR_BOOL ("print-quoted", print_quoted,
2228 doc: /* Non-nil means print quoted forms with reader syntax.
2229 I.e., (quote foo) prints as 'foo, (function foo) as #'foo. */);
2230 print_quoted = 0;
2232 DEFVAR_LISP ("print-gensym", Vprint_gensym,
2233 doc: /* Non-nil means print uninterned symbols so they will read as uninterned.
2234 I.e., the value of (make-symbol \"foobar\") prints as #:foobar.
2235 When the uninterned symbol appears within a recursive data structure,
2236 and the symbol appears more than once, in addition use the #N# and #N=
2237 constructs as needed, so that multiple references to the same symbol are
2238 shared once again when the text is read back. */);
2239 Vprint_gensym = Qnil;
2241 DEFVAR_LISP ("print-circle", Vprint_circle,
2242 doc: /* *Non-nil means print recursive structures using #N= and #N# syntax.
2243 If nil, printing proceeds recursively and may lead to
2244 `max-lisp-eval-depth' being exceeded or an error may occur:
2245 \"Apparently circular structure being printed.\" Also see
2246 `print-length' and `print-level'.
2247 If non-nil, shared substructures anywhere in the structure are printed
2248 with `#N=' before the first occurrence (in the order of the print
2249 representation) and `#N#' in place of each subsequent occurrence,
2250 where N is a positive decimal integer. */);
2251 Vprint_circle = Qnil;
2253 DEFVAR_LISP ("print-continuous-numbering", Vprint_continuous_numbering,
2254 doc: /* *Non-nil means number continuously across print calls.
2255 This affects the numbers printed for #N= labels and #M# references.
2256 See also `print-circle', `print-gensym', and `print-number-table'.
2257 This variable should not be set with `setq'; bind it with a `let' instead. */);
2258 Vprint_continuous_numbering = Qnil;
2260 DEFVAR_LISP ("print-number-table", Vprint_number_table,
2261 doc: /* A vector used internally to produce `#N=' labels and `#N#' references.
2262 The Lisp printer uses this vector to detect Lisp objects referenced more
2263 than once.
2265 When you bind `print-continuous-numbering' to t, you should probably
2266 also bind `print-number-table' to nil. This ensures that the value of
2267 `print-number-table' can be garbage-collected once the printing is
2268 done. If all elements of `print-number-table' are nil, it means that
2269 the printing done so far has not found any shared structure or objects
2270 that need to be recorded in the table. */);
2271 Vprint_number_table = Qnil;
2273 DEFVAR_LISP ("print-charset-text-property", Vprint_charset_text_property,
2274 doc: /* A flag to control printing of `charset' text property on printing a string.
2275 The value must be nil, t, or `default'.
2277 If the value is nil, don't print the text property `charset'.
2279 If the value is t, always print the text property `charset'.
2281 If the value is `default', print the text property `charset' only when
2282 the value is different from what is guessed in the current charset
2283 priorities. */);
2284 Vprint_charset_text_property = Qdefault;
2286 /* prin1_to_string_buffer initialized in init_buffer_once in buffer.c */
2287 staticpro (&Vprin1_to_string_buffer);
2289 defsubr (&Sprin1);
2290 defsubr (&Sprin1_to_string);
2291 defsubr (&Serror_message_string);
2292 defsubr (&Sprinc);
2293 defsubr (&Sprint);
2294 defsubr (&Sterpri);
2295 defsubr (&Swrite_char);
2296 defsubr (&Sexternal_debugging_output);
2297 #ifdef WITH_REDIRECT_DEBUGGING_OUTPUT
2298 defsubr (&Sredirect_debugging_output);
2299 #endif
2301 Qexternal_debugging_output = intern_c_string ("external-debugging-output");
2302 staticpro (&Qexternal_debugging_output);
2304 Qprint_escape_newlines = intern_c_string ("print-escape-newlines");
2305 staticpro (&Qprint_escape_newlines);
2307 Qprint_escape_multibyte = intern_c_string ("print-escape-multibyte");
2308 staticpro (&Qprint_escape_multibyte);
2310 Qprint_escape_nonascii = intern_c_string ("print-escape-nonascii");
2311 staticpro (&Qprint_escape_nonascii);
2313 print_prune_charset_plist = Qnil;
2314 staticpro (&print_prune_charset_plist);
2316 defsubr (&Swith_output_to_temp_buffer);