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 int 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 int free_print_buffer = 0; \
105 int multibyte = !NILP (BVAR (current_buffer, enable_multibyte_characters)); \
108 #define PRINTPREPARE \
109 original = printcharfun; \
110 if (NILP (printcharfun)) printcharfun = Qt; \
111 if (BUFFERP (printcharfun)) \
113 if (XBUFFER (printcharfun) != current_buffer) \
114 Fset_buffer (printcharfun); \
115 printcharfun = Qnil; \
117 if (MARKERP (printcharfun)) \
119 ptrdiff_t marker_pos; \
120 if (! XMARKER (printcharfun)->buffer) \
121 error ("Marker does not point anywhere"); \
122 if (XMARKER (printcharfun)->buffer != current_buffer) \
123 set_buffer_internal (XMARKER (printcharfun)->buffer); \
124 marker_pos = marker_position (printcharfun); \
125 if (marker_pos < BEGV || marker_pos > ZV) \
126 error ("Marker is outside the accessible part of the buffer"); \
128 old_point_byte = PT_BYTE; \
129 SET_PT_BOTH (marker_pos, \
130 marker_byte_position (printcharfun)); \
132 start_point_byte = PT_BYTE; \
133 printcharfun = Qnil; \
135 if (NILP (printcharfun)) \
137 Lisp_Object string; \
138 if (NILP (BVAR (current_buffer, enable_multibyte_characters)) \
139 && ! print_escape_multibyte) \
140 specbind (Qprint_escape_multibyte, Qt); \
141 if (! NILP (BVAR (current_buffer, enable_multibyte_characters)) \
142 && ! print_escape_nonascii) \
143 specbind (Qprint_escape_nonascii, Qt); \
144 if (print_buffer != 0) \
146 string = make_string_from_bytes (print_buffer, \
148 print_buffer_pos_byte); \
149 record_unwind_protect (print_unwind, string); \
153 int new_size = 1000; \
154 print_buffer = xmalloc (new_size); \
155 print_buffer_size = new_size; \
156 free_print_buffer = 1; \
158 print_buffer_pos = 0; \
159 print_buffer_pos_byte = 0; \
161 if (EQ (printcharfun, Qt) && ! noninteractive) \
162 setup_echo_area_for_printing (multibyte);
164 #define PRINTFINISH \
165 if (NILP (printcharfun)) \
167 if (print_buffer_pos != print_buffer_pos_byte \
168 && NILP (BVAR (current_buffer, enable_multibyte_characters))) \
170 unsigned char *temp = alloca (print_buffer_pos + 1); \
171 copy_text ((unsigned char *) print_buffer, temp, \
172 print_buffer_pos_byte, 1, 0); \
173 insert_1_both ((char *) temp, print_buffer_pos, \
174 print_buffer_pos, 0, 1, 0); \
177 insert_1_both (print_buffer, print_buffer_pos, \
178 print_buffer_pos_byte, 0, 1, 0); \
179 signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
181 if (free_print_buffer) \
183 xfree (print_buffer); \
186 unbind_to (specpdl_count, Qnil); \
187 if (MARKERP (original)) \
188 set_marker_both (original, Qnil, PT, PT_BYTE); \
189 if (old_point >= 0) \
190 SET_PT_BOTH (old_point + (old_point >= start_point \
191 ? PT - start_point : 0), \
192 old_point_byte + (old_point_byte >= start_point_byte \
193 ? PT_BYTE - start_point_byte : 0)); \
194 set_buffer_internal (old);
196 #define PRINTCHAR(ch) printchar (ch, printcharfun)
198 /* This is used to restore the saved contents of print_buffer
199 when there is a recursive call to print. */
202 print_unwind (Lisp_Object saved_text
)
204 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
);
231 xpalloc (print_buffer
, &print_buffer_size
, incr
, -1, 1);
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 obj
, register Lisp_Object printcharfun
, int escapeflag
);
511 static void print_preprocess (Lisp_Object obj
);
512 static void print_preprocess_string (INTERVAL interval
, Lisp_Object arg
);
513 static void print_object (Lisp_Object obj
, register Lisp_Object printcharfun
, int escapeflag
);
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 (int) EXTERNALLY_VISIBLE
;
731 debug_output_compilation_hack (int 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
= 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",
778 #endif /* GNU_LINUX */
781 /* This is the interface for debugging printing. */
784 debug_print (Lisp_Object arg
)
786 Fprin1 (arg
, Qexternal_debugging_output
);
787 fprintf (stderr
, "\r\n");
790 void safe_debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
792 safe_debug_print (Lisp_Object arg
)
794 int valid
= valid_lisp_object_p (arg
);
799 fprintf (stderr
, "#<%s_LISP_OBJECT 0x%08"pI
"x>\r\n",
800 !valid
? "INVALID" : "SOME",
805 DEFUN ("error-message-string", Ferror_message_string
, Serror_message_string
,
807 doc
: /* Convert an error value (ERROR-SYMBOL . DATA) to an error message.
808 See Info anchor `(elisp)Definition of signal' for some details on how this
809 error message is constructed. */)
812 struct buffer
*old
= current_buffer
;
816 /* If OBJ is (error STRING), just return STRING.
817 That is not only faster, it also avoids the need to allocate
818 space here when the error is due to memory full. */
819 if (CONSP (obj
) && EQ (XCAR (obj
), Qerror
)
820 && CONSP (XCDR (obj
))
821 && STRINGP (XCAR (XCDR (obj
)))
822 && NILP (XCDR (XCDR (obj
))))
823 return XCAR (XCDR (obj
));
825 print_error_message (obj
, Vprin1_to_string_buffer
, 0, Qnil
);
827 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer
));
828 value
= Fbuffer_string ();
832 set_buffer_internal (old
);
838 /* Print an error message for the error DATA onto Lisp output stream
839 STREAM (suitable for the print functions).
840 CONTEXT is a C string describing the context of the error.
841 CALLER is the Lisp function inside which the error was signaled. */
844 print_error_message (Lisp_Object data
, Lisp_Object stream
, const char *context
,
847 Lisp_Object errname
, errmsg
, file_error
, tail
;
851 write_string_1 (context
, -1, stream
);
853 /* If we know from where the error was signaled, show it in
855 if (!NILP (caller
) && SYMBOLP (caller
))
857 Lisp_Object cname
= SYMBOL_NAME (caller
);
858 ptrdiff_t cnamelen
= SBYTES (cname
);
860 char *name
= SAFE_ALLOCA (cnamelen
);
861 memcpy (name
, SDATA (cname
), cnamelen
);
862 message_dolog (name
, cnamelen
, 0, 0);
863 message_dolog (": ", 2, 0, 0);
867 errname
= Fcar (data
);
869 if (EQ (errname
, Qerror
))
874 errmsg
= Fcar (data
);
879 Lisp_Object error_conditions
= Fget (errname
, Qerror_conditions
);
880 errmsg
= Fget (errname
, Qerror_message
);
881 file_error
= Fmemq (Qfile_error
, error_conditions
);
884 /* Print an error message including the data items. */
886 tail
= Fcdr_safe (data
);
889 /* For file-error, make error message by concatenating
890 all the data items. They are all strings. */
891 if (!NILP (file_error
) && CONSP (tail
))
892 errmsg
= XCAR (tail
), tail
= XCDR (tail
);
895 const char *sep
= ": ";
897 if (!STRINGP (errmsg
))
898 write_string_1 ("peculiar error", -1, stream
);
899 else if (SCHARS (errmsg
))
900 Fprinc (errmsg
, stream
);
904 for (; CONSP (tail
); tail
= XCDR (tail
), sep
= ", ")
909 write_string_1 (sep
, 2, stream
);
911 if (!NILP (file_error
)
912 || EQ (errname
, Qend_of_file
) || EQ (errname
, Quser_error
))
913 Fprinc (obj
, stream
);
915 Fprin1 (obj
, stream
);
925 * The buffer should be at least as large as the max string size of the
926 * largest float, printed in the biggest notation. This is undoubtedly
927 * 20d float_output_format, with the negative of the C-constant "HUGE"
930 * On the vax the worst case is -1e38 in 20d format which takes 61 bytes.
932 * I assume that IEEE-754 format numbers can take 329 bytes for the worst
933 * case of -1e307 in 20d float_output_format. What is one to do (short of
934 * re-writing _doprnt to be more sane)?
936 * Given the above, the buffer must be least FLOAT_TO_STRING_BUFSIZE bytes.
940 float_to_string (char *buf
, double data
)
946 /* Check for plus infinity in a way that won't lose
947 if there is no plus infinity. */
948 if (data
== data
/ 2 && data
> 1.0)
950 static char const infinity_string
[] = "1.0e+INF";
951 strcpy (buf
, infinity_string
);
952 return sizeof infinity_string
- 1;
954 /* Likewise for minus infinity. */
955 if (data
== data
/ 2 && data
< -1.0)
957 static char const minus_infinity_string
[] = "-1.0e+INF";
958 strcpy (buf
, minus_infinity_string
);
959 return sizeof minus_infinity_string
- 1;
961 /* Check for NaN in a way that won't fail if there are no NaNs. */
962 if (! (data
* 0.0 >= 0.0))
964 /* Prepend "-" if the NaN's sign bit is negative.
965 The sign bit of a double is the bit that is 1 in -0.0. */
966 static char const NaN_string
[] = "0.0e+NaN";
968 union { double d
; char c
[sizeof (double)]; } u_data
, u_minus_zero
;
971 u_minus_zero
.d
= - 0.0;
972 for (i
= 0; i
< sizeof (double); i
++)
973 if (u_data
.c
[i
] & u_minus_zero
.c
[i
])
980 strcpy (buf
+ negative
, NaN_string
);
981 return negative
+ sizeof NaN_string
- 1;
984 if (NILP (Vfloat_output_format
)
985 || !STRINGP (Vfloat_output_format
))
988 /* Generate the fewest number of digits that represent the
989 floating point value without losing information. */
990 len
= dtoastr (buf
, FLOAT_TO_STRING_BUFSIZE
- 2, 0, 0, data
);
991 /* The decimal point must be printed, or the byte compiler can
992 get confused (Bug#8033). */
997 /* Check that the spec we have is fully valid.
998 This means not only valid for printf,
999 but meant for floats, and reasonable. */
1000 cp
= SSDATA (Vfloat_output_format
);
1009 /* Check the width specification. */
1011 if ('0' <= *cp
&& *cp
<= '9')
1016 width
= (width
* 10) + (*cp
++ - '0');
1017 if (DBL_DIG
< width
)
1020 while (*cp
>= '0' && *cp
<= '9');
1022 /* A precision of zero is valid only for %f. */
1023 if (width
== 0 && *cp
!= 'f')
1027 if (*cp
!= 'e' && *cp
!= 'f' && *cp
!= 'g')
1033 len
= sprintf (buf
, SSDATA (Vfloat_output_format
), data
);
1036 /* Make sure there is a decimal point with digit after, or an
1037 exponent, so that the value is readable as a float. But don't do
1038 this with "%.0f"; it's valid for that not to produce a decimal
1039 point. Note that width can be 0 only for %.0f. */
1042 for (cp
= buf
; *cp
; cp
++)
1043 if ((*cp
< '0' || *cp
> '9') && *cp
!= '-')
1046 if (*cp
== '.' && cp
[1] == 0)
1066 print (Lisp_Object obj
, register Lisp_Object printcharfun
, int escapeflag
)
1068 new_backquote_output
= 0;
1070 /* Reset print_number_index and Vprint_number_table only when
1071 the variable Vprint_continuous_numbering is nil. Otherwise,
1072 the values of these variables will be kept between several
1074 if (NILP (Vprint_continuous_numbering
)
1075 || NILP (Vprint_number_table
))
1077 print_number_index
= 0;
1078 Vprint_number_table
= Qnil
;
1081 /* Construct Vprint_number_table for print-gensym and print-circle. */
1082 if (!NILP (Vprint_gensym
) || !NILP (Vprint_circle
))
1084 /* Construct Vprint_number_table.
1085 This increments print_number_index for the objects added. */
1087 print_preprocess (obj
);
1089 if (HASH_TABLE_P (Vprint_number_table
))
1090 { /* Remove unnecessary objects, which appear only once in OBJ;
1091 that is, whose status is Qt. */
1092 struct Lisp_Hash_Table
*h
= XHASH_TABLE (Vprint_number_table
);
1095 for (i
= 0; i
< HASH_TABLE_SIZE (h
); ++i
)
1096 if (!NILP (HASH_HASH (h
, i
))
1097 && EQ (HASH_VALUE (h
, i
), Qt
))
1098 Fremhash (HASH_KEY (h
, i
), Vprint_number_table
);
1103 print_object (obj
, printcharfun
, escapeflag
);
1106 #define PRINT_CIRCLE_CANDIDATE_P(obj) \
1107 (STRINGP (obj) || CONSP (obj) \
1108 || (VECTORLIKEP (obj) \
1109 && (VECTORP (obj) || COMPILEDP (obj) \
1110 || CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj) \
1111 || HASH_TABLE_P (obj) || FONTP (obj))) \
1112 || (! NILP (Vprint_gensym) \
1114 && !SYMBOL_INTERNED_P (obj)))
1116 /* Construct Vprint_number_table according to the structure of OBJ.
1117 OBJ itself and all its elements will be added to Vprint_number_table
1118 recursively if it is a list, vector, compiled function, char-table,
1119 string (its text properties will be traced), or a symbol that has
1120 no obarray (this is for the print-gensym feature).
1121 The status fields of Vprint_number_table mean whether each object appears
1122 more than once in OBJ: Qnil at the first time, and Qt after that . */
1124 print_preprocess (Lisp_Object obj
)
1129 Lisp_Object halftail
;
1131 /* Avoid infinite recursion for circular nested structure
1132 in the case where Vprint_circle is nil. */
1133 if (NILP (Vprint_circle
))
1135 /* Give up if we go so deep that print_object will get an error. */
1136 /* See similar code in print_object. */
1137 if (print_depth
>= PRINT_CIRCLE
)
1138 error ("Apparently circular structure being printed");
1140 for (i
= 0; i
< print_depth
; i
++)
1141 if (EQ (obj
, being_printed
[i
]))
1143 being_printed
[print_depth
] = obj
;
1150 if (PRINT_CIRCLE_CANDIDATE_P (obj
))
1152 if (!HASH_TABLE_P (Vprint_number_table
))
1154 Lisp_Object args
[2];
1157 Vprint_number_table
= Fmake_hash_table (2, args
);
1160 /* In case print-circle is nil and print-gensym is t,
1161 add OBJ to Vprint_number_table only when OBJ is a symbol. */
1162 if (! NILP (Vprint_circle
) || SYMBOLP (obj
))
1164 Lisp_Object num
= Fgethash (obj
, Vprint_number_table
, Qnil
);
1166 /* If Vprint_continuous_numbering is non-nil and OBJ is a gensym,
1167 always print the gensym with a number. This is a special for
1168 the lisp function byte-compile-output-docform. */
1169 || (!NILP (Vprint_continuous_numbering
)
1171 && !SYMBOL_INTERNED_P (obj
)))
1172 { /* OBJ appears more than once. Let's remember that. */
1173 if (!INTEGERP (num
))
1175 print_number_index
++;
1176 /* Negative number indicates it hasn't been printed yet. */
1177 Fputhash (obj
, make_number (- print_number_index
),
1178 Vprint_number_table
);
1184 /* OBJ is not yet recorded. Let's add to the table. */
1185 Fputhash (obj
, Qt
, Vprint_number_table
);
1188 switch (XTYPE (obj
))
1191 /* A string may have text properties, which can be circular. */
1192 traverse_intervals_noorder (string_intervals (obj
),
1193 print_preprocess_string
, Qnil
);
1197 /* Use HALFTAIL and LOOP_COUNT to detect circular lists,
1198 just as in print_object. */
1199 if (loop_count
&& EQ (obj
, halftail
))
1201 print_preprocess (XCAR (obj
));
1204 if (!(loop_count
& 1))
1205 halftail
= XCDR (halftail
);
1208 case Lisp_Vectorlike
:
1210 if (size
& PSEUDOVECTOR_FLAG
)
1211 size
&= PSEUDOVECTOR_SIZE_MASK
;
1212 for (i
= 0; i
< size
; i
++)
1213 print_preprocess (AREF (obj
, i
));
1214 if (HASH_TABLE_P (obj
))
1215 { /* For hash tables, the key_and_value slot is past
1216 `size' because it needs to be marked specially in case
1217 the table is weak. */
1218 struct Lisp_Hash_Table
*h
= XHASH_TABLE (obj
);
1219 print_preprocess (h
->key_and_value
);
1231 print_preprocess_string (INTERVAL interval
, Lisp_Object arg
)
1233 print_preprocess (interval
->plist
);
1236 static void print_check_string_charset_prop (INTERVAL interval
, Lisp_Object string
);
1238 #define PRINT_STRING_NON_CHARSET_FOUND 1
1239 #define PRINT_STRING_UNSAFE_CHARSET_FOUND 2
1241 /* Bitwise or of the above macros. */
1242 static int print_check_string_result
;
1245 print_check_string_charset_prop (INTERVAL interval
, Lisp_Object string
)
1249 if (NILP (interval
->plist
)
1250 || (print_check_string_result
== (PRINT_STRING_NON_CHARSET_FOUND
1251 | PRINT_STRING_UNSAFE_CHARSET_FOUND
)))
1253 for (val
= interval
->plist
; CONSP (val
) && ! EQ (XCAR (val
), Qcharset
);
1254 val
= XCDR (XCDR (val
)));
1257 print_check_string_result
|= PRINT_STRING_NON_CHARSET_FOUND
;
1260 if (! (print_check_string_result
& PRINT_STRING_NON_CHARSET_FOUND
))
1262 if (! EQ (val
, interval
->plist
)
1263 || CONSP (XCDR (XCDR (val
))))
1264 print_check_string_result
|= PRINT_STRING_NON_CHARSET_FOUND
;
1266 if (NILP (Vprint_charset_text_property
)
1267 || ! (print_check_string_result
& PRINT_STRING_UNSAFE_CHARSET_FOUND
))
1270 ptrdiff_t charpos
= interval
->position
;
1271 ptrdiff_t bytepos
= string_char_to_byte (string
, charpos
);
1272 Lisp_Object charset
;
1274 charset
= XCAR (XCDR (val
));
1275 for (i
= 0; i
< LENGTH (interval
); i
++)
1277 FETCH_STRING_CHAR_ADVANCE (c
, string
, charpos
, bytepos
);
1278 if (! ASCII_CHAR_P (c
)
1279 && ! EQ (CHARSET_NAME (CHAR_CHARSET (c
)), charset
))
1281 print_check_string_result
|= PRINT_STRING_UNSAFE_CHARSET_FOUND
;
1288 /* The value is (charset . nil). */
1289 static Lisp_Object print_prune_charset_plist
;
1292 print_prune_string_charset (Lisp_Object string
)
1294 print_check_string_result
= 0;
1295 traverse_intervals (string_intervals (string
), 0,
1296 print_check_string_charset_prop
, string
);
1297 if (! (print_check_string_result
& PRINT_STRING_UNSAFE_CHARSET_FOUND
))
1299 string
= Fcopy_sequence (string
);
1300 if (print_check_string_result
& PRINT_STRING_NON_CHARSET_FOUND
)
1302 if (NILP (print_prune_charset_plist
))
1303 print_prune_charset_plist
= Fcons (Qcharset
, Qnil
);
1304 Fremove_text_properties (make_number (0),
1305 make_number (SCHARS (string
)),
1306 print_prune_charset_plist
, string
);
1309 Fset_text_properties (make_number (0), make_number (SCHARS (string
)),
1316 print_object (Lisp_Object obj
, register Lisp_Object printcharfun
, int escapeflag
)
1318 char buf
[max (sizeof "from..to..in " + 2 * INT_STRLEN_BOUND (EMACS_INT
),
1319 max (sizeof " . #" + INT_STRLEN_BOUND (printmax_t
),
1324 /* Detect circularities and truncate them. */
1325 if (NILP (Vprint_circle
))
1327 /* Simple but incomplete way. */
1330 /* See similar code in print_preprocess. */
1331 if (print_depth
>= PRINT_CIRCLE
)
1332 error ("Apparently circular structure being printed");
1334 for (i
= 0; i
< print_depth
; i
++)
1335 if (EQ (obj
, being_printed
[i
]))
1337 int len
= sprintf (buf
, "#%d", i
);
1338 strout (buf
, len
, len
, printcharfun
);
1341 being_printed
[print_depth
] = obj
;
1343 else if (PRINT_CIRCLE_CANDIDATE_P (obj
))
1345 /* With the print-circle feature. */
1346 Lisp_Object num
= Fgethash (obj
, Vprint_number_table
, Qnil
);
1349 EMACS_INT n
= XINT (num
);
1351 { /* Add a prefix #n= if OBJ has not yet been printed;
1352 that is, its status field is nil. */
1353 int len
= sprintf (buf
, "#%"pI
"d=", -n
);
1354 strout (buf
, len
, len
, printcharfun
);
1355 /* OBJ is going to be printed. Remember that fact. */
1356 Fputhash (obj
, make_number (- n
), Vprint_number_table
);
1360 /* Just print #n# if OBJ has already been printed. */
1361 int len
= sprintf (buf
, "#%"pI
"d#", n
);
1362 strout (buf
, len
, len
, printcharfun
);
1370 switch (XTYPE (obj
))
1374 int len
= sprintf (buf
, "%"pI
"d", XINT (obj
));
1375 strout (buf
, len
, len
, printcharfun
);
1381 char pigbuf
[FLOAT_TO_STRING_BUFSIZE
];
1382 int len
= float_to_string (pigbuf
, XFLOAT_DATA (obj
));
1383 strout (pigbuf
, len
, len
, printcharfun
);
1389 print_string (obj
, printcharfun
);
1392 register ptrdiff_t i_byte
;
1393 struct gcpro gcpro1
;
1395 ptrdiff_t size_byte
;
1396 /* 1 means we must ensure that the next character we output
1397 cannot be taken as part of a hex character escape. */
1398 int need_nonhex
= 0;
1399 int multibyte
= STRING_MULTIBYTE (obj
);
1403 if (! EQ (Vprint_charset_text_property
, Qt
))
1404 obj
= print_prune_string_charset (obj
);
1406 if (string_intervals (obj
))
1414 size_byte
= SBYTES (obj
);
1416 for (i_byte
= 0; i_byte
< size_byte
;)
1418 /* Here, we must convert each multi-byte form to the
1419 corresponding character code before handing it to PRINTCHAR. */
1425 c
= STRING_CHAR_AND_LENGTH (str
+ i_byte
, len
);
1433 if (c
== '\n' && print_escape_newlines
)
1438 else if (c
== '\f' && print_escape_newlines
)
1444 && (CHAR_BYTE8_P (c
)
1445 || (! ASCII_CHAR_P (c
) && print_escape_multibyte
)))
1447 /* When multibyte is disabled,
1448 print multibyte string chars using hex escapes.
1449 For a char code that could be in a unibyte string,
1450 when found in a multibyte string, always use a hex escape
1451 so it reads back as multibyte. */
1455 if (CHAR_BYTE8_P (c
))
1456 len
= sprintf (outbuf
, "\\%03o", CHAR_TO_BYTE8 (c
));
1459 len
= sprintf (outbuf
, "\\x%04x", c
);
1462 strout (outbuf
, len
, len
, printcharfun
);
1464 else if (! multibyte
1465 && SINGLE_BYTE_CHAR_P (c
) && ! ASCII_BYTE_P (c
)
1466 && print_escape_nonascii
)
1468 /* When printing in a multibyte buffer
1469 or when explicitly requested,
1470 print single-byte non-ASCII string chars
1471 using octal escapes. */
1473 int len
= sprintf (outbuf
, "\\%03o", c
);
1474 strout (outbuf
, len
, len
, printcharfun
);
1478 /* If we just had a hex escape, and this character
1479 could be taken as part of it,
1480 output `\ ' to prevent that. */
1484 if ((c
>= 'a' && c
<= 'f')
1485 || (c
>= 'A' && c
<= 'F')
1486 || (c
>= '0' && c
<= '9'))
1487 strout ("\\ ", -1, -1, printcharfun
);
1490 if (c
== '\"' || c
== '\\')
1497 if (string_intervals (obj
))
1499 traverse_intervals (string_intervals (obj
),
1500 0, print_interval
, printcharfun
);
1510 register int confusing
;
1511 register unsigned char *p
= SDATA (SYMBOL_NAME (obj
));
1512 register unsigned char *end
= p
+ SBYTES (SYMBOL_NAME (obj
));
1514 ptrdiff_t i
, i_byte
;
1515 ptrdiff_t size_byte
;
1518 name
= SYMBOL_NAME (obj
);
1520 if (p
!= end
&& (*p
== '-' || *p
== '+')) p
++;
1523 /* If symbol name begins with a digit, and ends with a digit,
1524 and contains nothing but digits and `e', it could be treated
1525 as a number. So set CONFUSING.
1527 Symbols that contain periods could also be taken as numbers,
1528 but periods are always escaped, so we don't have to worry
1530 else if (*p
>= '0' && *p
<= '9'
1531 && end
[-1] >= '0' && end
[-1] <= '9')
1533 while (p
!= end
&& ((*p
>= '0' && *p
<= '9')
1534 /* Needed for \2e10. */
1535 || *p
== 'e' || *p
== 'E'))
1537 confusing
= (end
== p
);
1542 size_byte
= SBYTES (name
);
1544 if (! NILP (Vprint_gensym
) && !SYMBOL_INTERNED_P (obj
))
1549 else if (size_byte
== 0)
1556 for (i
= 0, i_byte
= 0; i_byte
< size_byte
;)
1558 /* Here, we must convert each multi-byte form to the
1559 corresponding character code before handing it to PRINTCHAR. */
1560 FETCH_STRING_CHAR_ADVANCE (c
, name
, i
, i_byte
);
1565 if (c
== '\"' || c
== '\\' || c
== '\''
1566 || c
== ';' || c
== '#' || c
== '(' || c
== ')'
1567 || c
== ',' || c
== '.' || c
== '`'
1568 || c
== '[' || c
== ']' || c
== '?' || c
<= 040
1570 PRINTCHAR ('\\'), confusing
= 0;
1578 /* If deeper than spec'd depth, print placeholder. */
1579 if (INTEGERP (Vprint_level
)
1580 && print_depth
> XINT (Vprint_level
))
1581 strout ("...", -1, -1, printcharfun
);
1582 else if (print_quoted
&& CONSP (XCDR (obj
)) && NILP (XCDR (XCDR (obj
)))
1583 && (EQ (XCAR (obj
), Qquote
)))
1586 print_object (XCAR (XCDR (obj
)), printcharfun
, escapeflag
);
1588 else if (print_quoted
&& CONSP (XCDR (obj
)) && NILP (XCDR (XCDR (obj
)))
1589 && (EQ (XCAR (obj
), Qfunction
)))
1593 print_object (XCAR (XCDR (obj
)), printcharfun
, escapeflag
);
1595 else if (print_quoted
&& CONSP (XCDR (obj
)) && NILP (XCDR (XCDR (obj
)))
1596 && ((EQ (XCAR (obj
), Qbackquote
))))
1598 print_object (XCAR (obj
), printcharfun
, 0);
1599 new_backquote_output
++;
1600 print_object (XCAR (XCDR (obj
)), printcharfun
, escapeflag
);
1601 new_backquote_output
--;
1603 else if (print_quoted
&& CONSP (XCDR (obj
)) && NILP (XCDR (XCDR (obj
)))
1604 && new_backquote_output
1605 && ((EQ (XCAR (obj
), Qbackquote
)
1606 || EQ (XCAR (obj
), Qcomma
)
1607 || EQ (XCAR (obj
), Qcomma_at
)
1608 || EQ (XCAR (obj
), Qcomma_dot
))))
1610 print_object (XCAR (obj
), printcharfun
, 0);
1611 new_backquote_output
--;
1612 print_object (XCAR (XCDR (obj
)), printcharfun
, escapeflag
);
1613 new_backquote_output
++;
1620 printmax_t i
, print_length
;
1621 Lisp_Object halftail
= obj
;
1623 /* Negative values of print-length are invalid in CL.
1624 Treat them like nil, as CMUCL does. */
1625 if (NATNUMP (Vprint_length
))
1626 print_length
= XFASTINT (Vprint_length
);
1628 print_length
= TYPE_MAXIMUM (printmax_t
);
1633 /* Detect circular list. */
1634 if (NILP (Vprint_circle
))
1636 /* Simple but incomplete way. */
1637 if (i
!= 0 && EQ (obj
, halftail
))
1639 int len
= sprintf (buf
, " . #%"pMd
, i
/ 2);
1640 strout (buf
, len
, len
, printcharfun
);
1646 /* With the print-circle feature. */
1649 Lisp_Object num
= Fgethash (obj
, Vprint_number_table
, Qnil
);
1652 strout (" . ", 3, 3, printcharfun
);
1653 print_object (obj
, printcharfun
, escapeflag
);
1662 if (print_length
<= i
)
1664 strout ("...", 3, 3, printcharfun
);
1669 print_object (XCAR (obj
), printcharfun
, escapeflag
);
1673 halftail
= XCDR (halftail
);
1677 /* OBJ non-nil here means it's the end of a dotted list. */
1680 strout (" . ", 3, 3, printcharfun
);
1681 print_object (obj
, printcharfun
, escapeflag
);
1689 case Lisp_Vectorlike
:
1694 strout ("#<process ", -1, -1, printcharfun
);
1695 print_string (XPROCESS (obj
)->name
, printcharfun
);
1699 print_string (XPROCESS (obj
)->name
, printcharfun
);
1701 else if (BOOL_VECTOR_P (obj
))
1706 struct gcpro gcpro1
;
1707 ptrdiff_t size_in_chars
1708 = ((XBOOL_VECTOR (obj
)->size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1)
1709 / BOOL_VECTOR_BITS_PER_CHAR
);
1715 len
= sprintf (buf
, "%"pI
"d", XBOOL_VECTOR (obj
)->size
);
1716 strout (buf
, len
, len
, printcharfun
);
1719 /* Don't print more characters than the specified maximum.
1720 Negative values of print-length are invalid. Treat them
1721 like a print-length of nil. */
1722 if (NATNUMP (Vprint_length
)
1723 && XFASTINT (Vprint_length
) < size_in_chars
)
1724 size_in_chars
= XFASTINT (Vprint_length
);
1726 for (i
= 0; i
< size_in_chars
; i
++)
1729 c
= XBOOL_VECTOR (obj
)->data
[i
];
1730 if (c
== '\n' && print_escape_newlines
)
1735 else if (c
== '\f' && print_escape_newlines
)
1740 else if (c
> '\177')
1742 /* Use octal escapes to avoid encoding issues. */
1744 PRINTCHAR ('0' + ((c
>> 6) & 3));
1745 PRINTCHAR ('0' + ((c
>> 3) & 7));
1746 PRINTCHAR ('0' + (c
& 7));
1750 if (c
== '\"' || c
== '\\')
1759 else if (SUBRP (obj
))
1761 strout ("#<subr ", -1, -1, printcharfun
);
1762 strout (XSUBR (obj
)->symbol_name
, -1, -1, printcharfun
);
1765 else if (WINDOWP (obj
))
1768 strout ("#<window ", -1, -1, printcharfun
);
1769 len
= sprintf (buf
, "%p", XWINDOW (obj
));
1770 strout (buf
, len
, len
, printcharfun
);
1771 if (!NILP (XWINDOW (obj
)->buffer
))
1773 strout (" on ", -1, -1, printcharfun
);
1774 print_string (BVAR (XBUFFER (XWINDOW (obj
)->buffer
), name
),
1779 else if (TERMINALP (obj
))
1782 struct terminal
*t
= XTERMINAL (obj
);
1783 strout ("#<terminal ", -1, -1, printcharfun
);
1784 len
= sprintf (buf
, "%d", t
->id
);
1785 strout (buf
, len
, len
, printcharfun
);
1788 strout (" on ", -1, -1, printcharfun
);
1789 strout (t
->name
, -1, -1, printcharfun
);
1793 else if (HASH_TABLE_P (obj
))
1795 struct Lisp_Hash_Table
*h
= XHASH_TABLE (obj
);
1797 ptrdiff_t real_size
, size
;
1800 strout ("#<hash-table", -1, -1, printcharfun
);
1801 if (SYMBOLP (h
->test
))
1805 strout (SDATA (SYMBOL_NAME (h
->test
)), -1, -1, printcharfun
);
1807 strout (SDATA (SYMBOL_NAME (h
->weak
)), -1, -1, printcharfun
);
1809 len
= sprintf (buf
, "%"pD
"d/%"pD
"d", h
->count
, ASIZE (h
->next
));
1810 strout (buf
, len
, len
, printcharfun
);
1812 len
= sprintf (buf
, " %p", h
);
1813 strout (buf
, len
, len
, printcharfun
);
1816 /* Implement a readable output, e.g.:
1817 #s(hash-table size 2 test equal data (k1 v1 k2 v2)) */
1818 /* Always print the size. */
1819 len
= sprintf (buf
, "#s(hash-table size %"pD
"d", ASIZE (h
->next
));
1820 strout (buf
, len
, len
, printcharfun
);
1822 if (!NILP (h
->test
.name
))
1824 strout (" test ", -1, -1, printcharfun
);
1825 print_object (h
->test
.name
, printcharfun
, escapeflag
);
1828 if (!NILP (h
->weak
))
1830 strout (" weakness ", -1, -1, printcharfun
);
1831 print_object (h
->weak
, printcharfun
, escapeflag
);
1834 if (!NILP (h
->rehash_size
))
1836 strout (" rehash-size ", -1, -1, printcharfun
);
1837 print_object (h
->rehash_size
, printcharfun
, escapeflag
);
1840 if (!NILP (h
->rehash_threshold
))
1842 strout (" rehash-threshold ", -1, -1, printcharfun
);
1843 print_object (h
->rehash_threshold
, printcharfun
, escapeflag
);
1846 strout (" data ", -1, -1, printcharfun
);
1848 /* Print the data here as a plist. */
1849 real_size
= HASH_TABLE_SIZE (h
);
1852 /* Don't print more elements than the specified maximum. */
1853 if (NATNUMP (Vprint_length
)
1854 && XFASTINT (Vprint_length
) < size
)
1855 size
= XFASTINT (Vprint_length
);
1858 for (i
= 0; i
< size
; i
++)
1859 if (!NILP (HASH_HASH (h
, i
)))
1861 if (i
) PRINTCHAR (' ');
1862 print_object (HASH_KEY (h
, i
), printcharfun
, escapeflag
);
1864 print_object (HASH_VALUE (h
, i
), printcharfun
, escapeflag
);
1867 if (size
< real_size
)
1868 strout (" ...", 4, 4, printcharfun
);
1874 else if (BUFFERP (obj
))
1876 if (!BUFFER_LIVE_P (XBUFFER (obj
)))
1877 strout ("#<killed buffer>", -1, -1, printcharfun
);
1878 else if (escapeflag
)
1880 strout ("#<buffer ", -1, -1, printcharfun
);
1881 print_string (BVAR (XBUFFER (obj
), name
), printcharfun
);
1885 print_string (BVAR (XBUFFER (obj
), name
), printcharfun
);
1887 else if (WINDOW_CONFIGURATIONP (obj
))
1889 strout ("#<window-configuration>", -1, -1, printcharfun
);
1891 else if (FRAMEP (obj
))
1894 Lisp_Object frame_name
= XFRAME (obj
)->name
;
1896 strout ((FRAME_LIVE_P (XFRAME (obj
))
1897 ? "#<frame " : "#<dead frame "),
1898 -1, -1, printcharfun
);
1899 if (!STRINGP (frame_name
))
1901 /* A frame could be too young and have no name yet;
1903 if (SYMBOLP (frame_name
))
1904 frame_name
= Fsymbol_name (frame_name
);
1905 else /* can't happen: name should be either nil or string */
1906 frame_name
= build_string ("*INVALID*FRAME*NAME*");
1908 print_string (frame_name
, printcharfun
);
1909 len
= sprintf (buf
, " %p", XFRAME (obj
));
1910 strout (buf
, len
, len
, printcharfun
);
1913 else if (FONTP (obj
))
1917 if (! FONT_OBJECT_P (obj
))
1919 if (FONT_SPEC_P (obj
))
1920 strout ("#<font-spec", -1, -1, printcharfun
);
1922 strout ("#<font-entity", -1, -1, printcharfun
);
1923 for (i
= 0; i
< FONT_SPEC_MAX
; i
++)
1926 if (i
< FONT_WEIGHT_INDEX
|| i
> FONT_WIDTH_INDEX
)
1927 print_object (AREF (obj
, i
), printcharfun
, escapeflag
);
1929 print_object (font_style_symbolic (obj
, i
, 0),
1930 printcharfun
, escapeflag
);
1935 strout ("#<font-object ", -1, -1, printcharfun
);
1936 print_object (AREF (obj
, FONT_NAME_INDEX
), printcharfun
,
1943 ptrdiff_t size
= ASIZE (obj
);
1944 if (COMPILEDP (obj
))
1947 size
&= PSEUDOVECTOR_SIZE_MASK
;
1949 if (CHAR_TABLE_P (obj
) || SUB_CHAR_TABLE_P (obj
))
1951 /* We print a char-table as if it were a vector,
1952 lumping the parent and default slots in with the
1953 character slots. But we add #^ as a prefix. */
1955 /* Make each lowest sub_char_table start a new line.
1956 Otherwise we'll make a line extremely long, which
1957 results in slow redisplay. */
1958 if (SUB_CHAR_TABLE_P (obj
)
1959 && XINT (XSUB_CHAR_TABLE (obj
)->depth
) == 3)
1963 if (SUB_CHAR_TABLE_P (obj
))
1965 size
&= PSEUDOVECTOR_SIZE_MASK
;
1967 if (size
& PSEUDOVECTOR_FLAG
)
1973 register Lisp_Object tem
;
1974 ptrdiff_t real_size
= size
;
1976 /* Don't print more elements than the specified maximum. */
1977 if (NATNUMP (Vprint_length
)
1978 && XFASTINT (Vprint_length
) < size
)
1979 size
= XFASTINT (Vprint_length
);
1981 for (i
= 0; i
< size
; i
++)
1983 if (i
) PRINTCHAR (' ');
1984 tem
= AREF (obj
, i
);
1985 print_object (tem
, printcharfun
, escapeflag
);
1987 if (size
< real_size
)
1988 strout (" ...", 4, 4, printcharfun
);
1995 switch (XMISCTYPE (obj
))
1997 case Lisp_Misc_Marker
:
1998 strout ("#<marker ", -1, -1, printcharfun
);
1999 /* Do you think this is necessary? */
2000 if (XMARKER (obj
)->insertion_type
!= 0)
2001 strout ("(moves after insertion) ", -1, -1, printcharfun
);
2002 if (! XMARKER (obj
)->buffer
)
2003 strout ("in no buffer", -1, -1, printcharfun
);
2006 int len
= sprintf (buf
, "at %"pD
"d", marker_position (obj
));
2007 strout (buf
, len
, len
, printcharfun
);
2008 strout (" in ", -1, -1, printcharfun
);
2009 print_string (BVAR (XMARKER (obj
)->buffer
, name
), printcharfun
);
2014 case Lisp_Misc_Overlay
:
2015 strout ("#<overlay ", -1, -1, printcharfun
);
2016 if (! XMARKER (OVERLAY_START (obj
))->buffer
)
2017 strout ("in no buffer", -1, -1, printcharfun
);
2020 int len
= sprintf (buf
, "from %"pD
"d to %"pD
"d in ",
2021 marker_position (OVERLAY_START (obj
)),
2022 marker_position (OVERLAY_END (obj
)));
2023 strout (buf
, len
, len
, printcharfun
);
2024 print_string (BVAR (XMARKER (OVERLAY_START (obj
))->buffer
, name
),
2030 /* Remaining cases shouldn't happen in normal usage, but let's
2031 print them anyway for the benefit of the debugger. */
2033 case Lisp_Misc_Free
:
2034 strout ("#<misc free cell>", -1, -1, printcharfun
);
2037 case Lisp_Misc_Save_Value
:
2040 struct Lisp_Save_Value
*v
= XSAVE_VALUE (obj
);
2042 strout ("#<save-value ", -1, -1, printcharfun
);
2046 ptrdiff_t amount
= v
->data
[1].integer
;
2050 /* If GC_MARK_STACK, valid_lisp_object_p is quite reliable,
2051 and so we try to print up to 8 objects we have saved.
2052 Although valid_lisp_object_p is slow, this shouldn't be
2053 a real bottleneck because we do not use this code under
2054 normal circumstances. */
2056 int limit
= min (amount
, 8);
2057 Lisp_Object
*area
= v
->data
[0].pointer
;
2059 i
= sprintf (buf
, "with %"pD
"d objects", amount
);
2060 strout (buf
, i
, i
, printcharfun
);
2062 for (i
= 0; i
< limit
; i
++)
2064 Lisp_Object maybe
= area
[i
];
2066 if (valid_lisp_object_p (maybe
) > 0)
2069 print_object (maybe
, printcharfun
, escapeflag
);
2072 strout (" <invalid>", -1, -1, printcharfun
);
2074 if (i
== limit
&& i
< amount
)
2075 strout (" ...", 4, 4, printcharfun
);
2077 #else /* not GC_MARK_STACK */
2079 /* If !GC_MARK_STACK, we have no reliable way to find
2080 whether Lisp_Object pointers points to an initialized
2081 objects, and so we do not ever trying to print them. */
2083 i
= sprintf (buf
, "with %"pD
"d objects", amount
);
2084 strout (buf
, i
, i
, printcharfun
);
2086 #endif /* GC_MARK_STACK */
2090 /* Print each `data[N]' slot according to its type. */
2092 #define PRINTX(index) \
2095 if (v->type ## index == SAVE_UNUSED) \
2096 i = sprintf (buf, "<unused>"); \
2097 else if (v->type ## index == SAVE_INTEGER) \
2098 i = sprintf (buf, "<integer %"pD"d>", v->data[index].integer); \
2099 else if (v->type ## index == SAVE_POINTER) \
2100 i = sprintf (buf, "<pointer %p>", v->data[index].pointer); \
2101 else /* SAVE_OBJECT */ \
2102 print_object (v->data[index].object, printcharfun, escapeflag); \
2104 strout (buf, i, i, printcharfun); \
2131 /* We're in trouble if this happens!
2132 Probably should just emacs_abort (). */
2133 strout ("#<EMACS BUG: INVALID DATATYPE ", -1, -1, printcharfun
);
2135 len
= sprintf (buf
, "(MISC 0x%04x)", (int) XMISCTYPE (obj
));
2136 else if (VECTORLIKEP (obj
))
2137 len
= sprintf (buf
, "(PVEC 0x%08"pD
"x)", ASIZE (obj
));
2139 len
= sprintf (buf
, "(0x%02x)", (int) XTYPE (obj
));
2140 strout (buf
, len
, len
, printcharfun
);
2141 strout (" Save your buffers immediately and please report this bug>",
2142 -1, -1, printcharfun
);
2150 /* Print a description of INTERVAL using PRINTCHARFUN.
2151 This is part of printing a string that has text properties. */
2154 print_interval (INTERVAL interval
, Lisp_Object printcharfun
)
2156 if (NILP (interval
->plist
))
2159 print_object (make_number (interval
->position
), printcharfun
, 1);
2161 print_object (make_number (interval
->position
+ LENGTH (interval
)),
2164 print_object (interval
->plist
, printcharfun
, 1);
2169 syms_of_print (void)
2171 DEFSYM (Qtemp_buffer_setup_hook
, "temp-buffer-setup-hook");
2173 DEFVAR_LISP ("standard-output", Vstandard_output
,
2174 doc
: /* Output stream `print' uses by default for outputting a character.
2175 This may be any function of one argument.
2176 It may also be a buffer (output is inserted before point)
2177 or a marker (output is inserted and the marker is advanced)
2178 or the symbol t (output appears in the echo area). */);
2179 Vstandard_output
= Qt
;
2180 DEFSYM (Qstandard_output
, "standard-output");
2182 DEFVAR_LISP ("float-output-format", Vfloat_output_format
,
2183 doc
: /* The format descriptor string used to print floats.
2184 This is a %-spec like those accepted by `printf' in C,
2185 but with some restrictions. It must start with the two characters `%.'.
2186 After that comes an integer precision specification,
2187 and then a letter which controls the format.
2188 The letters allowed are `e', `f' and `g'.
2189 Use `e' for exponential notation \"DIG.DIGITSeEXPT\"
2190 Use `f' for decimal point notation \"DIGITS.DIGITS\".
2191 Use `g' to choose the shorter of those two formats for the number at hand.
2192 The precision in any of these cases is the number of digits following
2193 the decimal point. With `f', a precision of 0 means to omit the
2194 decimal point. 0 is not allowed with `e' or `g'.
2196 A value of nil means to use the shortest notation
2197 that represents the number without losing information. */);
2198 Vfloat_output_format
= Qnil
;
2199 DEFSYM (Qfloat_output_format
, "float-output-format");
2201 DEFVAR_LISP ("print-length", Vprint_length
,
2202 doc
: /* Maximum length of list to print before abbreviating.
2203 A value of nil means no limit. See also `eval-expression-print-length'. */);
2204 Vprint_length
= Qnil
;
2206 DEFVAR_LISP ("print-level", Vprint_level
,
2207 doc
: /* Maximum depth of list nesting to print before abbreviating.
2208 A value of nil means no limit. See also `eval-expression-print-level'. */);
2209 Vprint_level
= Qnil
;
2211 DEFVAR_BOOL ("print-escape-newlines", print_escape_newlines
,
2212 doc
: /* Non-nil means print newlines in strings as `\\n'.
2213 Also print formfeeds as `\\f'. */);
2214 print_escape_newlines
= 0;
2216 DEFVAR_BOOL ("print-escape-nonascii", print_escape_nonascii
,
2217 doc
: /* Non-nil means print unibyte non-ASCII chars in strings as \\OOO.
2218 \(OOO is the octal representation of the character code.)
2219 Only single-byte characters are affected, and only in `prin1'.
2220 When the output goes in a multibyte buffer, this feature is
2221 enabled regardless of the value of the variable. */);
2222 print_escape_nonascii
= 0;
2224 DEFVAR_BOOL ("print-escape-multibyte", print_escape_multibyte
,
2225 doc
: /* Non-nil means print multibyte characters in strings as \\xXXXX.
2226 \(XXXX is the hex representation of the character code.)
2227 This affects only `prin1'. */);
2228 print_escape_multibyte
= 0;
2230 DEFVAR_BOOL ("print-quoted", print_quoted
,
2231 doc
: /* Non-nil means print quoted forms with reader syntax.
2232 I.e., (quote foo) prints as 'foo, (function foo) as #'foo. */);
2235 DEFVAR_LISP ("print-gensym", Vprint_gensym
,
2236 doc
: /* Non-nil means print uninterned symbols so they will read as uninterned.
2237 I.e., the value of (make-symbol \"foobar\") prints as #:foobar.
2238 When the uninterned symbol appears within a recursive data structure,
2239 and the symbol appears more than once, in addition use the #N# and #N=
2240 constructs as needed, so that multiple references to the same symbol are
2241 shared once again when the text is read back. */);
2242 Vprint_gensym
= Qnil
;
2244 DEFVAR_LISP ("print-circle", Vprint_circle
,
2245 doc
: /* Non-nil means print recursive structures using #N= and #N# syntax.
2246 If nil, printing proceeds recursively and may lead to
2247 `max-lisp-eval-depth' being exceeded or an error may occur:
2248 \"Apparently circular structure being printed.\" Also see
2249 `print-length' and `print-level'.
2250 If non-nil, shared substructures anywhere in the structure are printed
2251 with `#N=' before the first occurrence (in the order of the print
2252 representation) and `#N#' in place of each subsequent occurrence,
2253 where N is a positive decimal integer. */);
2254 Vprint_circle
= Qnil
;
2256 DEFVAR_LISP ("print-continuous-numbering", Vprint_continuous_numbering
,
2257 doc
: /* Non-nil means number continuously across print calls.
2258 This affects the numbers printed for #N= labels and #M# references.
2259 See also `print-circle', `print-gensym', and `print-number-table'.
2260 This variable should not be set with `setq'; bind it with a `let' instead. */);
2261 Vprint_continuous_numbering
= Qnil
;
2263 DEFVAR_LISP ("print-number-table", Vprint_number_table
,
2264 doc
: /* A vector used internally to produce `#N=' labels and `#N#' references.
2265 The Lisp printer uses this vector to detect Lisp objects referenced more
2268 When you bind `print-continuous-numbering' to t, you should probably
2269 also bind `print-number-table' to nil. This ensures that the value of
2270 `print-number-table' can be garbage-collected once the printing is
2271 done. If all elements of `print-number-table' are nil, it means that
2272 the printing done so far has not found any shared structure or objects
2273 that need to be recorded in the table. */);
2274 Vprint_number_table
= Qnil
;
2276 DEFVAR_LISP ("print-charset-text-property", Vprint_charset_text_property
,
2277 doc
: /* A flag to control printing of `charset' text property on printing a string.
2278 The value must be nil, t, or `default'.
2280 If the value is nil, don't print the text property `charset'.
2282 If the value is t, always print the text property `charset'.
2284 If the value is `default', print the text property `charset' only when
2285 the value is different from what is guessed in the current charset
2287 Vprint_charset_text_property
= Qdefault
;
2289 /* prin1_to_string_buffer initialized in init_buffer_once in buffer.c */
2290 staticpro (&Vprin1_to_string_buffer
);
2293 defsubr (&Sprin1_to_string
);
2294 defsubr (&Serror_message_string
);
2298 defsubr (&Swrite_char
);
2299 defsubr (&Sexternal_debugging_output
);
2300 #ifdef WITH_REDIRECT_DEBUGGING_OUTPUT
2301 defsubr (&Sredirect_debugging_output
);
2304 DEFSYM (Qexternal_debugging_output
, "external-debugging-output");
2305 DEFSYM (Qprint_escape_newlines
, "print-escape-newlines");
2306 DEFSYM (Qprint_escape_multibyte
, "print-escape-multibyte");
2307 DEFSYM (Qprint_escape_nonascii
, "print-escape-nonascii");
2309 print_prune_charset_plist
= Qnil
;
2310 staticpro (&print_prune_charset_plist
);