1 /* Lisp object printing and output streams.
3 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2013 Free Software
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/>. */
26 #include "character.h"
33 #include "dispextern.h"
35 #include "intervals.h"
36 #include "blockinput.h"
37 #include "termhooks.h" /* For struct terminal. */
40 Lisp_Object Qstandard_output
;
42 static Lisp_Object Qtemp_buffer_setup_hook
;
44 /* These are used to print like we read. */
46 static Lisp_Object Qfloat_output_format
;
51 /* Avoid actual stack overflow in print. */
52 static ptrdiff_t print_depth
;
54 /* Level of nesting inside outputting backquote in new style. */
55 static ptrdiff_t new_backquote_output
;
57 /* Detect most circularities to print finite output. */
58 #define PRINT_CIRCLE 200
59 static Lisp_Object being_printed
[PRINT_CIRCLE
];
61 /* When printing into a buffer, first we put the text in this
62 block, then insert it all at once. */
63 static char *print_buffer
;
65 /* Size allocated in print_buffer. */
66 static ptrdiff_t print_buffer_size
;
67 /* Chars stored in print_buffer. */
68 static ptrdiff_t print_buffer_pos
;
69 /* Bytes stored in print_buffer. */
70 static ptrdiff_t print_buffer_pos_byte
;
72 Lisp_Object Qprint_escape_newlines
;
73 static Lisp_Object Qprint_escape_multibyte
, Qprint_escape_nonascii
;
75 /* Vprint_number_table is a table, that keeps objects that are going to
76 be printed, to allow use of #n= and #n# to express sharing.
77 For any given object, the table can give the following values:
78 t the object will be printed only once.
79 -N the object will be printed several times and will take number N.
80 N the object has been printed so we can refer to it as #N#.
81 print_number_index holds the largest N already used.
82 N has to be striclty larger than 0 since we need to distinguish -N. */
83 static ptrdiff_t print_number_index
;
84 static void print_interval (INTERVAL interval
, Lisp_Object printcharfun
);
86 /* GDB resets this to zero on W32 to disable OutputDebugString calls. */
87 bool print_output_debug_flag EXTERNALLY_VISIBLE
= 1;
90 /* Low level output routines for characters and strings. */
92 /* Lisp functions to do output using a stream
93 must have the stream in a variable called printcharfun
94 and must start with PRINTPREPARE, end with PRINTFINISH,
95 and use PRINTDECLARE to declare common variables.
96 Use PRINTCHAR to output one character,
97 or call strout to output a block of characters. */
99 #define PRINTDECLARE \
100 struct buffer *old = current_buffer; \
101 ptrdiff_t old_point = -1, start_point = -1; \
102 ptrdiff_t old_point_byte = -1, start_point_byte = -1; \
103 ptrdiff_t specpdl_count = SPECPDL_INDEX (); \
104 bool free_print_buffer = 0; \
106 = !NILP (BVAR (current_buffer, enable_multibyte_characters)); \
109 #define PRINTPREPARE \
110 original = printcharfun; \
111 if (NILP (printcharfun)) printcharfun = Qt; \
112 if (BUFFERP (printcharfun)) \
114 if (XBUFFER (printcharfun) != current_buffer) \
115 Fset_buffer (printcharfun); \
116 printcharfun = Qnil; \
118 if (MARKERP (printcharfun)) \
120 ptrdiff_t marker_pos; \
121 if (! XMARKER (printcharfun)->buffer) \
122 error ("Marker does not point anywhere"); \
123 if (XMARKER (printcharfun)->buffer != current_buffer) \
124 set_buffer_internal (XMARKER (printcharfun)->buffer); \
125 marker_pos = marker_position (printcharfun); \
126 if (marker_pos < BEGV || marker_pos > ZV) \
127 error ("Marker is outside the accessible part of the buffer"); \
129 old_point_byte = PT_BYTE; \
130 SET_PT_BOTH (marker_pos, \
131 marker_byte_position (printcharfun)); \
133 start_point_byte = PT_BYTE; \
134 printcharfun = Qnil; \
136 if (NILP (printcharfun)) \
138 Lisp_Object string; \
139 if (NILP (BVAR (current_buffer, enable_multibyte_characters)) \
140 && ! print_escape_multibyte) \
141 specbind (Qprint_escape_multibyte, Qt); \
142 if (! NILP (BVAR (current_buffer, enable_multibyte_characters)) \
143 && ! print_escape_nonascii) \
144 specbind (Qprint_escape_nonascii, Qt); \
145 if (print_buffer != 0) \
147 string = make_string_from_bytes (print_buffer, \
149 print_buffer_pos_byte); \
150 record_unwind_protect (print_unwind, string); \
154 int new_size = 1000; \
155 print_buffer = xmalloc (new_size); \
156 print_buffer_size = new_size; \
157 free_print_buffer = 1; \
159 print_buffer_pos = 0; \
160 print_buffer_pos_byte = 0; \
162 if (EQ (printcharfun, Qt) && ! noninteractive) \
163 setup_echo_area_for_printing (multibyte);
165 #define PRINTFINISH \
166 if (NILP (printcharfun)) \
168 if (print_buffer_pos != print_buffer_pos_byte \
169 && NILP (BVAR (current_buffer, enable_multibyte_characters))) \
171 unsigned char *temp = alloca (print_buffer_pos + 1); \
172 copy_text ((unsigned char *) print_buffer, temp, \
173 print_buffer_pos_byte, 1, 0); \
174 insert_1_both ((char *) temp, print_buffer_pos, \
175 print_buffer_pos, 0, 1, 0); \
178 insert_1_both (print_buffer, print_buffer_pos, \
179 print_buffer_pos_byte, 0, 1, 0); \
180 signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
182 if (free_print_buffer) \
184 xfree (print_buffer); \
187 unbind_to (specpdl_count, Qnil); \
188 if (MARKERP (original)) \
189 set_marker_both (original, Qnil, PT, PT_BYTE); \
190 if (old_point >= 0) \
191 SET_PT_BOTH (old_point + (old_point >= start_point \
192 ? PT - start_point : 0), \
193 old_point_byte + (old_point_byte >= start_point_byte \
194 ? PT_BYTE - start_point_byte : 0)); \
195 set_buffer_internal (old);
197 #define PRINTCHAR(ch) printchar (ch, printcharfun)
199 /* This is used to restore the saved contents of print_buffer
200 when there is a recursive call to print. */
203 print_unwind (Lisp_Object saved_text
)
205 memcpy (print_buffer
, SDATA (saved_text
), SCHARS (saved_text
));
209 /* Print character CH using method FUN. FUN nil means print to
210 print_buffer. FUN t means print to echo area or stdout if
211 non-interactive. If FUN is neither nil nor t, call FUN with CH as
215 printchar (unsigned int ch
, Lisp_Object fun
)
217 if (!NILP (fun
) && !EQ (fun
, Qt
))
218 call1 (fun
, make_number (ch
));
221 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
222 int len
= CHAR_STRING (ch
, str
);
228 ptrdiff_t incr
= len
- (print_buffer_size
- print_buffer_pos_byte
);
230 print_buffer
= xpalloc (print_buffer
, &print_buffer_size
,
232 memcpy (print_buffer
+ print_buffer_pos_byte
, str
, len
);
233 print_buffer_pos
+= 1;
234 print_buffer_pos_byte
+= len
;
236 else if (noninteractive
)
238 fwrite (str
, 1, len
, stdout
);
239 noninteractive_need_newline
= 1;
244 = !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
246 setup_echo_area_for_printing (multibyte_p
);
248 message_dolog ((char *) str
, len
, 0, multibyte_p
);
254 /* Output SIZE characters, SIZE_BYTE bytes from string PTR using
255 method PRINTCHARFUN. If SIZE < 0, use the string length of PTR for
256 both SIZE and SIZE_BYTE. PRINTCHARFUN nil means output to
257 print_buffer. PRINTCHARFUN t means output to the echo area or to
258 stdout if non-interactive. If neither nil nor t, call Lisp
259 function PRINTCHARFUN for each character printed. MULTIBYTE
260 non-zero means PTR contains multibyte characters.
262 In the case where PRINTCHARFUN is nil, it is safe for PTR to point
263 to data in a Lisp string. Otherwise that is not safe. */
266 strout (const char *ptr
, ptrdiff_t size
, ptrdiff_t size_byte
,
267 Lisp_Object printcharfun
)
270 size_byte
= size
= strlen (ptr
);
272 if (NILP (printcharfun
))
274 ptrdiff_t incr
= size_byte
- (print_buffer_size
- print_buffer_pos_byte
);
276 print_buffer
= xpalloc (print_buffer
, &print_buffer_size
, incr
, -1, 1);
277 memcpy (print_buffer
+ print_buffer_pos_byte
, ptr
, size_byte
);
278 print_buffer_pos
+= size
;
279 print_buffer_pos_byte
+= size_byte
;
281 else if (noninteractive
&& EQ (printcharfun
, Qt
))
283 fwrite (ptr
, 1, size_byte
, stdout
);
284 noninteractive_need_newline
= 1;
286 else if (EQ (printcharfun
, Qt
))
288 /* Output to echo area. We're trying to avoid a little overhead
289 here, that's the reason we don't call printchar to do the
293 = !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
295 setup_echo_area_for_printing (multibyte_p
);
296 message_dolog (ptr
, size_byte
, 0, multibyte_p
);
298 if (size
== size_byte
)
300 for (i
= 0; i
< size
; ++i
)
301 insert_char ((unsigned char) *ptr
++);
306 for (i
= 0; i
< size_byte
; i
+= len
)
308 int ch
= STRING_CHAR_AND_LENGTH ((const unsigned char *) ptr
+ i
,
316 /* PRINTCHARFUN is a Lisp function. */
319 if (size
== size_byte
)
321 while (i
< size_byte
)
329 while (i
< size_byte
)
331 /* Here, we must convert each multi-byte form to the
332 corresponding character code before handing it to
335 int ch
= STRING_CHAR_AND_LENGTH ((const unsigned char *) ptr
+ i
,
344 /* Print the contents of a string STRING using PRINTCHARFUN.
345 It isn't safe to use strout in many cases,
346 because printing one char can relocate. */
349 print_string (Lisp_Object string
, Lisp_Object printcharfun
)
351 if (EQ (printcharfun
, Qt
) || NILP (printcharfun
))
355 if (print_escape_nonascii
)
356 string
= string_escape_byte8 (string
);
358 if (STRING_MULTIBYTE (string
))
359 chars
= SCHARS (string
);
360 else if (! print_escape_nonascii
361 && (EQ (printcharfun
, Qt
)
362 ? ! NILP (BVAR (&buffer_defaults
, enable_multibyte_characters
))
363 : ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))))
365 /* If unibyte string STRING contains 8-bit codes, we must
366 convert STRING to a multibyte string containing the same
371 chars
= SBYTES (string
);
372 bytes
= count_size_as_multibyte (SDATA (string
), chars
);
375 newstr
= make_uninit_multibyte_string (chars
, bytes
);
376 memcpy (SDATA (newstr
), SDATA (string
), chars
);
377 str_to_multibyte (SDATA (newstr
), bytes
, chars
);
382 chars
= SBYTES (string
);
384 if (EQ (printcharfun
, Qt
))
386 /* Output to echo area. */
387 ptrdiff_t nbytes
= SBYTES (string
);
389 /* Copy the string contents so that relocation of STRING by
390 GC does not cause trouble. */
392 char *buffer
= SAFE_ALLOCA (nbytes
);
393 memcpy (buffer
, SDATA (string
), nbytes
);
395 strout (buffer
, chars
, nbytes
, printcharfun
);
400 /* No need to copy, since output to print_buffer can't GC. */
401 strout (SSDATA (string
), chars
, SBYTES (string
), printcharfun
);
405 /* Otherwise, string may be relocated by printing one char.
406 So re-fetch the string address for each character. */
408 ptrdiff_t size
= SCHARS (string
);
409 ptrdiff_t size_byte
= SBYTES (string
);
412 if (size
== size_byte
)
413 for (i
= 0; i
< size
; i
++)
414 PRINTCHAR (SREF (string
, i
));
416 for (i
= 0; i
< size_byte
; )
418 /* Here, we must convert each multi-byte form to the
419 corresponding character code before handing it to PRINTCHAR. */
421 int ch
= STRING_CHAR_AND_LENGTH (SDATA (string
) + i
, len
);
429 DEFUN ("write-char", Fwrite_char
, Swrite_char
, 1, 2, 0,
430 doc
: /* Output character CHARACTER to stream PRINTCHARFUN.
431 PRINTCHARFUN defaults to the value of `standard-output' (which see). */)
432 (Lisp_Object character
, Lisp_Object printcharfun
)
436 if (NILP (printcharfun
))
437 printcharfun
= Vstandard_output
;
438 CHECK_NUMBER (character
);
440 PRINTCHAR (XINT (character
));
445 /* Used from outside of print.c to print a block of SIZE
446 single-byte chars at DATA on the default output stream.
447 Do not use this on the contents of a Lisp string. */
450 write_string (const char *data
, int size
)
453 Lisp_Object printcharfun
;
455 printcharfun
= Vstandard_output
;
458 strout (data
, size
, size
, printcharfun
);
462 /* Used to print a block of SIZE single-byte chars at DATA on a
463 specified stream PRINTCHARFUN.
464 Do not use this on the contents of a Lisp string. */
467 write_string_1 (const char *data
, int size
, Lisp_Object printcharfun
)
472 strout (data
, size
, size
, printcharfun
);
478 temp_output_buffer_setup (const char *bufname
)
480 ptrdiff_t count
= SPECPDL_INDEX ();
481 register struct buffer
*old
= current_buffer
;
482 register Lisp_Object buf
;
484 record_unwind_current_buffer ();
486 Fset_buffer (Fget_buffer_create (build_string (bufname
)));
488 Fkill_all_local_variables ();
489 delete_all_overlays (current_buffer
);
490 bset_directory (current_buffer
, BVAR (old
, directory
));
491 bset_read_only (current_buffer
, Qnil
);
492 bset_filename (current_buffer
, Qnil
);
493 bset_undo_list (current_buffer
, Qt
);
494 eassert (current_buffer
->overlays_before
== NULL
);
495 eassert (current_buffer
->overlays_after
== NULL
);
496 bset_enable_multibyte_characters
497 (current_buffer
, BVAR (&buffer_defaults
, enable_multibyte_characters
));
498 specbind (Qinhibit_read_only
, Qt
);
499 specbind (Qinhibit_modification_hooks
, Qt
);
501 XSETBUFFER (buf
, current_buffer
);
503 Frun_hooks (1, &Qtemp_buffer_setup_hook
);
505 unbind_to (count
, Qnil
);
507 specbind (Qstandard_output
, buf
);
510 static void print (Lisp_Object
, Lisp_Object
, bool);
511 static void print_preprocess (Lisp_Object
);
512 static void print_preprocess_string (INTERVAL
, Lisp_Object
);
513 static void print_object (Lisp_Object
, Lisp_Object
, bool);
515 DEFUN ("terpri", Fterpri
, Sterpri
, 0, 1, 0,
516 doc
: /* Output a newline to stream PRINTCHARFUN.
517 If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used. */)
518 (Lisp_Object printcharfun
)
522 if (NILP (printcharfun
))
523 printcharfun
= Vstandard_output
;
530 DEFUN ("prin1", Fprin1
, Sprin1
, 1, 2, 0,
531 doc
: /* Output the printed representation of OBJECT, any Lisp object.
532 Quoting characters are printed when needed to make output that `read'
533 can handle, whenever this is possible. For complex objects, the behavior
534 is controlled by `print-level' and `print-length', which see.
536 OBJECT is any of the Lisp data types: a number, a string, a symbol,
537 a list, a buffer, a window, a frame, etc.
539 A printed representation of an object is text which describes that object.
541 Optional argument PRINTCHARFUN is the output stream, which can be one
544 - a buffer, in which case output is inserted into that buffer at point;
545 - a marker, in which case output is inserted at marker's position;
546 - a function, in which case that function is called once for each
547 character of OBJECT's printed representation;
548 - a symbol, in which case that symbol's function definition is called; or
549 - t, in which case the output is displayed in the echo area.
551 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
553 (Lisp_Object object
, Lisp_Object printcharfun
)
557 if (NILP (printcharfun
))
558 printcharfun
= Vstandard_output
;
560 print (object
, printcharfun
, 1);
565 /* a buffer which is used to hold output being built by prin1-to-string */
566 Lisp_Object Vprin1_to_string_buffer
;
568 DEFUN ("prin1-to-string", Fprin1_to_string
, Sprin1_to_string
, 1, 2, 0,
569 doc
: /* Return a string containing the printed representation of OBJECT.
570 OBJECT can be any Lisp object. This function outputs quoting characters
571 when necessary to make output that `read' can handle, whenever possible,
572 unless the optional second argument NOESCAPE is non-nil. For complex objects,
573 the behavior is controlled by `print-level' and `print-length', which see.
575 OBJECT is any of the Lisp data types: a number, a string, a symbol,
576 a list, a buffer, a window, a frame, etc.
578 A printed representation of an object is text which describes that object. */)
579 (Lisp_Object object
, Lisp_Object noescape
)
581 Lisp_Object printcharfun
;
582 bool prev_abort_on_gc
;
583 /* struct gcpro gcpro1, gcpro2; */
584 Lisp_Object save_deactivate_mark
;
585 ptrdiff_t count
= SPECPDL_INDEX ();
586 struct buffer
*previous
;
588 specbind (Qinhibit_modification_hooks
, Qt
);
593 /* Save and restore this--we are altering a buffer
594 but we don't want to deactivate the mark just for that.
595 No need for specbind, since errors deactivate the mark. */
596 save_deactivate_mark
= Vdeactivate_mark
;
597 /* GCPRO2 (object, save_deactivate_mark); */
598 prev_abort_on_gc
= abort_on_gc
;
601 printcharfun
= Vprin1_to_string_buffer
;
603 print (object
, printcharfun
, NILP (noescape
));
604 /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINISH */
608 previous
= current_buffer
;
609 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer
));
610 object
= Fbuffer_string ();
611 if (SBYTES (object
) == SCHARS (object
))
612 STRING_SET_UNIBYTE (object
);
614 /* Note that this won't make prepare_to_modify_buffer call
615 ask-user-about-supersession-threat because this buffer
616 does not visit a file. */
618 set_buffer_internal (previous
);
620 Vdeactivate_mark
= save_deactivate_mark
;
623 abort_on_gc
= prev_abort_on_gc
;
624 return unbind_to (count
, object
);
627 DEFUN ("princ", Fprinc
, Sprinc
, 1, 2, 0,
628 doc
: /* Output the printed representation of OBJECT, any Lisp object.
629 No quoting characters are used; no delimiters are printed around
630 the contents of strings.
632 OBJECT is any of the Lisp data types: a number, a string, a symbol,
633 a list, a buffer, a window, a frame, etc.
635 A printed representation of an object is text which describes that object.
637 Optional argument PRINTCHARFUN is the output stream, which can be one
640 - a buffer, in which case output is inserted into that buffer at point;
641 - a marker, in which case output is inserted at marker's position;
642 - a function, in which case that function is called once for each
643 character of OBJECT's printed representation;
644 - a symbol, in which case that symbol's function definition is called; or
645 - t, in which case the output is displayed in the echo area.
647 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
649 (Lisp_Object object
, Lisp_Object printcharfun
)
653 if (NILP (printcharfun
))
654 printcharfun
= Vstandard_output
;
656 print (object
, printcharfun
, 0);
661 DEFUN ("print", Fprint
, Sprint
, 1, 2, 0,
662 doc
: /* Output the printed representation of OBJECT, with newlines around it.
663 Quoting characters are printed when needed to make output that `read'
664 can handle, whenever this is possible. For complex objects, the behavior
665 is controlled by `print-level' and `print-length', which see.
667 OBJECT is any of the Lisp data types: a number, a string, a symbol,
668 a list, a buffer, a window, a frame, etc.
670 A printed representation of an object is text which describes that object.
672 Optional argument PRINTCHARFUN is the output stream, which can be one
675 - a buffer, in which case output is inserted into that buffer at point;
676 - a marker, in which case output is inserted at marker's position;
677 - a function, in which case that function is called once for each
678 character of OBJECT's printed representation;
679 - a symbol, in which case that symbol's function definition is called; or
680 - t, in which case the output is displayed in the echo area.
682 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
684 (Lisp_Object object
, Lisp_Object printcharfun
)
689 if (NILP (printcharfun
))
690 printcharfun
= Vstandard_output
;
694 print (object
, printcharfun
, 1);
701 /* The subroutine object for external-debugging-output is kept here
702 for the convenience of the debugger. */
703 Lisp_Object Qexternal_debugging_output
;
705 DEFUN ("external-debugging-output", Fexternal_debugging_output
, Sexternal_debugging_output
, 1, 1, 0,
706 doc
: /* Write CHARACTER to stderr.
707 You can call print while debugging emacs, and pass it this function
708 to make it write to the debugging output. */)
709 (Lisp_Object character
)
711 CHECK_NUMBER (character
);
712 putc (XINT (character
) & 0xFF, stderr
);
715 /* Send the output to a debugger (nothing happens if there isn't one). */
716 if (print_output_debug_flag
)
718 char buf
[2] = {(char) XINT (character
), '\0'};
719 OutputDebugString (buf
);
726 /* This function is never called. Its purpose is to prevent
727 print_output_debug_flag from being optimized away. */
729 extern void debug_output_compilation_hack (bool) EXTERNALLY_VISIBLE
;
731 debug_output_compilation_hack (bool x
)
733 print_output_debug_flag
= x
;
736 #if defined (GNU_LINUX)
738 /* This functionality is not vitally important in general, so we rely on
739 non-portable ability to use stderr as lvalue. */
741 #define WITH_REDIRECT_DEBUGGING_OUTPUT 1
743 static FILE *initial_stderr_stream
= NULL
;
745 DEFUN ("redirect-debugging-output", Fredirect_debugging_output
, Sredirect_debugging_output
,
747 "FDebug output file: \nP",
748 doc
: /* Redirect debugging output (stderr stream) to file FILE.
749 If FILE is nil, reset target to the initial stderr stream.
750 Optional arg APPEND non-nil (interactively, with prefix arg) means
751 append to existing target file. */)
752 (Lisp_Object file
, Lisp_Object append
)
754 if (initial_stderr_stream
!= NULL
)
760 stderr
= initial_stderr_stream
;
761 initial_stderr_stream
= NULL
;
765 file
= Fexpand_file_name (file
, Qnil
);
766 initial_stderr_stream
= stderr
;
767 stderr
= emacs_fopen (SSDATA (file
), NILP (append
) ? "w" : "a");
770 stderr
= initial_stderr_stream
;
771 initial_stderr_stream
= NULL
;
772 report_file_error ("Cannot open debugging output stream", file
);
777 #endif /* GNU_LINUX */
780 /* This is the interface for debugging printing. */
783 debug_print (Lisp_Object arg
)
785 Fprin1 (arg
, Qexternal_debugging_output
);
786 fprintf (stderr
, "\r\n");
789 void safe_debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
791 safe_debug_print (Lisp_Object arg
)
793 int valid
= valid_lisp_object_p (arg
);
798 fprintf (stderr
, "#<%s_LISP_OBJECT 0x%08"pI
"x>\r\n",
799 !valid
? "INVALID" : "SOME",
804 DEFUN ("error-message-string", Ferror_message_string
, Serror_message_string
,
806 doc
: /* Convert an error value (ERROR-SYMBOL . DATA) to an error message.
807 See Info anchor `(elisp)Definition of signal' for some details on how this
808 error message is constructed. */)
811 struct buffer
*old
= current_buffer
;
815 /* If OBJ is (error STRING), just return STRING.
816 That is not only faster, it also avoids the need to allocate
817 space here when the error is due to memory full. */
818 if (CONSP (obj
) && EQ (XCAR (obj
), Qerror
)
819 && CONSP (XCDR (obj
))
820 && STRINGP (XCAR (XCDR (obj
)))
821 && NILP (XCDR (XCDR (obj
))))
822 return XCAR (XCDR (obj
));
824 print_error_message (obj
, Vprin1_to_string_buffer
, 0, Qnil
);
826 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer
));
827 value
= Fbuffer_string ();
831 set_buffer_internal (old
);
837 /* Print an error message for the error DATA onto Lisp output stream
838 STREAM (suitable for the print functions).
839 CONTEXT is a C string describing the context of the error.
840 CALLER is the Lisp function inside which the error was signaled. */
843 print_error_message (Lisp_Object data
, Lisp_Object stream
, const char *context
,
846 Lisp_Object errname
, errmsg
, file_error
, tail
;
850 write_string_1 (context
, -1, stream
);
852 /* If we know from where the error was signaled, show it in
854 if (!NILP (caller
) && SYMBOLP (caller
))
856 Lisp_Object cname
= SYMBOL_NAME (caller
);
857 ptrdiff_t cnamelen
= SBYTES (cname
);
859 char *name
= SAFE_ALLOCA (cnamelen
);
860 memcpy (name
, SDATA (cname
), cnamelen
);
861 message_dolog (name
, cnamelen
, 0, 0);
862 message_dolog (": ", 2, 0, 0);
866 errname
= Fcar (data
);
868 if (EQ (errname
, Qerror
))
873 errmsg
= Fcar (data
);
878 Lisp_Object error_conditions
= Fget (errname
, Qerror_conditions
);
879 errmsg
= Fget (errname
, Qerror_message
);
880 file_error
= Fmemq (Qfile_error
, error_conditions
);
883 /* Print an error message including the data items. */
885 tail
= Fcdr_safe (data
);
888 /* For file-error, make error message by concatenating
889 all the data items. They are all strings. */
890 if (!NILP (file_error
) && CONSP (tail
))
891 errmsg
= XCAR (tail
), tail
= XCDR (tail
);
894 const char *sep
= ": ";
896 if (!STRINGP (errmsg
))
897 write_string_1 ("peculiar error", -1, stream
);
898 else if (SCHARS (errmsg
))
899 Fprinc (errmsg
, stream
);
903 for (; CONSP (tail
); tail
= XCDR (tail
), sep
= ", ")
908 write_string_1 (sep
, 2, stream
);
910 if (!NILP (file_error
)
911 || EQ (errname
, Qend_of_file
) || EQ (errname
, Quser_error
))
912 Fprinc (obj
, stream
);
914 Fprin1 (obj
, stream
);
924 * The buffer should be at least as large as the max string size of the
925 * largest float, printed in the biggest notation. This is undoubtedly
926 * 20d float_output_format, with the negative of the C-constant "HUGE"
929 * On the vax the worst case is -1e38 in 20d format which takes 61 bytes.
931 * I assume that IEEE-754 format numbers can take 329 bytes for the worst
932 * case of -1e307 in 20d float_output_format. What is one to do (short of
933 * re-writing _doprnt to be more sane)?
935 * Given the above, the buffer must be least FLOAT_TO_STRING_BUFSIZE bytes.
939 float_to_string (char *buf
, double data
)
945 /* Check for plus infinity in a way that won't lose
946 if there is no plus infinity. */
947 if (data
== data
/ 2 && data
> 1.0)
949 static char const infinity_string
[] = "1.0e+INF";
950 strcpy (buf
, infinity_string
);
951 return sizeof infinity_string
- 1;
953 /* Likewise for minus infinity. */
954 if (data
== data
/ 2 && data
< -1.0)
956 static char const minus_infinity_string
[] = "-1.0e+INF";
957 strcpy (buf
, minus_infinity_string
);
958 return sizeof minus_infinity_string
- 1;
960 /* Check for NaN in a way that won't fail if there are no NaNs. */
961 if (! (data
* 0.0 >= 0.0))
963 /* Prepend "-" if the NaN's sign bit is negative.
964 The sign bit of a double is the bit that is 1 in -0.0. */
965 static char const NaN_string
[] = "0.0e+NaN";
967 union { double d
; char c
[sizeof (double)]; } u_data
, u_minus_zero
;
970 u_minus_zero
.d
= - 0.0;
971 for (i
= 0; i
< sizeof (double); i
++)
972 if (u_data
.c
[i
] & u_minus_zero
.c
[i
])
979 strcpy (buf
+ negative
, NaN_string
);
980 return negative
+ sizeof NaN_string
- 1;
983 if (NILP (Vfloat_output_format
)
984 || !STRINGP (Vfloat_output_format
))
987 /* Generate the fewest number of digits that represent the
988 floating point value without losing information. */
989 len
= dtoastr (buf
, FLOAT_TO_STRING_BUFSIZE
- 2, 0, 0, data
);
990 /* The decimal point must be printed, or the byte compiler can
991 get confused (Bug#8033). */
996 /* Check that the spec we have is fully valid.
997 This means not only valid for printf,
998 but meant for floats, and reasonable. */
999 cp
= SSDATA (Vfloat_output_format
);
1008 /* Check the width specification. */
1010 if ('0' <= *cp
&& *cp
<= '9')
1015 width
= (width
* 10) + (*cp
++ - '0');
1016 if (DBL_DIG
< width
)
1019 while (*cp
>= '0' && *cp
<= '9');
1021 /* A precision of zero is valid only for %f. */
1022 if (width
== 0 && *cp
!= 'f')
1026 if (*cp
!= 'e' && *cp
!= 'f' && *cp
!= 'g')
1032 len
= sprintf (buf
, SSDATA (Vfloat_output_format
), data
);
1035 /* Make sure there is a decimal point with digit after, or an
1036 exponent, so that the value is readable as a float. But don't do
1037 this with "%.0f"; it's valid for that not to produce a decimal
1038 point. Note that width can be 0 only for %.0f. */
1041 for (cp
= buf
; *cp
; cp
++)
1042 if ((*cp
< '0' || *cp
> '9') && *cp
!= '-')
1045 if (*cp
== '.' && cp
[1] == 0)
1065 print (Lisp_Object obj
, Lisp_Object printcharfun
, bool escapeflag
)
1067 new_backquote_output
= 0;
1069 /* Reset print_number_index and Vprint_number_table only when
1070 the variable Vprint_continuous_numbering is nil. Otherwise,
1071 the values of these variables will be kept between several
1073 if (NILP (Vprint_continuous_numbering
)
1074 || NILP (Vprint_number_table
))
1076 print_number_index
= 0;
1077 Vprint_number_table
= Qnil
;
1080 /* Construct Vprint_number_table for print-gensym and print-circle. */
1081 if (!NILP (Vprint_gensym
) || !NILP (Vprint_circle
))
1083 /* Construct Vprint_number_table.
1084 This increments print_number_index for the objects added. */
1086 print_preprocess (obj
);
1088 if (HASH_TABLE_P (Vprint_number_table
))
1089 { /* Remove unnecessary objects, which appear only once in OBJ;
1090 that is, whose status is Qt. */
1091 struct Lisp_Hash_Table
*h
= XHASH_TABLE (Vprint_number_table
);
1094 for (i
= 0; i
< HASH_TABLE_SIZE (h
); ++i
)
1095 if (!NILP (HASH_HASH (h
, i
))
1096 && EQ (HASH_VALUE (h
, i
), Qt
))
1097 Fremhash (HASH_KEY (h
, i
), Vprint_number_table
);
1102 print_object (obj
, printcharfun
, escapeflag
);
1105 #define PRINT_CIRCLE_CANDIDATE_P(obj) \
1106 (STRINGP (obj) || CONSP (obj) \
1107 || (VECTORLIKEP (obj) \
1108 && (VECTORP (obj) || COMPILEDP (obj) \
1109 || CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj) \
1110 || HASH_TABLE_P (obj) || FONTP (obj))) \
1111 || (! NILP (Vprint_gensym) \
1113 && !SYMBOL_INTERNED_P (obj)))
1115 /* Construct Vprint_number_table according to the structure of OBJ.
1116 OBJ itself and all its elements will be added to Vprint_number_table
1117 recursively if it is a list, vector, compiled function, char-table,
1118 string (its text properties will be traced), or a symbol that has
1119 no obarray (this is for the print-gensym feature).
1120 The status fields of Vprint_number_table mean whether each object appears
1121 more than once in OBJ: Qnil at the first time, and Qt after that . */
1123 print_preprocess (Lisp_Object obj
)
1128 Lisp_Object halftail
;
1130 /* Avoid infinite recursion for circular nested structure
1131 in the case where Vprint_circle is nil. */
1132 if (NILP (Vprint_circle
))
1134 /* Give up if we go so deep that print_object will get an error. */
1135 /* See similar code in print_object. */
1136 if (print_depth
>= PRINT_CIRCLE
)
1137 error ("Apparently circular structure being printed");
1139 for (i
= 0; i
< print_depth
; i
++)
1140 if (EQ (obj
, being_printed
[i
]))
1142 being_printed
[print_depth
] = obj
;
1149 if (PRINT_CIRCLE_CANDIDATE_P (obj
))
1151 if (!HASH_TABLE_P (Vprint_number_table
))
1153 Lisp_Object args
[2];
1156 Vprint_number_table
= Fmake_hash_table (2, args
);
1159 /* In case print-circle is nil and print-gensym is t,
1160 add OBJ to Vprint_number_table only when OBJ is a symbol. */
1161 if (! NILP (Vprint_circle
) || SYMBOLP (obj
))
1163 Lisp_Object num
= Fgethash (obj
, Vprint_number_table
, Qnil
);
1165 /* If Vprint_continuous_numbering is non-nil and OBJ is a gensym,
1166 always print the gensym with a number. This is a special for
1167 the lisp function byte-compile-output-docform. */
1168 || (!NILP (Vprint_continuous_numbering
)
1170 && !SYMBOL_INTERNED_P (obj
)))
1171 { /* OBJ appears more than once. Let's remember that. */
1172 if (!INTEGERP (num
))
1174 print_number_index
++;
1175 /* Negative number indicates it hasn't been printed yet. */
1176 Fputhash (obj
, make_number (- print_number_index
),
1177 Vprint_number_table
);
1183 /* OBJ is not yet recorded. Let's add to the table. */
1184 Fputhash (obj
, Qt
, Vprint_number_table
);
1187 switch (XTYPE (obj
))
1190 /* A string may have text properties, which can be circular. */
1191 traverse_intervals_noorder (string_intervals (obj
),
1192 print_preprocess_string
, Qnil
);
1196 /* Use HALFTAIL and LOOP_COUNT to detect circular lists,
1197 just as in print_object. */
1198 if (loop_count
&& EQ (obj
, halftail
))
1200 print_preprocess (XCAR (obj
));
1203 if (!(loop_count
& 1))
1204 halftail
= XCDR (halftail
);
1207 case Lisp_Vectorlike
:
1209 if (size
& PSEUDOVECTOR_FLAG
)
1210 size
&= PSEUDOVECTOR_SIZE_MASK
;
1211 for (i
= 0; i
< size
; i
++)
1212 print_preprocess (AREF (obj
, i
));
1213 if (HASH_TABLE_P (obj
))
1214 { /* For hash tables, the key_and_value slot is past
1215 `size' because it needs to be marked specially in case
1216 the table is weak. */
1217 struct Lisp_Hash_Table
*h
= XHASH_TABLE (obj
);
1218 print_preprocess (h
->key_and_value
);
1230 print_preprocess_string (INTERVAL interval
, Lisp_Object arg
)
1232 print_preprocess (interval
->plist
);
1235 static void print_check_string_charset_prop (INTERVAL interval
, Lisp_Object string
);
1237 #define PRINT_STRING_NON_CHARSET_FOUND 1
1238 #define PRINT_STRING_UNSAFE_CHARSET_FOUND 2
1240 /* Bitwise or of the above macros. */
1241 static int print_check_string_result
;
1244 print_check_string_charset_prop (INTERVAL interval
, Lisp_Object string
)
1248 if (NILP (interval
->plist
)
1249 || (print_check_string_result
== (PRINT_STRING_NON_CHARSET_FOUND
1250 | PRINT_STRING_UNSAFE_CHARSET_FOUND
)))
1252 for (val
= interval
->plist
; CONSP (val
) && ! EQ (XCAR (val
), Qcharset
);
1253 val
= XCDR (XCDR (val
)));
1256 print_check_string_result
|= PRINT_STRING_NON_CHARSET_FOUND
;
1259 if (! (print_check_string_result
& PRINT_STRING_NON_CHARSET_FOUND
))
1261 if (! EQ (val
, interval
->plist
)
1262 || CONSP (XCDR (XCDR (val
))))
1263 print_check_string_result
|= PRINT_STRING_NON_CHARSET_FOUND
;
1265 if (NILP (Vprint_charset_text_property
)
1266 || ! (print_check_string_result
& PRINT_STRING_UNSAFE_CHARSET_FOUND
))
1269 ptrdiff_t charpos
= interval
->position
;
1270 ptrdiff_t bytepos
= string_char_to_byte (string
, charpos
);
1271 Lisp_Object charset
;
1273 charset
= XCAR (XCDR (val
));
1274 for (i
= 0; i
< LENGTH (interval
); i
++)
1276 FETCH_STRING_CHAR_ADVANCE (c
, string
, charpos
, bytepos
);
1277 if (! ASCII_CHAR_P (c
)
1278 && ! EQ (CHARSET_NAME (CHAR_CHARSET (c
)), charset
))
1280 print_check_string_result
|= PRINT_STRING_UNSAFE_CHARSET_FOUND
;
1287 /* The value is (charset . nil). */
1288 static Lisp_Object print_prune_charset_plist
;
1291 print_prune_string_charset (Lisp_Object string
)
1293 print_check_string_result
= 0;
1294 traverse_intervals (string_intervals (string
), 0,
1295 print_check_string_charset_prop
, string
);
1296 if (! (print_check_string_result
& PRINT_STRING_UNSAFE_CHARSET_FOUND
))
1298 string
= Fcopy_sequence (string
);
1299 if (print_check_string_result
& PRINT_STRING_NON_CHARSET_FOUND
)
1301 if (NILP (print_prune_charset_plist
))
1302 print_prune_charset_plist
= list1 (Qcharset
);
1303 Fremove_text_properties (make_number (0),
1304 make_number (SCHARS (string
)),
1305 print_prune_charset_plist
, string
);
1308 Fset_text_properties (make_number (0), make_number (SCHARS (string
)),
1315 print_object (Lisp_Object obj
, Lisp_Object printcharfun
, bool escapeflag
)
1317 char buf
[max (sizeof "from..to..in " + 2 * INT_STRLEN_BOUND (EMACS_INT
),
1318 max (sizeof " . #" + INT_STRLEN_BOUND (printmax_t
),
1323 /* Detect circularities and truncate them. */
1324 if (NILP (Vprint_circle
))
1326 /* Simple but incomplete way. */
1329 /* See similar code in print_preprocess. */
1330 if (print_depth
>= PRINT_CIRCLE
)
1331 error ("Apparently circular structure being printed");
1333 for (i
= 0; i
< print_depth
; i
++)
1334 if (EQ (obj
, being_printed
[i
]))
1336 int len
= sprintf (buf
, "#%d", i
);
1337 strout (buf
, len
, len
, printcharfun
);
1340 being_printed
[print_depth
] = obj
;
1342 else if (PRINT_CIRCLE_CANDIDATE_P (obj
))
1344 /* With the print-circle feature. */
1345 Lisp_Object num
= Fgethash (obj
, Vprint_number_table
, Qnil
);
1348 EMACS_INT n
= XINT (num
);
1350 { /* Add a prefix #n= if OBJ has not yet been printed;
1351 that is, its status field is nil. */
1352 int len
= sprintf (buf
, "#%"pI
"d=", -n
);
1353 strout (buf
, len
, len
, printcharfun
);
1354 /* OBJ is going to be printed. Remember that fact. */
1355 Fputhash (obj
, make_number (- n
), Vprint_number_table
);
1359 /* Just print #n# if OBJ has already been printed. */
1360 int len
= sprintf (buf
, "#%"pI
"d#", n
);
1361 strout (buf
, len
, len
, printcharfun
);
1369 switch (XTYPE (obj
))
1373 int len
= sprintf (buf
, "%"pI
"d", XINT (obj
));
1374 strout (buf
, len
, len
, printcharfun
);
1380 char pigbuf
[FLOAT_TO_STRING_BUFSIZE
];
1381 int len
= float_to_string (pigbuf
, XFLOAT_DATA (obj
));
1382 strout (pigbuf
, len
, len
, printcharfun
);
1388 print_string (obj
, printcharfun
);
1391 register ptrdiff_t i_byte
;
1392 struct gcpro gcpro1
;
1394 ptrdiff_t size_byte
;
1395 /* 1 means we must ensure that the next character we output
1396 cannot be taken as part of a hex character escape. */
1397 bool need_nonhex
= 0;
1398 bool multibyte
= STRING_MULTIBYTE (obj
);
1402 if (! EQ (Vprint_charset_text_property
, Qt
))
1403 obj
= print_prune_string_charset (obj
);
1405 if (string_intervals (obj
))
1413 size_byte
= SBYTES (obj
);
1415 for (i_byte
= 0; i_byte
< size_byte
;)
1417 /* Here, we must convert each multi-byte form to the
1418 corresponding character code before handing it to PRINTCHAR. */
1424 c
= STRING_CHAR_AND_LENGTH (str
+ i_byte
, len
);
1432 if (c
== '\n' && print_escape_newlines
)
1437 else if (c
== '\f' && print_escape_newlines
)
1443 && (CHAR_BYTE8_P (c
)
1444 || (! ASCII_CHAR_P (c
) && print_escape_multibyte
)))
1446 /* When multibyte is disabled,
1447 print multibyte string chars using hex escapes.
1448 For a char code that could be in a unibyte string,
1449 when found in a multibyte string, always use a hex escape
1450 so it reads back as multibyte. */
1454 if (CHAR_BYTE8_P (c
))
1455 len
= sprintf (outbuf
, "\\%03o", CHAR_TO_BYTE8 (c
));
1458 len
= sprintf (outbuf
, "\\x%04x", c
);
1461 strout (outbuf
, len
, len
, printcharfun
);
1463 else if (! multibyte
1464 && SINGLE_BYTE_CHAR_P (c
) && ! ASCII_BYTE_P (c
)
1465 && print_escape_nonascii
)
1467 /* When printing in a multibyte buffer
1468 or when explicitly requested,
1469 print single-byte non-ASCII string chars
1470 using octal escapes. */
1472 int len
= sprintf (outbuf
, "\\%03o", c
);
1473 strout (outbuf
, len
, len
, printcharfun
);
1477 /* If we just had a hex escape, and this character
1478 could be taken as part of it,
1479 output `\ ' to prevent that. */
1483 if ((c
>= 'a' && c
<= 'f')
1484 || (c
>= 'A' && c
<= 'F')
1485 || (c
>= '0' && c
<= '9'))
1486 strout ("\\ ", -1, -1, printcharfun
);
1489 if (c
== '\"' || c
== '\\')
1496 if (string_intervals (obj
))
1498 traverse_intervals (string_intervals (obj
),
1499 0, print_interval
, printcharfun
);
1510 unsigned char *p
= SDATA (SYMBOL_NAME (obj
));
1511 unsigned char *end
= p
+ SBYTES (SYMBOL_NAME (obj
));
1513 ptrdiff_t i
, i_byte
;
1514 ptrdiff_t size_byte
;
1517 name
= SYMBOL_NAME (obj
);
1519 if (p
!= end
&& (*p
== '-' || *p
== '+')) p
++;
1522 /* If symbol name begins with a digit, and ends with a digit,
1523 and contains nothing but digits and `e', it could be treated
1524 as a number. So set CONFUSING.
1526 Symbols that contain periods could also be taken as numbers,
1527 but periods are always escaped, so we don't have to worry
1529 else if (*p
>= '0' && *p
<= '9'
1530 && end
[-1] >= '0' && end
[-1] <= '9')
1532 while (p
!= end
&& ((*p
>= '0' && *p
<= '9')
1533 /* Needed for \2e10. */
1534 || *p
== 'e' || *p
== 'E'))
1536 confusing
= (end
== p
);
1541 size_byte
= SBYTES (name
);
1543 if (! NILP (Vprint_gensym
) && !SYMBOL_INTERNED_P (obj
))
1548 else if (size_byte
== 0)
1555 for (i
= 0, i_byte
= 0; i_byte
< size_byte
;)
1557 /* Here, we must convert each multi-byte form to the
1558 corresponding character code before handing it to PRINTCHAR. */
1559 FETCH_STRING_CHAR_ADVANCE (c
, name
, i
, i_byte
);
1564 if (c
== '\"' || c
== '\\' || c
== '\''
1565 || c
== ';' || c
== '#' || c
== '(' || c
== ')'
1566 || c
== ',' || c
== '.' || c
== '`'
1567 || c
== '[' || c
== ']' || c
== '?' || c
<= 040
1569 PRINTCHAR ('\\'), confusing
= 0;
1577 /* If deeper than spec'd depth, print placeholder. */
1578 if (INTEGERP (Vprint_level
)
1579 && print_depth
> XINT (Vprint_level
))
1580 strout ("...", -1, -1, printcharfun
);
1581 else if (print_quoted
&& CONSP (XCDR (obj
)) && NILP (XCDR (XCDR (obj
)))
1582 && (EQ (XCAR (obj
), Qquote
)))
1585 print_object (XCAR (XCDR (obj
)), printcharfun
, escapeflag
);
1587 else if (print_quoted
&& CONSP (XCDR (obj
)) && NILP (XCDR (XCDR (obj
)))
1588 && (EQ (XCAR (obj
), Qfunction
)))
1592 print_object (XCAR (XCDR (obj
)), printcharfun
, escapeflag
);
1594 else if (print_quoted
&& CONSP (XCDR (obj
)) && NILP (XCDR (XCDR (obj
)))
1595 && ((EQ (XCAR (obj
), Qbackquote
))))
1597 print_object (XCAR (obj
), printcharfun
, 0);
1598 new_backquote_output
++;
1599 print_object (XCAR (XCDR (obj
)), printcharfun
, escapeflag
);
1600 new_backquote_output
--;
1602 else if (print_quoted
&& CONSP (XCDR (obj
)) && NILP (XCDR (XCDR (obj
)))
1603 && new_backquote_output
1604 && ((EQ (XCAR (obj
), Qbackquote
)
1605 || EQ (XCAR (obj
), Qcomma
)
1606 || EQ (XCAR (obj
), Qcomma_at
)
1607 || EQ (XCAR (obj
), Qcomma_dot
))))
1609 print_object (XCAR (obj
), printcharfun
, 0);
1610 new_backquote_output
--;
1611 print_object (XCAR (XCDR (obj
)), printcharfun
, escapeflag
);
1612 new_backquote_output
++;
1619 printmax_t i
, print_length
;
1620 Lisp_Object halftail
= obj
;
1622 /* Negative values of print-length are invalid in CL.
1623 Treat them like nil, as CMUCL does. */
1624 if (NATNUMP (Vprint_length
))
1625 print_length
= XFASTINT (Vprint_length
);
1627 print_length
= TYPE_MAXIMUM (printmax_t
);
1632 /* Detect circular list. */
1633 if (NILP (Vprint_circle
))
1635 /* Simple but incomplete way. */
1636 if (i
!= 0 && EQ (obj
, halftail
))
1638 int len
= sprintf (buf
, " . #%"pMd
, i
/ 2);
1639 strout (buf
, len
, len
, printcharfun
);
1645 /* With the print-circle feature. */
1648 Lisp_Object num
= Fgethash (obj
, Vprint_number_table
, Qnil
);
1651 strout (" . ", 3, 3, printcharfun
);
1652 print_object (obj
, printcharfun
, escapeflag
);
1661 if (print_length
<= i
)
1663 strout ("...", 3, 3, printcharfun
);
1668 print_object (XCAR (obj
), printcharfun
, escapeflag
);
1672 halftail
= XCDR (halftail
);
1676 /* OBJ non-nil here means it's the end of a dotted list. */
1679 strout (" . ", 3, 3, printcharfun
);
1680 print_object (obj
, printcharfun
, escapeflag
);
1688 case Lisp_Vectorlike
:
1693 strout ("#<process ", -1, -1, printcharfun
);
1694 print_string (XPROCESS (obj
)->name
, printcharfun
);
1698 print_string (XPROCESS (obj
)->name
, printcharfun
);
1700 else if (BOOL_VECTOR_P (obj
))
1705 struct gcpro gcpro1
;
1706 ptrdiff_t size_in_chars
1707 = ((XBOOL_VECTOR (obj
)->size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1)
1708 / BOOL_VECTOR_BITS_PER_CHAR
);
1714 len
= sprintf (buf
, "%"pI
"d", XBOOL_VECTOR (obj
)->size
);
1715 strout (buf
, len
, len
, printcharfun
);
1718 /* Don't print more characters than the specified maximum.
1719 Negative values of print-length are invalid. Treat them
1720 like a print-length of nil. */
1721 if (NATNUMP (Vprint_length
)
1722 && XFASTINT (Vprint_length
) < size_in_chars
)
1723 size_in_chars
= XFASTINT (Vprint_length
);
1725 for (i
= 0; i
< size_in_chars
; i
++)
1728 c
= XBOOL_VECTOR (obj
)->data
[i
];
1729 if (c
== '\n' && print_escape_newlines
)
1734 else if (c
== '\f' && print_escape_newlines
)
1739 else if (c
> '\177')
1741 /* Use octal escapes to avoid encoding issues. */
1743 PRINTCHAR ('0' + ((c
>> 6) & 3));
1744 PRINTCHAR ('0' + ((c
>> 3) & 7));
1745 PRINTCHAR ('0' + (c
& 7));
1749 if (c
== '\"' || c
== '\\')
1758 else if (SUBRP (obj
))
1760 strout ("#<subr ", -1, -1, printcharfun
);
1761 strout (XSUBR (obj
)->symbol_name
, -1, -1, printcharfun
);
1764 else if (WINDOWP (obj
))
1766 void *ptr
= XWINDOW (obj
);
1767 int len
= sprintf (buf
, "#<window %p", ptr
);
1768 strout (buf
, len
, len
, printcharfun
);
1769 if (BUFFERP (XWINDOW (obj
)->contents
))
1771 strout (" on ", -1, -1, printcharfun
);
1772 print_string (BVAR (XBUFFER (XWINDOW (obj
)->contents
), name
),
1777 else if (TERMINALP (obj
))
1780 struct terminal
*t
= XTERMINAL (obj
);
1781 strout ("#<terminal ", -1, -1, printcharfun
);
1782 len
= sprintf (buf
, "%d", t
->id
);
1783 strout (buf
, len
, len
, printcharfun
);
1786 strout (" on ", -1, -1, printcharfun
);
1787 strout (t
->name
, -1, -1, printcharfun
);
1791 else if (HASH_TABLE_P (obj
))
1793 struct Lisp_Hash_Table
*h
= XHASH_TABLE (obj
);
1795 ptrdiff_t real_size
, size
;
1799 strout ("#<hash-table", -1, -1, printcharfun
);
1800 if (SYMBOLP (h
->test
))
1804 strout (SDATA (SYMBOL_NAME (h
->test
)), -1, -1, printcharfun
);
1806 strout (SDATA (SYMBOL_NAME (h
->weak
)), -1, -1, printcharfun
);
1808 len
= sprintf (buf
, "%"pD
"d/%"pD
"d", h
->count
, ASIZE (h
->next
));
1809 strout (buf
, len
, len
, printcharfun
);
1811 len
= sprintf (buf
, " %p>", ptr
);
1812 strout (buf
, len
, len
, printcharfun
);
1814 /* Implement a readable output, e.g.:
1815 #s(hash-table size 2 test equal data (k1 v1 k2 v2)) */
1816 /* Always print the size. */
1817 len
= sprintf (buf
, "#s(hash-table size %"pD
"d", ASIZE (h
->next
));
1818 strout (buf
, len
, len
, printcharfun
);
1820 if (!NILP (h
->test
.name
))
1822 strout (" test ", -1, -1, printcharfun
);
1823 print_object (h
->test
.name
, printcharfun
, escapeflag
);
1826 if (!NILP (h
->weak
))
1828 strout (" weakness ", -1, -1, printcharfun
);
1829 print_object (h
->weak
, printcharfun
, escapeflag
);
1832 if (!NILP (h
->rehash_size
))
1834 strout (" rehash-size ", -1, -1, printcharfun
);
1835 print_object (h
->rehash_size
, printcharfun
, escapeflag
);
1838 if (!NILP (h
->rehash_threshold
))
1840 strout (" rehash-threshold ", -1, -1, printcharfun
);
1841 print_object (h
->rehash_threshold
, printcharfun
, escapeflag
);
1844 strout (" data ", -1, -1, printcharfun
);
1846 /* Print the data here as a plist. */
1847 real_size
= HASH_TABLE_SIZE (h
);
1850 /* Don't print more elements than the specified maximum. */
1851 if (NATNUMP (Vprint_length
)
1852 && XFASTINT (Vprint_length
) < size
)
1853 size
= XFASTINT (Vprint_length
);
1856 for (i
= 0; i
< size
; i
++)
1857 if (!NILP (HASH_HASH (h
, i
)))
1859 if (i
) PRINTCHAR (' ');
1860 print_object (HASH_KEY (h
, i
), printcharfun
, escapeflag
);
1862 print_object (HASH_VALUE (h
, i
), printcharfun
, escapeflag
);
1865 if (size
< real_size
)
1866 strout (" ...", 4, 4, printcharfun
);
1872 else if (BUFFERP (obj
))
1874 if (!BUFFER_LIVE_P (XBUFFER (obj
)))
1875 strout ("#<killed buffer>", -1, -1, printcharfun
);
1876 else if (escapeflag
)
1878 strout ("#<buffer ", -1, -1, printcharfun
);
1879 print_string (BVAR (XBUFFER (obj
), name
), printcharfun
);
1883 print_string (BVAR (XBUFFER (obj
), name
), printcharfun
);
1885 else if (WINDOW_CONFIGURATIONP (obj
))
1887 strout ("#<window-configuration>", -1, -1, printcharfun
);
1889 else if (FRAMEP (obj
))
1892 void *ptr
= XFRAME (obj
);
1893 Lisp_Object frame_name
= XFRAME (obj
)->name
;
1895 strout ((FRAME_LIVE_P (XFRAME (obj
))
1896 ? "#<frame " : "#<dead frame "),
1897 -1, -1, printcharfun
);
1898 if (!STRINGP (frame_name
))
1900 /* A frame could be too young and have no name yet;
1902 if (SYMBOLP (frame_name
))
1903 frame_name
= Fsymbol_name (frame_name
);
1904 else /* can't happen: name should be either nil or string */
1905 frame_name
= build_string ("*INVALID*FRAME*NAME*");
1907 print_string (frame_name
, printcharfun
);
1908 len
= sprintf (buf
, " %p>", ptr
);
1909 strout (buf
, len
, len
, printcharfun
);
1911 else if (FONTP (obj
))
1915 if (! FONT_OBJECT_P (obj
))
1917 if (FONT_SPEC_P (obj
))
1918 strout ("#<font-spec", -1, -1, printcharfun
);
1920 strout ("#<font-entity", -1, -1, printcharfun
);
1921 for (i
= 0; i
< FONT_SPEC_MAX
; i
++)
1924 if (i
< FONT_WEIGHT_INDEX
|| i
> FONT_WIDTH_INDEX
)
1925 print_object (AREF (obj
, i
), printcharfun
, escapeflag
);
1927 print_object (font_style_symbolic (obj
, i
, 0),
1928 printcharfun
, escapeflag
);
1933 strout ("#<font-object ", -1, -1, printcharfun
);
1934 print_object (AREF (obj
, FONT_NAME_INDEX
), printcharfun
,
1941 ptrdiff_t size
= ASIZE (obj
);
1942 if (COMPILEDP (obj
))
1945 size
&= PSEUDOVECTOR_SIZE_MASK
;
1947 if (CHAR_TABLE_P (obj
) || SUB_CHAR_TABLE_P (obj
))
1949 /* We print a char-table as if it were a vector,
1950 lumping the parent and default slots in with the
1951 character slots. But we add #^ as a prefix. */
1953 /* Make each lowest sub_char_table start a new line.
1954 Otherwise we'll make a line extremely long, which
1955 results in slow redisplay. */
1956 if (SUB_CHAR_TABLE_P (obj
)
1957 && XINT (XSUB_CHAR_TABLE (obj
)->depth
) == 3)
1961 if (SUB_CHAR_TABLE_P (obj
))
1963 size
&= PSEUDOVECTOR_SIZE_MASK
;
1965 if (size
& PSEUDOVECTOR_FLAG
)
1971 register Lisp_Object tem
;
1972 ptrdiff_t real_size
= size
;
1974 /* Don't print more elements than the specified maximum. */
1975 if (NATNUMP (Vprint_length
)
1976 && XFASTINT (Vprint_length
) < size
)
1977 size
= XFASTINT (Vprint_length
);
1979 for (i
= 0; i
< size
; i
++)
1981 if (i
) PRINTCHAR (' ');
1982 tem
= AREF (obj
, i
);
1983 print_object (tem
, printcharfun
, escapeflag
);
1985 if (size
< real_size
)
1986 strout (" ...", 4, 4, printcharfun
);
1993 switch (XMISCTYPE (obj
))
1995 case Lisp_Misc_Marker
:
1996 strout ("#<marker ", -1, -1, printcharfun
);
1997 /* Do you think this is necessary? */
1998 if (XMARKER (obj
)->insertion_type
!= 0)
1999 strout ("(moves after insertion) ", -1, -1, printcharfun
);
2000 if (! XMARKER (obj
)->buffer
)
2001 strout ("in no buffer", -1, -1, printcharfun
);
2004 int len
= sprintf (buf
, "at %"pD
"d", marker_position (obj
));
2005 strout (buf
, len
, len
, printcharfun
);
2006 strout (" in ", -1, -1, printcharfun
);
2007 print_string (BVAR (XMARKER (obj
)->buffer
, name
), printcharfun
);
2012 case Lisp_Misc_Overlay
:
2013 strout ("#<overlay ", -1, -1, printcharfun
);
2014 if (! XMARKER (OVERLAY_START (obj
))->buffer
)
2015 strout ("in no buffer", -1, -1, printcharfun
);
2018 int len
= sprintf (buf
, "from %"pD
"d to %"pD
"d in ",
2019 marker_position (OVERLAY_START (obj
)),
2020 marker_position (OVERLAY_END (obj
)));
2021 strout (buf
, len
, len
, printcharfun
);
2022 print_string (BVAR (XMARKER (OVERLAY_START (obj
))->buffer
, name
),
2028 /* Remaining cases shouldn't happen in normal usage, but let's
2029 print them anyway for the benefit of the debugger. */
2031 case Lisp_Misc_Free
:
2032 strout ("#<misc free cell>", -1, -1, printcharfun
);
2035 case Lisp_Misc_Save_Value
:
2038 struct Lisp_Save_Value
*v
= XSAVE_VALUE (obj
);
2040 strout ("#<save-value ", -1, -1, printcharfun
);
2042 if (v
->save_type
== SAVE_TYPE_MEMORY
)
2044 ptrdiff_t amount
= v
->data
[1].integer
;
2048 /* valid_lisp_object_p is reliable, so try to print up
2049 to 8 saved objects. This code is rarely used, so
2050 it's OK that valid_lisp_object_p is slow. */
2052 int limit
= min (amount
, 8);
2053 Lisp_Object
*area
= v
->data
[0].pointer
;
2055 i
= sprintf (buf
, "with %"pD
"d objects", amount
);
2056 strout (buf
, i
, i
, printcharfun
);
2058 for (i
= 0; i
< limit
; i
++)
2060 Lisp_Object maybe
= area
[i
];
2062 if (valid_lisp_object_p (maybe
) > 0)
2065 print_object (maybe
, printcharfun
, escapeflag
);
2068 strout (" <invalid>", -1, -1, printcharfun
);
2070 if (i
== limit
&& i
< amount
)
2071 strout (" ...", 4, 4, printcharfun
);
2073 #else /* not GC_MARK_STACK */
2075 /* There is no reliable way to determine whether the objects
2076 are initialized, so do not try to print them. */
2078 i
= sprintf (buf
, "with %"pD
"d objects", amount
);
2079 strout (buf
, i
, i
, printcharfun
);
2081 #endif /* GC_MARK_STACK */
2085 /* Print each slot according to its type. */
2087 for (index
= 0; index
< SAVE_VALUE_SLOTS
; index
++)
2092 switch (save_type (v
, index
))
2095 i
= sprintf (buf
, "<unused>");
2099 i
= sprintf (buf
, "<pointer %p>",
2100 v
->data
[index
].pointer
);
2103 case SAVE_FUNCPOINTER
:
2104 i
= sprintf (buf
, "<funcpointer %p>",
2105 ((void *) (intptr_t)
2106 v
->data
[index
].funcpointer
));
2110 i
= sprintf (buf
, "<integer %"pD
"d>",
2111 v
->data
[index
].integer
);
2115 print_object (v
->data
[index
].object
, printcharfun
,
2123 strout (buf
, i
, i
, printcharfun
);
2139 /* We're in trouble if this happens!
2140 Probably should just emacs_abort (). */
2141 strout ("#<EMACS BUG: INVALID DATATYPE ", -1, -1, printcharfun
);
2143 len
= sprintf (buf
, "(MISC 0x%04x)", (int) XMISCTYPE (obj
));
2144 else if (VECTORLIKEP (obj
))
2145 len
= sprintf (buf
, "(PVEC 0x%08"pD
"x)", ASIZE (obj
));
2147 len
= sprintf (buf
, "(0x%02x)", (int) XTYPE (obj
));
2148 strout (buf
, len
, len
, printcharfun
);
2149 strout (" Save your buffers immediately and please report this bug>",
2150 -1, -1, printcharfun
);
2158 /* Print a description of INTERVAL using PRINTCHARFUN.
2159 This is part of printing a string that has text properties. */
2162 print_interval (INTERVAL interval
, Lisp_Object printcharfun
)
2164 if (NILP (interval
->plist
))
2167 print_object (make_number (interval
->position
), printcharfun
, 1);
2169 print_object (make_number (interval
->position
+ LENGTH (interval
)),
2172 print_object (interval
->plist
, printcharfun
, 1);
2175 /* Initialize debug_print stuff early to have it working from the very
2179 init_print_once (void)
2181 DEFSYM (Qexternal_debugging_output
, "external-debugging-output");
2182 defsubr (&Sexternal_debugging_output
);
2186 syms_of_print (void)
2188 DEFSYM (Qtemp_buffer_setup_hook
, "temp-buffer-setup-hook");
2190 DEFVAR_LISP ("standard-output", Vstandard_output
,
2191 doc
: /* Output stream `print' uses by default for outputting a character.
2192 This may be any function of one argument.
2193 It may also be a buffer (output is inserted before point)
2194 or a marker (output is inserted and the marker is advanced)
2195 or the symbol t (output appears in the echo area). */);
2196 Vstandard_output
= Qt
;
2197 DEFSYM (Qstandard_output
, "standard-output");
2199 DEFVAR_LISP ("float-output-format", Vfloat_output_format
,
2200 doc
: /* The format descriptor string used to print floats.
2201 This is a %-spec like those accepted by `printf' in C,
2202 but with some restrictions. It must start with the two characters `%.'.
2203 After that comes an integer precision specification,
2204 and then a letter which controls the format.
2205 The letters allowed are `e', `f' and `g'.
2206 Use `e' for exponential notation \"DIG.DIGITSeEXPT\"
2207 Use `f' for decimal point notation \"DIGITS.DIGITS\".
2208 Use `g' to choose the shorter of those two formats for the number at hand.
2209 The precision in any of these cases is the number of digits following
2210 the decimal point. With `f', a precision of 0 means to omit the
2211 decimal point. 0 is not allowed with `e' or `g'.
2213 A value of nil means to use the shortest notation
2214 that represents the number without losing information. */);
2215 Vfloat_output_format
= Qnil
;
2216 DEFSYM (Qfloat_output_format
, "float-output-format");
2218 DEFVAR_LISP ("print-length", Vprint_length
,
2219 doc
: /* Maximum length of list to print before abbreviating.
2220 A value of nil means no limit. See also `eval-expression-print-length'. */);
2221 Vprint_length
= Qnil
;
2223 DEFVAR_LISP ("print-level", Vprint_level
,
2224 doc
: /* Maximum depth of list nesting to print before abbreviating.
2225 A value of nil means no limit. See also `eval-expression-print-level'. */);
2226 Vprint_level
= Qnil
;
2228 DEFVAR_BOOL ("print-escape-newlines", print_escape_newlines
,
2229 doc
: /* Non-nil means print newlines in strings as `\\n'.
2230 Also print formfeeds as `\\f'. */);
2231 print_escape_newlines
= 0;
2233 DEFVAR_BOOL ("print-escape-nonascii", print_escape_nonascii
,
2234 doc
: /* Non-nil means print unibyte non-ASCII chars in strings as \\OOO.
2235 \(OOO is the octal representation of the character code.)
2236 Only single-byte characters are affected, and only in `prin1'.
2237 When the output goes in a multibyte buffer, this feature is
2238 enabled regardless of the value of the variable. */);
2239 print_escape_nonascii
= 0;
2241 DEFVAR_BOOL ("print-escape-multibyte", print_escape_multibyte
,
2242 doc
: /* Non-nil means print multibyte characters in strings as \\xXXXX.
2243 \(XXXX is the hex representation of the character code.)
2244 This affects only `prin1'. */);
2245 print_escape_multibyte
= 0;
2247 DEFVAR_BOOL ("print-quoted", print_quoted
,
2248 doc
: /* Non-nil means print quoted forms with reader syntax.
2249 I.e., (quote foo) prints as 'foo, (function foo) as #'foo. */);
2252 DEFVAR_LISP ("print-gensym", Vprint_gensym
,
2253 doc
: /* Non-nil means print uninterned symbols so they will read as uninterned.
2254 I.e., the value of (make-symbol \"foobar\") prints as #:foobar.
2255 When the uninterned symbol appears within a recursive data structure,
2256 and the symbol appears more than once, in addition use the #N# and #N=
2257 constructs as needed, so that multiple references to the same symbol are
2258 shared once again when the text is read back. */);
2259 Vprint_gensym
= Qnil
;
2261 DEFVAR_LISP ("print-circle", Vprint_circle
,
2262 doc
: /* Non-nil means print recursive structures using #N= and #N# syntax.
2263 If nil, printing proceeds recursively and may lead to
2264 `max-lisp-eval-depth' being exceeded or an error may occur:
2265 \"Apparently circular structure being printed.\" Also see
2266 `print-length' and `print-level'.
2267 If non-nil, shared substructures anywhere in the structure are printed
2268 with `#N=' before the first occurrence (in the order of the print
2269 representation) and `#N#' in place of each subsequent occurrence,
2270 where N is a positive decimal integer. */);
2271 Vprint_circle
= Qnil
;
2273 DEFVAR_LISP ("print-continuous-numbering", Vprint_continuous_numbering
,
2274 doc
: /* Non-nil means number continuously across print calls.
2275 This affects the numbers printed for #N= labels and #M# references.
2276 See also `print-circle', `print-gensym', and `print-number-table'.
2277 This variable should not be set with `setq'; bind it with a `let' instead. */);
2278 Vprint_continuous_numbering
= Qnil
;
2280 DEFVAR_LISP ("print-number-table", Vprint_number_table
,
2281 doc
: /* A vector used internally to produce `#N=' labels and `#N#' references.
2282 The Lisp printer uses this vector to detect Lisp objects referenced more
2285 When you bind `print-continuous-numbering' to t, you should probably
2286 also bind `print-number-table' to nil. This ensures that the value of
2287 `print-number-table' can be garbage-collected once the printing is
2288 done. If all elements of `print-number-table' are nil, it means that
2289 the printing done so far has not found any shared structure or objects
2290 that need to be recorded in the table. */);
2291 Vprint_number_table
= Qnil
;
2293 DEFVAR_LISP ("print-charset-text-property", Vprint_charset_text_property
,
2294 doc
: /* A flag to control printing of `charset' text property on printing a string.
2295 The value must be nil, t, or `default'.
2297 If the value is nil, don't print the text property `charset'.
2299 If the value is t, always print the text property `charset'.
2301 If the value is `default', print the text property `charset' only when
2302 the value is different from what is guessed in the current charset
2304 Vprint_charset_text_property
= Qdefault
;
2306 /* prin1_to_string_buffer initialized in init_buffer_once in buffer.c */
2307 staticpro (&Vprin1_to_string_buffer
);
2310 defsubr (&Sprin1_to_string
);
2311 defsubr (&Serror_message_string
);
2315 defsubr (&Swrite_char
);
2316 #ifdef WITH_REDIRECT_DEBUGGING_OUTPUT
2317 defsubr (&Sredirect_debugging_output
);
2320 DEFSYM (Qprint_escape_newlines
, "print-escape-newlines");
2321 DEFSYM (Qprint_escape_multibyte
, "print-escape-multibyte");
2322 DEFSYM (Qprint_escape_nonascii
, "print-escape-nonascii");
2324 print_prune_charset_plist
= Qnil
;
2325 staticpro (&print_prune_charset_plist
);