1 /* Lisp object printing and output streams.
2 Copyright (C) 1985, 1986, 1988, 1993, 1994, 1995, 1997,
3 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
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; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
33 #include "dispextern.h"
35 #include "intervals.h"
36 #include "blockinput.h"
37 #include "termhooks.h" /* For struct terminal. */
39 Lisp_Object Vstandard_output
, Qstandard_output
;
41 Lisp_Object Qtemp_buffer_setup_hook
;
43 /* These are used to print like we read. */
44 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
46 Lisp_Object Vfloat_output_format
, Qfloat_output_format
;
48 /* Work around a problem that happens because math.h on hpux 7
49 defines two static variables--which, in Emacs, are not really static,
50 because `static' is defined as nothing. The problem is that they are
51 defined both here and in lread.c.
52 These macros prevent the name conflict. */
53 #if defined (HPUX) && !defined (HPUX8)
54 #define _MAXLDBL print_maxldbl
55 #define _NMAXLDBL print_nmaxldbl
64 /* Default to values appropriate for IEEE floating point. */
69 #define DBL_MANT_DIG 53
75 #define DBL_MIN 2.2250738585072014e-308
78 #ifdef DBL_MIN_REPLACEMENT
80 #define DBL_MIN DBL_MIN_REPLACEMENT
83 /* Define DOUBLE_DIGITS_BOUND, an upper bound on the number of decimal digits
84 needed to express a float without losing information.
85 The general-case formula is valid for the usual case, IEEE floating point,
86 but many compilers can't optimize the formula to an integer constant,
87 so make a special case for it. */
88 #if FLT_RADIX == 2 && DBL_MANT_DIG == 53
89 #define DOUBLE_DIGITS_BOUND 17 /* IEEE floating point */
91 #define DOUBLE_DIGITS_BOUND ((int) ceil (log10 (pow (FLT_RADIX, DBL_MANT_DIG))))
94 /* Avoid actual stack overflow in print. */
97 /* Level of nesting inside outputting backquote in new style. */
98 int new_backquote_output
;
100 /* Detect most circularities to print finite output. */
101 #define PRINT_CIRCLE 200
102 Lisp_Object being_printed
[PRINT_CIRCLE
];
104 /* When printing into a buffer, first we put the text in this
105 block, then insert it all at once. */
108 /* Size allocated in print_buffer. */
109 int print_buffer_size
;
110 /* Chars stored in print_buffer. */
111 int print_buffer_pos
;
112 /* Bytes stored in print_buffer. */
113 int print_buffer_pos_byte
;
115 /* Maximum length of list to print in full; noninteger means
116 effectively infinity */
118 Lisp_Object Vprint_length
;
120 /* Maximum depth of list to print in full; noninteger means
121 effectively infinity. */
123 Lisp_Object Vprint_level
;
125 /* Nonzero means print newlines in strings as \n. */
127 int print_escape_newlines
;
129 /* Nonzero means to print single-byte non-ascii characters in strings as
132 int print_escape_nonascii
;
134 /* Nonzero means to print multibyte characters in strings as hex escapes. */
136 int print_escape_multibyte
;
138 Lisp_Object Qprint_escape_newlines
;
139 Lisp_Object Qprint_escape_multibyte
, Qprint_escape_nonascii
;
141 /* Nonzero means print (quote foo) forms as 'foo, etc. */
145 /* Non-nil means print #: before uninterned symbols. */
147 Lisp_Object Vprint_gensym
;
149 /* Non-nil means print recursive structures using #n= and #n# syntax. */
151 Lisp_Object Vprint_circle
;
153 /* Non-nil means keep continuous number for #n= and #n# syntax
154 between several print functions. */
156 Lisp_Object Vprint_continuous_numbering
;
158 /* Vprint_number_table is a vector like [OBJ1 STAT1 OBJ2 STAT2 ...],
159 where OBJn are objects going to be printed, and STATn are their status,
160 which may be different meanings during process. See the comments of
161 the functions print and print_preprocess for details.
162 print_number_index keeps the last position the next object should be added,
163 twice of which is the actual vector position in Vprint_number_table. */
164 int print_number_index
;
165 Lisp_Object Vprint_number_table
;
167 /* PRINT_NUMBER_OBJECT returns the I'th object in Vprint_number_table TABLE.
168 PRINT_NUMBER_STATUS returns the status of the I'th object in TABLE.
169 See the comment of the variable Vprint_number_table. */
170 #define PRINT_NUMBER_OBJECT(table,i) XVECTOR ((table))->contents[(i) * 2]
171 #define PRINT_NUMBER_STATUS(table,i) XVECTOR ((table))->contents[(i) * 2 + 1]
173 /* Nonzero means print newline to stdout before next minibuffer message.
174 Defined in xdisp.c */
176 extern int noninteractive_need_newline
;
178 extern int minibuffer_auto_raise
;
180 #ifdef MAX_PRINT_CHARS
181 static int print_chars
;
182 static int max_print
;
183 #endif /* MAX_PRINT_CHARS */
185 void print_interval ();
187 /* GDB resets this to zero on W32 to disable OutputDebugString calls. */
188 int print_output_debug_flag
= 1;
191 /* Low level output routines for characters and strings */
193 /* Lisp functions to do output using a stream
194 must have the stream in a variable called printcharfun
195 and must start with PRINTPREPARE, end with PRINTFINISH,
196 and use PRINTDECLARE to declare common variables.
197 Use PRINTCHAR to output one character,
198 or call strout to output a block of characters. */
200 #define PRINTDECLARE \
201 struct buffer *old = current_buffer; \
202 int old_point = -1, start_point = -1; \
203 int old_point_byte = -1, start_point_byte = -1; \
204 int specpdl_count = SPECPDL_INDEX (); \
205 int free_print_buffer = 0; \
206 int multibyte = !NILP (current_buffer->enable_multibyte_characters); \
209 #define PRINTPREPARE \
210 original = printcharfun; \
211 if (NILP (printcharfun)) printcharfun = Qt; \
212 if (BUFFERP (printcharfun)) \
214 if (XBUFFER (printcharfun) != current_buffer) \
215 Fset_buffer (printcharfun); \
216 printcharfun = Qnil; \
218 if (MARKERP (printcharfun)) \
220 EMACS_INT marker_pos; \
221 if (! XMARKER (printcharfun)->buffer) \
222 error ("Marker does not point anywhere"); \
223 if (XMARKER (printcharfun)->buffer != current_buffer) \
224 set_buffer_internal (XMARKER (printcharfun)->buffer); \
225 marker_pos = marker_position (printcharfun); \
226 if (marker_pos < BEGV || marker_pos > ZV) \
227 error ("Marker is outside the accessible part of the buffer"); \
229 old_point_byte = PT_BYTE; \
230 SET_PT_BOTH (marker_pos, \
231 marker_byte_position (printcharfun)); \
233 start_point_byte = PT_BYTE; \
234 printcharfun = Qnil; \
236 if (NILP (printcharfun)) \
238 Lisp_Object string; \
239 if (NILP (current_buffer->enable_multibyte_characters) \
240 && ! print_escape_multibyte) \
241 specbind (Qprint_escape_multibyte, Qt); \
242 if (! NILP (current_buffer->enable_multibyte_characters) \
243 && ! print_escape_nonascii) \
244 specbind (Qprint_escape_nonascii, Qt); \
245 if (print_buffer != 0) \
247 string = make_string_from_bytes (print_buffer, \
249 print_buffer_pos_byte); \
250 record_unwind_protect (print_unwind, string); \
254 print_buffer_size = 1000; \
255 print_buffer = (char *) xmalloc (print_buffer_size); \
256 free_print_buffer = 1; \
258 print_buffer_pos = 0; \
259 print_buffer_pos_byte = 0; \
261 if (EQ (printcharfun, Qt) && ! noninteractive) \
262 setup_echo_area_for_printing (multibyte);
264 #define PRINTFINISH \
265 if (NILP (printcharfun)) \
267 if (print_buffer_pos != print_buffer_pos_byte \
268 && NILP (current_buffer->enable_multibyte_characters)) \
270 unsigned char *temp \
271 = (unsigned char *) alloca (print_buffer_pos + 1); \
272 copy_text (print_buffer, temp, print_buffer_pos_byte, \
274 insert_1_both (temp, print_buffer_pos, \
275 print_buffer_pos, 0, 1, 0); \
278 insert_1_both (print_buffer, print_buffer_pos, \
279 print_buffer_pos_byte, 0, 1, 0); \
280 signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
282 if (free_print_buffer) \
284 xfree (print_buffer); \
287 unbind_to (specpdl_count, Qnil); \
288 if (MARKERP (original)) \
289 set_marker_both (original, Qnil, PT, PT_BYTE); \
290 if (old_point >= 0) \
291 SET_PT_BOTH (old_point + (old_point >= start_point \
292 ? PT - start_point : 0), \
293 old_point_byte + (old_point_byte >= start_point_byte \
294 ? PT_BYTE - start_point_byte : 0)); \
295 if (old != current_buffer) \
296 set_buffer_internal (old);
298 #define PRINTCHAR(ch) printchar (ch, printcharfun)
300 /* This is used to restore the saved contents of print_buffer
301 when there is a recursive call to print. */
304 print_unwind (saved_text
)
305 Lisp_Object saved_text
;
307 bcopy (SDATA (saved_text
), print_buffer
, SCHARS (saved_text
));
312 /* Print character CH using method FUN. FUN nil means print to
313 print_buffer. FUN t means print to echo area or stdout if
314 non-interactive. If FUN is neither nil nor t, call FUN with CH as
322 #ifdef MAX_PRINT_CHARS
325 #endif /* MAX_PRINT_CHARS */
327 if (!NILP (fun
) && !EQ (fun
, Qt
))
328 call1 (fun
, make_number (ch
));
331 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
332 int len
= CHAR_STRING (ch
, str
);
338 if (print_buffer_pos_byte
+ len
>= print_buffer_size
)
339 print_buffer
= (char *) xrealloc (print_buffer
,
340 print_buffer_size
*= 2);
341 bcopy (str
, print_buffer
+ print_buffer_pos_byte
, len
);
342 print_buffer_pos
+= 1;
343 print_buffer_pos_byte
+= len
;
345 else if (noninteractive
)
347 fwrite (str
, 1, len
, stdout
);
348 noninteractive_need_newline
= 1;
353 = !NILP (current_buffer
->enable_multibyte_characters
);
355 setup_echo_area_for_printing (multibyte_p
);
357 message_dolog (str
, len
, 0, multibyte_p
);
363 /* Output SIZE characters, SIZE_BYTE bytes from string PTR using
364 method PRINTCHARFUN. If SIZE < 0, use the string length of PTR for
365 both SIZE and SIZE_BYTE. PRINTCHARFUN nil means output to
366 print_buffer. PRINTCHARFUN t means output to the echo area or to
367 stdout if non-interactive. If neither nil nor t, call Lisp
368 function PRINTCHARFUN for each character printed. MULTIBYTE
369 non-zero means PTR contains multibyte characters.
371 In the case where PRINTCHARFUN is nil, it is safe for PTR to point
372 to data in a Lisp string. Otherwise that is not safe. */
375 strout (ptr
, size
, size_byte
, printcharfun
, multibyte
)
378 Lisp_Object printcharfun
;
382 size_byte
= size
= strlen (ptr
);
384 if (NILP (printcharfun
))
386 if (print_buffer_pos_byte
+ size_byte
> print_buffer_size
)
388 print_buffer_size
= print_buffer_size
* 2 + size_byte
;
389 print_buffer
= (char *) xrealloc (print_buffer
,
392 bcopy (ptr
, print_buffer
+ print_buffer_pos_byte
, size_byte
);
393 print_buffer_pos
+= size
;
394 print_buffer_pos_byte
+= size_byte
;
396 #ifdef MAX_PRINT_CHARS
399 #endif /* MAX_PRINT_CHARS */
401 else if (noninteractive
&& EQ (printcharfun
, Qt
))
403 fwrite (ptr
, 1, size_byte
, stdout
);
404 noninteractive_need_newline
= 1;
406 else if (EQ (printcharfun
, Qt
))
408 /* Output to echo area. We're trying to avoid a little overhead
409 here, that's the reason we don't call printchar to do the
413 = !NILP (current_buffer
->enable_multibyte_characters
);
415 setup_echo_area_for_printing (multibyte_p
);
416 message_dolog (ptr
, size_byte
, 0, multibyte_p
);
418 if (size
== size_byte
)
420 for (i
= 0; i
< size
; ++i
)
421 insert_char ((unsigned char) *ptr
++);
426 for (i
= 0; i
< size_byte
; i
+= len
)
428 int ch
= STRING_CHAR_AND_LENGTH (ptr
+ i
, size_byte
- i
, len
);
433 #ifdef MAX_PRINT_CHARS
436 #endif /* MAX_PRINT_CHARS */
440 /* PRINTCHARFUN is a Lisp function. */
443 if (size
== size_byte
)
445 while (i
< size_byte
)
453 while (i
< size_byte
)
455 /* Here, we must convert each multi-byte form to the
456 corresponding character code before handing it to
459 int ch
= STRING_CHAR_AND_LENGTH (ptr
+ i
, size_byte
- i
, len
);
467 /* Print the contents of a string STRING using PRINTCHARFUN.
468 It isn't safe to use strout in many cases,
469 because printing one char can relocate. */
472 print_string (string
, printcharfun
)
474 Lisp_Object printcharfun
;
476 if (EQ (printcharfun
, Qt
) || NILP (printcharfun
))
480 if (STRING_MULTIBYTE (string
))
481 chars
= SCHARS (string
);
482 else if (EQ (printcharfun
, Qt
)
483 ? ! NILP (buffer_defaults
.enable_multibyte_characters
)
484 : ! NILP (current_buffer
->enable_multibyte_characters
))
486 /* If unibyte string STRING contains 8-bit codes, we must
487 convert STRING to a multibyte string containing the same
492 chars
= SBYTES (string
);
493 bytes
= parse_str_to_multibyte (SDATA (string
), chars
);
496 newstr
= make_uninit_multibyte_string (chars
, bytes
);
497 bcopy (SDATA (string
), SDATA (newstr
), chars
);
498 str_to_multibyte (SDATA (newstr
), bytes
, chars
);
503 chars
= SBYTES (string
);
505 if (EQ (printcharfun
, Qt
))
507 /* Output to echo area. */
508 int nbytes
= SBYTES (string
);
511 /* Copy the string contents so that relocation of STRING by
512 GC does not cause trouble. */
515 SAFE_ALLOCA (buffer
, char *, nbytes
);
516 bcopy (SDATA (string
), buffer
, nbytes
);
518 strout (buffer
, chars
, SBYTES (string
),
519 printcharfun
, STRING_MULTIBYTE (string
));
524 /* No need to copy, since output to print_buffer can't GC. */
525 strout (SDATA (string
),
526 chars
, SBYTES (string
),
527 printcharfun
, STRING_MULTIBYTE (string
));
531 /* Otherwise, string may be relocated by printing one char.
532 So re-fetch the string address for each character. */
534 int size
= SCHARS (string
);
535 int size_byte
= SBYTES (string
);
538 if (size
== size_byte
)
539 for (i
= 0; i
< size
; i
++)
540 PRINTCHAR (SREF (string
, i
));
542 for (i
= 0; i
< size_byte
; )
544 /* Here, we must convert each multi-byte form to the
545 corresponding character code before handing it to PRINTCHAR. */
547 int ch
= STRING_CHAR_AND_LENGTH (SDATA (string
) + i
,
549 if (!CHAR_VALID_P (ch
, 0))
551 ch
= SREF (string
, i
);
561 DEFUN ("write-char", Fwrite_char
, Swrite_char
, 1, 2, 0,
562 doc
: /* Output character CHARACTER to stream PRINTCHARFUN.
563 PRINTCHARFUN defaults to the value of `standard-output' (which see). */)
564 (character
, printcharfun
)
565 Lisp_Object character
, printcharfun
;
569 if (NILP (printcharfun
))
570 printcharfun
= Vstandard_output
;
571 CHECK_NUMBER (character
);
573 PRINTCHAR (XINT (character
));
578 /* Used from outside of print.c to print a block of SIZE
579 single-byte chars at DATA on the default output stream.
580 Do not use this on the contents of a Lisp string. */
583 write_string (data
, size
)
588 Lisp_Object printcharfun
;
590 printcharfun
= Vstandard_output
;
593 strout (data
, size
, size
, printcharfun
, 0);
597 /* Used from outside of print.c to print a block of SIZE
598 single-byte chars at DATA on a specified stream PRINTCHARFUN.
599 Do not use this on the contents of a Lisp string. */
602 write_string_1 (data
, size
, printcharfun
)
605 Lisp_Object printcharfun
;
610 strout (data
, size
, size
, printcharfun
, 0);
616 temp_output_buffer_setup (bufname
)
619 int count
= SPECPDL_INDEX ();
620 register struct buffer
*old
= current_buffer
;
621 register Lisp_Object buf
;
623 record_unwind_protect (set_buffer_if_live
, Fcurrent_buffer ());
625 Fset_buffer (Fget_buffer_create (build_string (bufname
)));
627 Fkill_all_local_variables ();
628 delete_all_overlays (current_buffer
);
629 current_buffer
->directory
= old
->directory
;
630 current_buffer
->read_only
= Qnil
;
631 current_buffer
->filename
= Qnil
;
632 current_buffer
->undo_list
= Qt
;
633 eassert (current_buffer
->overlays_before
== NULL
);
634 eassert (current_buffer
->overlays_after
== NULL
);
635 current_buffer
->enable_multibyte_characters
636 = buffer_defaults
.enable_multibyte_characters
;
637 specbind (Qinhibit_read_only
, Qt
);
638 specbind (Qinhibit_modification_hooks
, Qt
);
640 XSETBUFFER (buf
, current_buffer
);
642 Frun_hooks (1, &Qtemp_buffer_setup_hook
);
644 unbind_to (count
, Qnil
);
646 specbind (Qstandard_output
, buf
);
650 internal_with_output_to_temp_buffer (bufname
, function
, args
)
652 Lisp_Object (*function
) P_ ((Lisp_Object
));
655 int count
= SPECPDL_INDEX ();
656 Lisp_Object buf
, val
;
660 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
661 temp_output_buffer_setup (bufname
);
662 buf
= Vstandard_output
;
665 val
= (*function
) (args
);
668 temp_output_buffer_show (buf
);
671 return unbind_to (count
, val
);
674 DEFUN ("with-output-to-temp-buffer",
675 Fwith_output_to_temp_buffer
, Swith_output_to_temp_buffer
,
677 doc
: /* Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
679 This construct makes buffer BUFNAME empty before running BODY.
680 It does not make the buffer current for BODY.
681 Instead it binds `standard-output' to that buffer, so that output
682 generated with `prin1' and similar functions in BODY goes into
685 At the end of BODY, this marks buffer BUFNAME unmodifed and displays
686 it in a window, but does not select it. The normal way to do this is
687 by calling `display-buffer', then running `temp-buffer-show-hook'.
688 However, if `temp-buffer-show-function' is non-nil, it calls that
689 function instead (and does not run `temp-buffer-show-hook'). The
690 function gets one argument, the buffer to display.
692 The return value of `with-output-to-temp-buffer' is the value of the
693 last form in BODY. If BODY does not finish normally, the buffer
694 BUFNAME is not displayed.
696 This runs the hook `temp-buffer-setup-hook' before BODY,
697 with the buffer BUFNAME temporarily current. It runs the hook
698 `temp-buffer-show-hook' after displaying buffer BUFNAME, with that
699 buffer temporarily current, and the window that was used to display it
700 temporarily selected. But it doesn't run `temp-buffer-show-hook'
701 if it uses `temp-buffer-show-function'.
703 usage: (with-output-to-temp-buffer BUFNAME BODY...) */)
709 int count
= SPECPDL_INDEX ();
710 Lisp_Object buf
, val
;
713 name
= Feval (Fcar (args
));
715 temp_output_buffer_setup (SDATA (name
));
716 buf
= Vstandard_output
;
719 val
= Fprogn (XCDR (args
));
722 temp_output_buffer_show (buf
);
725 return unbind_to (count
, val
);
729 static void print ();
730 static void print_preprocess ();
731 static void print_preprocess_string ();
732 static void print_object ();
734 DEFUN ("terpri", Fterpri
, Sterpri
, 0, 1, 0,
735 doc
: /* Output a newline to stream PRINTCHARFUN.
736 If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used. */)
738 Lisp_Object printcharfun
;
742 if (NILP (printcharfun
))
743 printcharfun
= Vstandard_output
;
750 DEFUN ("prin1", Fprin1
, Sprin1
, 1, 2, 0,
751 doc
: /* Output the printed representation of OBJECT, any Lisp object.
752 Quoting characters are printed when needed to make output that `read'
753 can handle, whenever this is possible. For complex objects, the behavior
754 is controlled by `print-level' and `print-length', which see.
756 OBJECT is any of the Lisp data types: a number, a string, a symbol,
757 a list, a buffer, a window, a frame, etc.
759 A printed representation of an object is text which describes that object.
761 Optional argument PRINTCHARFUN is the output stream, which can be one
764 - a buffer, in which case output is inserted into that buffer at point;
765 - a marker, in which case output is inserted at marker's position;
766 - a function, in which case that function is called once for each
767 character of OBJECT's printed representation;
768 - a symbol, in which case that symbol's function definition is called; or
769 - t, in which case the output is displayed in the echo area.
771 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
773 (object
, printcharfun
)
774 Lisp_Object object
, printcharfun
;
778 #ifdef MAX_PRINT_CHARS
780 #endif /* MAX_PRINT_CHARS */
781 if (NILP (printcharfun
))
782 printcharfun
= Vstandard_output
;
784 print (object
, printcharfun
, 1);
789 /* a buffer which is used to hold output being built by prin1-to-string */
790 Lisp_Object Vprin1_to_string_buffer
;
792 DEFUN ("prin1-to-string", Fprin1_to_string
, Sprin1_to_string
, 1, 2, 0,
793 doc
: /* Return a string containing the printed representation of OBJECT.
794 OBJECT can be any Lisp object. This function outputs quoting characters
795 when necessary to make output that `read' can handle, whenever possible,
796 unless the optional second argument NOESCAPE is non-nil. For complex objects,
797 the behavior is controlled by `print-level' and `print-length', which see.
799 OBJECT is any of the Lisp data types: a number, a string, a symbol,
800 a list, a buffer, a window, a frame, etc.
802 A printed representation of an object is text which describes that object. */)
804 Lisp_Object object
, noescape
;
806 Lisp_Object printcharfun
;
807 /* struct gcpro gcpro1, gcpro2; */
808 Lisp_Object save_deactivate_mark
;
809 int count
= SPECPDL_INDEX ();
810 struct buffer
*previous
;
812 specbind (Qinhibit_modification_hooks
, Qt
);
817 /* Save and restore this--we are altering a buffer
818 but we don't want to deactivate the mark just for that.
819 No need for specbind, since errors deactivate the mark. */
820 save_deactivate_mark
= Vdeactivate_mark
;
821 /* GCPRO2 (object, save_deactivate_mark); */
824 printcharfun
= Vprin1_to_string_buffer
;
826 print (object
, printcharfun
, NILP (noescape
));
827 /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
831 previous
= current_buffer
;
832 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer
));
833 object
= Fbuffer_string ();
834 if (SBYTES (object
) == SCHARS (object
))
835 STRING_SET_UNIBYTE (object
);
837 /* Note that this won't make prepare_to_modify_buffer call
838 ask-user-about-supersession-threat because this buffer
839 does not visit a file. */
841 set_buffer_internal (previous
);
843 Vdeactivate_mark
= save_deactivate_mark
;
847 return unbind_to (count
, object
);
850 DEFUN ("princ", Fprinc
, Sprinc
, 1, 2, 0,
851 doc
: /* Output the printed representation of OBJECT, any Lisp object.
852 No quoting characters are used; no delimiters are printed around
853 the contents of strings.
855 OBJECT is any of the Lisp data types: a number, a string, a symbol,
856 a list, a buffer, a window, a frame, etc.
858 A printed representation of an object is text which describes that object.
860 Optional argument PRINTCHARFUN is the output stream, which can be one
863 - a buffer, in which case output is inserted into that buffer at point;
864 - a marker, in which case output is inserted at marker's position;
865 - a function, in which case that function is called once for each
866 character of OBJECT's printed representation;
867 - a symbol, in which case that symbol's function definition is called; or
868 - t, in which case the output is displayed in the echo area.
870 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
872 (object
, printcharfun
)
873 Lisp_Object object
, printcharfun
;
877 if (NILP (printcharfun
))
878 printcharfun
= Vstandard_output
;
880 print (object
, printcharfun
, 0);
885 DEFUN ("print", Fprint
, Sprint
, 1, 2, 0,
886 doc
: /* Output the printed representation of OBJECT, with newlines around it.
887 Quoting characters are printed when needed to make output that `read'
888 can handle, whenever this is possible. For complex objects, the behavior
889 is controlled by `print-level' and `print-length', which see.
891 OBJECT is any of the Lisp data types: a number, a string, a symbol,
892 a list, a buffer, a window, a frame, etc.
894 A printed representation of an object is text which describes that object.
896 Optional argument PRINTCHARFUN is the output stream, which can be one
899 - a buffer, in which case output is inserted into that buffer at point;
900 - a marker, in which case output is inserted at marker's position;
901 - a function, in which case that function is called once for each
902 character of OBJECT's printed representation;
903 - a symbol, in which case that symbol's function definition is called; or
904 - t, in which case the output is displayed in the echo area.
906 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
908 (object
, printcharfun
)
909 Lisp_Object object
, printcharfun
;
914 #ifdef MAX_PRINT_CHARS
916 max_print
= MAX_PRINT_CHARS
;
917 #endif /* MAX_PRINT_CHARS */
918 if (NILP (printcharfun
))
919 printcharfun
= Vstandard_output
;
923 print (object
, printcharfun
, 1);
926 #ifdef MAX_PRINT_CHARS
929 #endif /* MAX_PRINT_CHARS */
934 /* The subroutine object for external-debugging-output is kept here
935 for the convenience of the debugger. */
936 Lisp_Object Qexternal_debugging_output
;
938 DEFUN ("external-debugging-output", Fexternal_debugging_output
, Sexternal_debugging_output
, 1, 1, 0,
939 doc
: /* Write CHARACTER to stderr.
940 You can call print while debugging emacs, and pass it this function
941 to make it write to the debugging output. */)
943 Lisp_Object character
;
945 CHECK_NUMBER (character
);
946 putc (XINT (character
), stderr
);
949 /* Send the output to a debugger (nothing happens if there isn't one). */
950 if (print_output_debug_flag
)
952 char buf
[2] = {(char) XINT (character
), '\0'};
953 OutputDebugString (buf
);
960 /* This function is never called. Its purpose is to prevent
961 print_output_debug_flag from being optimized away. */
964 debug_output_compilation_hack (x
)
967 print_output_debug_flag
= x
;
970 #if defined (GNU_LINUX)
972 /* This functionality is not vitally important in general, so we rely on
973 non-portable ability to use stderr as lvalue. */
975 #define WITH_REDIRECT_DEBUGGING_OUTPUT 1
977 FILE *initial_stderr_stream
= NULL
;
979 DEFUN ("redirect-debugging-output", Fredirect_debugging_output
, Sredirect_debugging_output
,
981 "FDebug output file: \nP",
982 doc
: /* Redirect debugging output (stderr stream) to file FILE.
983 If FILE is nil, reset target to the initial stderr stream.
984 Optional arg APPEND non-nil (interactively, with prefix arg) means
985 append to existing target file. */)
987 Lisp_Object file
, append
;
989 if (initial_stderr_stream
!= NULL
)
995 stderr
= initial_stderr_stream
;
996 initial_stderr_stream
= NULL
;
1000 file
= Fexpand_file_name (file
, Qnil
);
1001 initial_stderr_stream
= stderr
;
1002 stderr
= fopen (SDATA (file
), NILP (append
) ? "w" : "a");
1005 stderr
= initial_stderr_stream
;
1006 initial_stderr_stream
= NULL
;
1007 report_file_error ("Cannot open debugging output stream",
1008 Fcons (file
, Qnil
));
1013 #endif /* GNU_LINUX */
1016 /* This is the interface for debugging printing. */
1022 Fprin1 (arg
, Qexternal_debugging_output
);
1023 fprintf (stderr
, "\r\n");
1027 safe_debug_print (arg
)
1030 int valid
= valid_lisp_object_p (arg
);
1035 fprintf (stderr
, "#<%s_LISP_OBJECT 0x%08lx>\r\n",
1036 !valid
? "INVALID" : "SOME",
1037 (unsigned long) XHASH (arg
)
1042 DEFUN ("error-message-string", Ferror_message_string
, Serror_message_string
,
1044 doc
: /* Convert an error value (ERROR-SYMBOL . DATA) to an error message.
1045 See Info anchor `(elisp)Definition of signal' for some details on how this
1046 error message is constructed. */)
1050 struct buffer
*old
= current_buffer
;
1052 struct gcpro gcpro1
;
1054 /* If OBJ is (error STRING), just return STRING.
1055 That is not only faster, it also avoids the need to allocate
1056 space here when the error is due to memory full. */
1057 if (CONSP (obj
) && EQ (XCAR (obj
), Qerror
)
1058 && CONSP (XCDR (obj
))
1059 && STRINGP (XCAR (XCDR (obj
)))
1060 && NILP (XCDR (XCDR (obj
))))
1061 return XCAR (XCDR (obj
));
1063 print_error_message (obj
, Vprin1_to_string_buffer
, 0, Qnil
);
1065 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer
));
1066 value
= Fbuffer_string ();
1070 set_buffer_internal (old
);
1076 /* Print an error message for the error DATA onto Lisp output stream
1077 STREAM (suitable for the print functions).
1078 CONTEXT is a C string describing the context of the error.
1079 CALLER is the Lisp function inside which the error was signaled. */
1082 print_error_message (data
, stream
, context
, caller
)
1083 Lisp_Object data
, stream
;
1087 Lisp_Object errname
, errmsg
, file_error
, tail
;
1088 struct gcpro gcpro1
;
1092 write_string_1 (context
, -1, stream
);
1094 /* If we know from where the error was signaled, show it in
1096 if (!NILP (caller
) && SYMBOLP (caller
))
1098 Lisp_Object cname
= SYMBOL_NAME (caller
);
1099 char *name
= alloca (SBYTES (cname
));
1100 bcopy (SDATA (cname
), name
, SBYTES (cname
));
1101 message_dolog (name
, SBYTES (cname
), 0, 0);
1102 message_dolog (": ", 2, 0, 0);
1105 errname
= Fcar (data
);
1107 if (EQ (errname
, Qerror
))
1112 errmsg
= Fcar (data
);
1117 Lisp_Object error_conditions
;
1118 errmsg
= Fget (errname
, Qerror_message
);
1119 error_conditions
= Fget (errname
, Qerror_conditions
);
1120 file_error
= Fmemq (Qfile_error
, error_conditions
);
1123 /* Print an error message including the data items. */
1125 tail
= Fcdr_safe (data
);
1128 /* For file-error, make error message by concatenating
1129 all the data items. They are all strings. */
1130 if (!NILP (file_error
) && CONSP (tail
))
1131 errmsg
= XCAR (tail
), tail
= XCDR (tail
);
1133 if (STRINGP (errmsg
))
1134 Fprinc (errmsg
, stream
);
1136 write_string_1 ("peculiar error", -1, stream
);
1138 for (i
= 0; CONSP (tail
); tail
= XCDR (tail
), i
++)
1142 write_string_1 (i
? ", " : ": ", 2, stream
);
1144 if (!NILP (file_error
) || EQ (errname
, Qend_of_file
))
1145 Fprinc (obj
, stream
);
1147 Fprin1 (obj
, stream
);
1156 * The buffer should be at least as large as the max string size of the
1157 * largest float, printed in the biggest notation. This is undoubtedly
1158 * 20d float_output_format, with the negative of the C-constant "HUGE"
1161 * On the vax the worst case is -1e38 in 20d format which takes 61 bytes.
1163 * I assume that IEEE-754 format numbers can take 329 bytes for the worst
1164 * case of -1e307 in 20d float_output_format. What is one to do (short of
1165 * re-writing _doprnt to be more sane)?
1170 float_to_string (buf
, data
)
1177 /* Check for plus infinity in a way that won't lose
1178 if there is no plus infinity. */
1179 if (data
== data
/ 2 && data
> 1.0)
1181 strcpy (buf
, "1.0e+INF");
1184 /* Likewise for minus infinity. */
1185 if (data
== data
/ 2 && data
< -1.0)
1187 strcpy (buf
, "-1.0e+INF");
1190 /* Check for NaN in a way that won't fail if there are no NaNs. */
1191 if (! (data
* 0.0 >= 0.0))
1193 /* Prepend "-" if the NaN's sign bit is negative.
1194 The sign bit of a double is the bit that is 1 in -0.0. */
1196 union { double d
; char c
[sizeof (double)]; } u_data
, u_minus_zero
;
1198 u_minus_zero
.d
= - 0.0;
1199 for (i
= 0; i
< sizeof (double); i
++)
1200 if (u_data
.c
[i
] & u_minus_zero
.c
[i
])
1206 strcpy (buf
, "0.0e+NaN");
1210 if (NILP (Vfloat_output_format
)
1211 || !STRINGP (Vfloat_output_format
))
1214 /* Generate the fewest number of digits that represent the
1215 floating point value without losing information.
1216 The following method is simple but a bit slow.
1217 For ideas about speeding things up, please see:
1219 Guy L Steele Jr & Jon L White, How to print floating-point numbers
1220 accurately. SIGPLAN notices 25, 6 (June 1990), 112-126.
1222 Robert G Burger & R Kent Dybvig, Printing floating point numbers
1223 quickly and accurately, SIGPLAN notices 31, 5 (May 1996), 108-116. */
1225 width
= fabs (data
) < DBL_MIN
? 1 : DBL_DIG
;
1227 sprintf (buf
, "%.*g", width
, data
);
1228 while (width
++ < DOUBLE_DIGITS_BOUND
&& atof (buf
) != data
);
1230 else /* oink oink */
1232 /* Check that the spec we have is fully valid.
1233 This means not only valid for printf,
1234 but meant for floats, and reasonable. */
1235 cp
= SDATA (Vfloat_output_format
);
1244 /* Check the width specification. */
1246 if ('0' <= *cp
&& *cp
<= '9')
1250 width
= (width
* 10) + (*cp
++ - '0');
1251 while (*cp
>= '0' && *cp
<= '9');
1253 /* A precision of zero is valid only for %f. */
1255 || (width
== 0 && *cp
!= 'f'))
1259 if (*cp
!= 'e' && *cp
!= 'f' && *cp
!= 'g')
1265 sprintf (buf
, SDATA (Vfloat_output_format
), data
);
1268 /* Make sure there is a decimal point with digit after, or an
1269 exponent, so that the value is readable as a float. But don't do
1270 this with "%.0f"; it's valid for that not to produce a decimal
1271 point. Note that width can be 0 only for %.0f. */
1274 for (cp
= buf
; *cp
; cp
++)
1275 if ((*cp
< '0' || *cp
> '9') && *cp
!= '-')
1278 if (*cp
== '.' && cp
[1] == 0)
1295 print (obj
, printcharfun
, escapeflag
)
1297 register Lisp_Object printcharfun
;
1300 new_backquote_output
= 0;
1302 /* Reset print_number_index and Vprint_number_table only when
1303 the variable Vprint_continuous_numbering is nil. Otherwise,
1304 the values of these variables will be kept between several
1306 if (NILP (Vprint_continuous_numbering
)
1307 || NILP (Vprint_number_table
))
1309 print_number_index
= 0;
1310 Vprint_number_table
= Qnil
;
1313 /* Construct Vprint_number_table for print-gensym and print-circle. */
1314 if (!NILP (Vprint_gensym
) || !NILP (Vprint_circle
))
1316 int i
, start
, index
;
1317 start
= index
= print_number_index
;
1318 /* Construct Vprint_number_table.
1319 This increments print_number_index for the objects added. */
1321 print_preprocess (obj
);
1323 /* Remove unnecessary objects, which appear only once in OBJ;
1324 that is, whose status is Qnil. Compactify the necessary objects. */
1325 for (i
= start
; i
< print_number_index
; i
++)
1326 if (!NILP (PRINT_NUMBER_STATUS (Vprint_number_table
, i
)))
1328 PRINT_NUMBER_OBJECT (Vprint_number_table
, index
)
1329 = PRINT_NUMBER_OBJECT (Vprint_number_table
, i
);
1333 /* Clear out objects outside the active part of the table. */
1334 for (i
= index
; i
< print_number_index
; i
++)
1335 PRINT_NUMBER_OBJECT (Vprint_number_table
, i
) = Qnil
;
1337 /* Reset the status field for the next print step. Now this
1338 field means whether the object has already been printed. */
1339 for (i
= start
; i
< print_number_index
; i
++)
1340 PRINT_NUMBER_STATUS (Vprint_number_table
, i
) = Qnil
;
1342 print_number_index
= index
;
1346 print_object (obj
, printcharfun
, escapeflag
);
1349 /* Construct Vprint_number_table according to the structure of OBJ.
1350 OBJ itself and all its elements will be added to Vprint_number_table
1351 recursively if it is a list, vector, compiled function, char-table,
1352 string (its text properties will be traced), or a symbol that has
1353 no obarray (this is for the print-gensym feature).
1354 The status fields of Vprint_number_table mean whether each object appears
1355 more than once in OBJ: Qnil at the first time, and Qt after that . */
1357 print_preprocess (obj
)
1363 Lisp_Object halftail
;
1365 /* Give up if we go so deep that print_object will get an error. */
1366 /* See similar code in print_object. */
1367 if (print_depth
>= PRINT_CIRCLE
)
1368 error ("Apparently circular structure being printed");
1370 /* Avoid infinite recursion for circular nested structure
1371 in the case where Vprint_circle is nil. */
1372 if (NILP (Vprint_circle
))
1374 for (i
= 0; i
< print_depth
; i
++)
1375 if (EQ (obj
, being_printed
[i
]))
1377 being_printed
[print_depth
] = obj
;
1384 if (STRINGP (obj
) || CONSP (obj
) || VECTORP (obj
)
1385 || COMPILEDP (obj
) || CHAR_TABLE_P (obj
)
1386 || (! NILP (Vprint_gensym
)
1388 && !SYMBOL_INTERNED_P (obj
)))
1390 /* In case print-circle is nil and print-gensym is t,
1391 add OBJ to Vprint_number_table only when OBJ is a symbol. */
1392 if (! NILP (Vprint_circle
) || SYMBOLP (obj
))
1394 for (i
= 0; i
< print_number_index
; i
++)
1395 if (EQ (PRINT_NUMBER_OBJECT (Vprint_number_table
, i
), obj
))
1397 /* OBJ appears more than once. Let's remember that. */
1398 PRINT_NUMBER_STATUS (Vprint_number_table
, i
) = Qt
;
1403 /* OBJ is not yet recorded. Let's add to the table. */
1404 if (print_number_index
== 0)
1406 /* Initialize the table. */
1407 Vprint_number_table
= Fmake_vector (make_number (40), Qnil
);
1409 else if (XVECTOR (Vprint_number_table
)->size
== print_number_index
* 2)
1411 /* Reallocate the table. */
1412 int i
= print_number_index
* 4;
1413 Lisp_Object old_table
= Vprint_number_table
;
1414 Vprint_number_table
= Fmake_vector (make_number (i
), Qnil
);
1415 for (i
= 0; i
< print_number_index
; i
++)
1417 PRINT_NUMBER_OBJECT (Vprint_number_table
, i
)
1418 = PRINT_NUMBER_OBJECT (old_table
, i
);
1419 PRINT_NUMBER_STATUS (Vprint_number_table
, i
)
1420 = PRINT_NUMBER_STATUS (old_table
, i
);
1423 PRINT_NUMBER_OBJECT (Vprint_number_table
, print_number_index
) = obj
;
1424 /* If Vprint_continuous_numbering is non-nil and OBJ is a gensym,
1425 always print the gensym with a number. This is a special for
1426 the lisp function byte-compile-output-docform. */
1427 if (!NILP (Vprint_continuous_numbering
)
1429 && !SYMBOL_INTERNED_P (obj
))
1430 PRINT_NUMBER_STATUS (Vprint_number_table
, print_number_index
) = Qt
;
1431 print_number_index
++;
1434 switch (XGCTYPE (obj
))
1437 /* A string may have text properties, which can be circular. */
1438 traverse_intervals_noorder (STRING_INTERVALS (obj
),
1439 print_preprocess_string
, Qnil
);
1443 /* Use HALFTAIL and LOOP_COUNT to detect circular lists,
1444 just as in print_object. */
1445 if (loop_count
&& EQ (obj
, halftail
))
1447 print_preprocess (XCAR (obj
));
1450 if (!(loop_count
& 1))
1451 halftail
= XCDR (halftail
);
1454 case Lisp_Vectorlike
:
1455 size
= XVECTOR (obj
)->size
;
1456 if (size
& PSEUDOVECTOR_FLAG
)
1457 size
&= PSEUDOVECTOR_SIZE_MASK
;
1458 for (i
= 0; i
< size
; i
++)
1459 print_preprocess (XVECTOR (obj
)->contents
[i
]);
1470 print_preprocess_string (interval
, arg
)
1474 print_preprocess (interval
->plist
);
1478 print_object (obj
, printcharfun
, escapeflag
)
1480 register Lisp_Object printcharfun
;
1487 /* Detect circularities and truncate them. */
1488 if (STRINGP (obj
) || CONSP (obj
) || VECTORP (obj
)
1489 || COMPILEDP (obj
) || CHAR_TABLE_P (obj
)
1490 || (! NILP (Vprint_gensym
)
1492 && !SYMBOL_INTERNED_P (obj
)))
1494 if (NILP (Vprint_circle
) && NILP (Vprint_gensym
))
1496 /* Simple but incomplete way. */
1498 for (i
= 0; i
< print_depth
; i
++)
1499 if (EQ (obj
, being_printed
[i
]))
1501 sprintf (buf
, "#%d", i
);
1502 strout (buf
, -1, -1, printcharfun
, 0);
1505 being_printed
[print_depth
] = obj
;
1509 /* With the print-circle feature. */
1511 for (i
= 0; i
< print_number_index
; i
++)
1512 if (EQ (PRINT_NUMBER_OBJECT (Vprint_number_table
, i
), obj
))
1514 if (NILP (PRINT_NUMBER_STATUS (Vprint_number_table
, i
)))
1516 /* Add a prefix #n= if OBJ has not yet been printed;
1517 that is, its status field is nil. */
1518 sprintf (buf
, "#%d=", i
+ 1);
1519 strout (buf
, -1, -1, printcharfun
, 0);
1520 /* OBJ is going to be printed. Set the status to t. */
1521 PRINT_NUMBER_STATUS (Vprint_number_table
, i
) = Qt
;
1526 /* Just print #n# if OBJ has already been printed. */
1527 sprintf (buf
, "#%d#", i
+ 1);
1528 strout (buf
, -1, -1, printcharfun
, 0);
1537 /* See similar code in print_preprocess. */
1538 if (print_depth
> PRINT_CIRCLE
)
1539 error ("Apparently circular structure being printed");
1540 #ifdef MAX_PRINT_CHARS
1541 if (max_print
&& print_chars
> max_print
)
1546 #endif /* MAX_PRINT_CHARS */
1548 switch (XGCTYPE (obj
))
1551 if (sizeof (int) == sizeof (EMACS_INT
))
1552 sprintf (buf
, "%d", (int) XINT (obj
));
1553 else if (sizeof (long) == sizeof (EMACS_INT
))
1554 sprintf (buf
, "%ld", (long) XINT (obj
));
1557 strout (buf
, -1, -1, printcharfun
, 0);
1562 char pigbuf
[350]; /* see comments in float_to_string */
1564 float_to_string (pigbuf
, XFLOAT_DATA (obj
));
1565 strout (pigbuf
, -1, -1, printcharfun
, 0);
1571 print_string (obj
, printcharfun
);
1574 register int i
, i_byte
;
1575 struct gcpro gcpro1
;
1578 /* 1 means we must ensure that the next character we output
1579 cannot be taken as part of a hex character escape. */
1580 int need_nonhex
= 0;
1581 int multibyte
= STRING_MULTIBYTE (obj
);
1585 if (!NULL_INTERVAL_P (STRING_INTERVALS (obj
)))
1593 size_byte
= SBYTES (obj
);
1595 for (i
= 0, i_byte
= 0; i_byte
< size_byte
;)
1597 /* Here, we must convert each multi-byte form to the
1598 corresponding character code before handing it to PRINTCHAR. */
1604 c
= STRING_CHAR_AND_LENGTH (str
+ i_byte
,
1605 size_byte
- i_byte
, len
);
1606 if (CHAR_VALID_P (c
, 0))
1616 if (c
== '\n' && print_escape_newlines
)
1621 else if (c
== '\f' && print_escape_newlines
)
1627 && ! ASCII_BYTE_P (c
)
1628 && (SINGLE_BYTE_CHAR_P (c
) || print_escape_multibyte
))
1630 /* When multibyte is disabled,
1631 print multibyte string chars using hex escapes.
1632 For a char code that could be in a unibyte string,
1633 when found in a multibyte string, always use a hex escape
1634 so it reads back as multibyte. */
1635 unsigned char outbuf
[50];
1636 sprintf (outbuf
, "\\x%x", c
);
1637 strout (outbuf
, -1, -1, printcharfun
, 0);
1640 else if (! multibyte
1641 && SINGLE_BYTE_CHAR_P (c
) && ! ASCII_BYTE_P (c
)
1642 && print_escape_nonascii
)
1644 /* When printing in a multibyte buffer
1645 or when explicitly requested,
1646 print single-byte non-ASCII string chars
1647 using octal escapes. */
1648 unsigned char outbuf
[5];
1649 sprintf (outbuf
, "\\%03o", c
);
1650 strout (outbuf
, -1, -1, printcharfun
, 0);
1654 /* If we just had a hex escape, and this character
1655 could be taken as part of it,
1656 output `\ ' to prevent that. */
1660 if ((c
>= 'a' && c
<= 'f')
1661 || (c
>= 'A' && c
<= 'F')
1662 || (c
>= '0' && c
<= '9'))
1663 strout ("\\ ", -1, -1, printcharfun
, 0);
1666 if (c
== '\"' || c
== '\\')
1673 if (!NULL_INTERVAL_P (STRING_INTERVALS (obj
)))
1675 traverse_intervals (STRING_INTERVALS (obj
),
1676 0, print_interval
, printcharfun
);
1686 register int confusing
;
1687 register unsigned char *p
= SDATA (SYMBOL_NAME (obj
));
1688 register unsigned char *end
= p
+ SBYTES (SYMBOL_NAME (obj
));
1690 int i
, i_byte
, size_byte
;
1693 name
= SYMBOL_NAME (obj
);
1695 if (p
!= end
&& (*p
== '-' || *p
== '+')) p
++;
1698 /* If symbol name begins with a digit, and ends with a digit,
1699 and contains nothing but digits and `e', it could be treated
1700 as a number. So set CONFUSING.
1702 Symbols that contain periods could also be taken as numbers,
1703 but periods are always escaped, so we don't have to worry
1705 else if (*p
>= '0' && *p
<= '9'
1706 && end
[-1] >= '0' && end
[-1] <= '9')
1708 while (p
!= end
&& ((*p
>= '0' && *p
<= '9')
1709 /* Needed for \2e10. */
1712 confusing
= (end
== p
);
1717 if (! NILP (Vprint_gensym
) && !SYMBOL_INTERNED_P (obj
))
1723 size_byte
= SBYTES (name
);
1725 for (i
= 0, i_byte
= 0; i_byte
< size_byte
;)
1727 /* Here, we must convert each multi-byte form to the
1728 corresponding character code before handing it to PRINTCHAR. */
1729 FETCH_STRING_CHAR_ADVANCE (c
, name
, i
, i_byte
);
1734 if (c
== '\"' || c
== '\\' || c
== '\''
1735 || c
== ';' || c
== '#' || c
== '(' || c
== ')'
1736 || c
== ',' || c
=='.' || c
== '`'
1737 || c
== '[' || c
== ']' || c
== '?' || c
<= 040
1739 PRINTCHAR ('\\'), confusing
= 0;
1747 /* If deeper than spec'd depth, print placeholder. */
1748 if (INTEGERP (Vprint_level
)
1749 && print_depth
> XINT (Vprint_level
))
1750 strout ("...", -1, -1, printcharfun
, 0);
1751 else if (print_quoted
&& CONSP (XCDR (obj
)) && NILP (XCDR (XCDR (obj
)))
1752 && (EQ (XCAR (obj
), Qquote
)))
1755 print_object (XCAR (XCDR (obj
)), printcharfun
, escapeflag
);
1757 else if (print_quoted
&& CONSP (XCDR (obj
)) && NILP (XCDR (XCDR (obj
)))
1758 && (EQ (XCAR (obj
), Qfunction
)))
1762 print_object (XCAR (XCDR (obj
)), printcharfun
, escapeflag
);
1764 else if (print_quoted
&& CONSP (XCDR (obj
)) && NILP (XCDR (XCDR (obj
)))
1765 && ((EQ (XCAR (obj
), Qbackquote
))))
1767 print_object (XCAR (obj
), printcharfun
, 0);
1768 new_backquote_output
++;
1769 print_object (XCAR (XCDR (obj
)), printcharfun
, escapeflag
);
1770 new_backquote_output
--;
1772 else if (print_quoted
&& CONSP (XCDR (obj
)) && NILP (XCDR (XCDR (obj
)))
1773 && new_backquote_output
1774 && ((EQ (XCAR (obj
), Qbackquote
)
1775 || EQ (XCAR (obj
), Qcomma
)
1776 || EQ (XCAR (obj
), Qcomma_at
)
1777 || EQ (XCAR (obj
), Qcomma_dot
))))
1779 print_object (XCAR (obj
), printcharfun
, 0);
1780 new_backquote_output
--;
1781 print_object (XCAR (XCDR (obj
)), printcharfun
, escapeflag
);
1782 new_backquote_output
++;
1788 /* If the first element is a backquote form,
1789 print it old-style so it won't be misunderstood. */
1790 if (print_quoted
&& CONSP (XCAR (obj
))
1791 && CONSP (XCDR (XCAR (obj
)))
1792 && NILP (XCDR (XCDR (XCAR (obj
))))
1793 && EQ (XCAR (XCAR (obj
)), Qbackquote
))
1799 print_object (Qbackquote
, printcharfun
, 0);
1802 print_object (XCAR (XCDR (tem
)), printcharfun
, 0);
1809 int print_length
, i
;
1810 Lisp_Object halftail
= obj
;
1812 /* Negative values of print-length are invalid in CL.
1813 Treat them like nil, as CMUCL does. */
1814 if (NATNUMP (Vprint_length
))
1815 print_length
= XFASTINT (Vprint_length
);
1822 /* Detect circular list. */
1823 if (NILP (Vprint_circle
))
1825 /* Simple but imcomplete way. */
1826 if (i
!= 0 && EQ (obj
, halftail
))
1828 sprintf (buf
, " . #%d", i
/ 2);
1829 strout (buf
, -1, -1, printcharfun
, 0);
1835 /* With the print-circle feature. */
1839 for (i
= 0; i
< print_number_index
; i
++)
1840 if (EQ (PRINT_NUMBER_OBJECT (Vprint_number_table
, i
),
1843 if (NILP (PRINT_NUMBER_STATUS (Vprint_number_table
, i
)))
1845 strout (" . ", 3, 3, printcharfun
, 0);
1846 print_object (obj
, printcharfun
, escapeflag
);
1850 sprintf (buf
, " . #%d#", i
+ 1);
1851 strout (buf
, -1, -1, printcharfun
, 0);
1861 if (print_length
&& i
> print_length
)
1863 strout ("...", 3, 3, printcharfun
, 0);
1867 print_object (XCAR (obj
), printcharfun
, escapeflag
);
1871 halftail
= XCDR (halftail
);
1875 /* OBJ non-nil here means it's the end of a dotted list. */
1878 strout (" . ", 3, 3, printcharfun
, 0);
1879 print_object (obj
, printcharfun
, escapeflag
);
1887 case Lisp_Vectorlike
:
1892 strout ("#<process ", -1, -1, printcharfun
, 0);
1893 print_string (XPROCESS (obj
)->name
, printcharfun
);
1897 print_string (XPROCESS (obj
)->name
, printcharfun
);
1899 else if (BOOL_VECTOR_P (obj
))
1902 register unsigned char c
;
1903 struct gcpro gcpro1
;
1905 = ((XBOOL_VECTOR (obj
)->size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1)
1906 / BOOL_VECTOR_BITS_PER_CHAR
);
1912 sprintf (buf
, "%ld", (long) XBOOL_VECTOR (obj
)->size
);
1913 strout (buf
, -1, -1, printcharfun
, 0);
1916 /* Don't print more characters than the specified maximum.
1917 Negative values of print-length are invalid. Treat them
1918 like a print-length of nil. */
1919 if (NATNUMP (Vprint_length
)
1920 && XFASTINT (Vprint_length
) < size_in_chars
)
1921 size_in_chars
= XFASTINT (Vprint_length
);
1923 for (i
= 0; i
< size_in_chars
; i
++)
1926 c
= XBOOL_VECTOR (obj
)->data
[i
];
1927 if (c
== '\n' && print_escape_newlines
)
1932 else if (c
== '\f' && print_escape_newlines
)
1937 else if (c
> '\177')
1939 /* Use octal escapes to avoid encoding issues. */
1941 PRINTCHAR ('0' + ((c
>> 6) & 3));
1942 PRINTCHAR ('0' + ((c
>> 3) & 7));
1943 PRINTCHAR ('0' + (c
& 7));
1947 if (c
== '\"' || c
== '\\')
1956 else if (SUBRP (obj
))
1958 strout ("#<subr ", -1, -1, printcharfun
, 0);
1959 strout (XSUBR (obj
)->symbol_name
, -1, -1, printcharfun
, 0);
1962 else if (WINDOWP (obj
))
1964 strout ("#<window ", -1, -1, printcharfun
, 0);
1965 sprintf (buf
, "%ld", (long) XFASTINT (XWINDOW (obj
)->sequence_number
));
1966 strout (buf
, -1, -1, printcharfun
, 0);
1967 if (!NILP (XWINDOW (obj
)->buffer
))
1969 strout (" on ", -1, -1, printcharfun
, 0);
1970 print_string (XBUFFER (XWINDOW (obj
)->buffer
)->name
, printcharfun
);
1974 else if (TERMINALP (obj
))
1976 struct terminal
*t
= XTERMINAL (obj
);
1977 strout ("#<terminal ", -1, -1, printcharfun
, 0);
1978 sprintf (buf
, "%d", t
->id
);
1979 strout (buf
, -1, -1, printcharfun
, 0);
1982 strout (" on ", -1, -1, printcharfun
, 0);
1983 strout (t
->name
, -1, -1, printcharfun
, 0);
1987 else if (HASH_TABLE_P (obj
))
1989 struct Lisp_Hash_Table
*h
= XHASH_TABLE (obj
);
1990 strout ("#<hash-table", -1, -1, printcharfun
, 0);
1991 if (SYMBOLP (h
->test
))
1995 strout (SDATA (SYMBOL_NAME (h
->test
)), -1, -1, printcharfun
, 0);
1997 strout (SDATA (SYMBOL_NAME (h
->weak
)), -1, -1, printcharfun
, 0);
1999 sprintf (buf
, "%ld/%ld", (long) h
->count
,
2000 (long) XVECTOR (h
->next
)->size
);
2001 strout (buf
, -1, -1, printcharfun
, 0);
2003 sprintf (buf
, " 0x%lx", (unsigned long) h
);
2004 strout (buf
, -1, -1, printcharfun
, 0);
2007 else if (BUFFERP (obj
))
2009 if (NILP (XBUFFER (obj
)->name
))
2010 strout ("#<killed buffer>", -1, -1, printcharfun
, 0);
2011 else if (escapeflag
)
2013 strout ("#<buffer ", -1, -1, printcharfun
, 0);
2014 print_string (XBUFFER (obj
)->name
, printcharfun
);
2018 print_string (XBUFFER (obj
)->name
, printcharfun
);
2020 else if (WINDOW_CONFIGURATIONP (obj
))
2022 strout ("#<window-configuration>", -1, -1, printcharfun
, 0);
2024 else if (FRAMEP (obj
))
2026 strout ((FRAME_LIVE_P (XFRAME (obj
))
2027 ? "#<frame " : "#<dead frame "),
2028 -1, -1, printcharfun
, 0);
2029 print_string (XFRAME (obj
)->name
, printcharfun
);
2030 sprintf (buf
, " 0x%lx", (unsigned long) (XFRAME (obj
)));
2031 strout (buf
, -1, -1, printcharfun
, 0);
2036 EMACS_INT size
= XVECTOR (obj
)->size
;
2037 if (COMPILEDP (obj
))
2040 size
&= PSEUDOVECTOR_SIZE_MASK
;
2042 if (CHAR_TABLE_P (obj
))
2044 /* We print a char-table as if it were a vector,
2045 lumping the parent and default slots in with the
2046 character slots. But we add #^ as a prefix. */
2049 if (SUB_CHAR_TABLE_P (obj
))
2051 size
&= PSEUDOVECTOR_SIZE_MASK
;
2053 if (size
& PSEUDOVECTOR_FLAG
)
2059 register Lisp_Object tem
;
2060 int real_size
= size
;
2062 /* Don't print more elements than the specified maximum. */
2063 if (NATNUMP (Vprint_length
)
2064 && XFASTINT (Vprint_length
) < size
)
2065 size
= XFASTINT (Vprint_length
);
2067 for (i
= 0; i
< size
; i
++)
2069 if (i
) PRINTCHAR (' ');
2070 tem
= XVECTOR (obj
)->contents
[i
];
2071 print_object (tem
, printcharfun
, escapeflag
);
2073 if (size
< real_size
)
2074 strout (" ...", 4, 4, printcharfun
, 0);
2081 switch (XMISCTYPE (obj
))
2083 case Lisp_Misc_Marker
:
2084 strout ("#<marker ", -1, -1, printcharfun
, 0);
2085 /* Do you think this is necessary? */
2086 if (XMARKER (obj
)->insertion_type
!= 0)
2087 strout ("(moves after insertion) ", -1, -1, printcharfun
, 0);
2088 if (! XMARKER (obj
)->buffer
)
2089 strout ("in no buffer", -1, -1, printcharfun
, 0);
2092 sprintf (buf
, "at %d", marker_position (obj
));
2093 strout (buf
, -1, -1, printcharfun
, 0);
2094 strout (" in ", -1, -1, printcharfun
, 0);
2095 print_string (XMARKER (obj
)->buffer
->name
, printcharfun
);
2100 case Lisp_Misc_Overlay
:
2101 strout ("#<overlay ", -1, -1, printcharfun
, 0);
2102 if (! XMARKER (OVERLAY_START (obj
))->buffer
)
2103 strout ("in no buffer", -1, -1, printcharfun
, 0);
2106 sprintf (buf
, "from %d to %d in ",
2107 marker_position (OVERLAY_START (obj
)),
2108 marker_position (OVERLAY_END (obj
)));
2109 strout (buf
, -1, -1, printcharfun
, 0);
2110 print_string (XMARKER (OVERLAY_START (obj
))->buffer
->name
,
2116 /* Remaining cases shouldn't happen in normal usage, but let's print
2117 them anyway for the benefit of the debugger. */
2118 case Lisp_Misc_Free
:
2119 strout ("#<misc free cell>", -1, -1, printcharfun
, 0);
2122 case Lisp_Misc_Intfwd
:
2123 sprintf (buf
, "#<intfwd to %ld>", (long) *XINTFWD (obj
)->intvar
);
2124 strout (buf
, -1, -1, printcharfun
, 0);
2127 case Lisp_Misc_Boolfwd
:
2128 sprintf (buf
, "#<boolfwd to %s>",
2129 (*XBOOLFWD (obj
)->boolvar
? "t" : "nil"));
2130 strout (buf
, -1, -1, printcharfun
, 0);
2133 case Lisp_Misc_Objfwd
:
2134 strout ("#<objfwd to ", -1, -1, printcharfun
, 0);
2135 print_object (*XOBJFWD (obj
)->objvar
, printcharfun
, escapeflag
);
2139 case Lisp_Misc_Buffer_Objfwd
:
2140 strout ("#<buffer_objfwd to ", -1, -1, printcharfun
, 0);
2141 print_object (PER_BUFFER_VALUE (current_buffer
,
2142 XBUFFER_OBJFWD (obj
)->offset
),
2143 printcharfun
, escapeflag
);
2147 case Lisp_Misc_Kboard_Objfwd
:
2148 strout ("#<kboard_objfwd to ", -1, -1, printcharfun
, 0);
2149 print_object (*(Lisp_Object
*) ((char *) current_kboard
2150 + XKBOARD_OBJFWD (obj
)->offset
),
2151 printcharfun
, escapeflag
);
2155 case Lisp_Misc_Buffer_Local_Value
:
2156 strout ("#<buffer_local_value ", -1, -1, printcharfun
, 0);
2157 if (XBUFFER_LOCAL_VALUE (obj
)->local_if_set
)
2158 strout ("[local-if-set] ", -1, -1, printcharfun
, 0);
2159 strout ("[realvalue] ", -1, -1, printcharfun
, 0);
2160 print_object (XBUFFER_LOCAL_VALUE (obj
)->realvalue
,
2161 printcharfun
, escapeflag
);
2162 if (XBUFFER_LOCAL_VALUE (obj
)->found_for_buffer
)
2163 strout ("[local in buffer] ", -1, -1, printcharfun
, 0);
2165 strout ("[buffer] ", -1, -1, printcharfun
, 0);
2166 print_object (XBUFFER_LOCAL_VALUE (obj
)->buffer
,
2167 printcharfun
, escapeflag
);
2168 if (XBUFFER_LOCAL_VALUE (obj
)->check_frame
)
2170 if (XBUFFER_LOCAL_VALUE (obj
)->found_for_frame
)
2171 strout ("[local in frame] ", -1, -1, printcharfun
, 0);
2173 strout ("[frame] ", -1, -1, printcharfun
, 0);
2174 print_object (XBUFFER_LOCAL_VALUE (obj
)->frame
,
2175 printcharfun
, escapeflag
);
2177 strout ("[alist-elt] ", -1, -1, printcharfun
, 0);
2178 print_object (XCAR (XBUFFER_LOCAL_VALUE (obj
)->cdr
),
2179 printcharfun
, escapeflag
);
2180 strout ("[default-value] ", -1, -1, printcharfun
, 0);
2181 print_object (XCDR (XBUFFER_LOCAL_VALUE (obj
)->cdr
),
2182 printcharfun
, escapeflag
);
2186 case Lisp_Misc_Save_Value
:
2187 strout ("#<save_value ", -1, -1, printcharfun
, 0);
2188 sprintf(buf
, "ptr=0x%08lx int=%d",
2189 (unsigned long) XSAVE_VALUE (obj
)->pointer
,
2190 XSAVE_VALUE (obj
)->integer
);
2191 strout (buf
, -1, -1, printcharfun
, 0);
2203 /* We're in trouble if this happens!
2204 Probably should just abort () */
2205 strout ("#<EMACS BUG: INVALID DATATYPE ", -1, -1, printcharfun
, 0);
2207 sprintf (buf
, "(MISC 0x%04x)", (int) XMISCTYPE (obj
));
2208 else if (VECTORLIKEP (obj
))
2209 sprintf (buf
, "(PVEC 0x%08x)", (int) XVECTOR (obj
)->size
);
2211 sprintf (buf
, "(0x%02x)", (int) XTYPE (obj
));
2212 strout (buf
, -1, -1, printcharfun
, 0);
2213 strout (" Save your buffers immediately and please report this bug>",
2214 -1, -1, printcharfun
, 0);
2222 /* Print a description of INTERVAL using PRINTCHARFUN.
2223 This is part of printing a string that has text properties. */
2226 print_interval (interval
, printcharfun
)
2228 Lisp_Object printcharfun
;
2231 print_object (make_number (interval
->position
), printcharfun
, 1);
2233 print_object (make_number (interval
->position
+ LENGTH (interval
)),
2236 print_object (interval
->plist
, printcharfun
, 1);
2243 Qtemp_buffer_setup_hook
= intern ("temp-buffer-setup-hook");
2244 staticpro (&Qtemp_buffer_setup_hook
);
2246 DEFVAR_LISP ("standard-output", &Vstandard_output
,
2247 doc
: /* Output stream `print' uses by default for outputting a character.
2248 This may be any function of one argument.
2249 It may also be a buffer (output is inserted before point)
2250 or a marker (output is inserted and the marker is advanced)
2251 or the symbol t (output appears in the echo area). */);
2252 Vstandard_output
= Qt
;
2253 Qstandard_output
= intern ("standard-output");
2254 staticpro (&Qstandard_output
);
2256 DEFVAR_LISP ("float-output-format", &Vfloat_output_format
,
2257 doc
: /* The format descriptor string used to print floats.
2258 This is a %-spec like those accepted by `printf' in C,
2259 but with some restrictions. It must start with the two characters `%.'.
2260 After that comes an integer precision specification,
2261 and then a letter which controls the format.
2262 The letters allowed are `e', `f' and `g'.
2263 Use `e' for exponential notation \"DIG.DIGITSeEXPT\"
2264 Use `f' for decimal point notation \"DIGITS.DIGITS\".
2265 Use `g' to choose the shorter of those two formats for the number at hand.
2266 The precision in any of these cases is the number of digits following
2267 the decimal point. With `f', a precision of 0 means to omit the
2268 decimal point. 0 is not allowed with `e' or `g'.
2270 A value of nil means to use the shortest notation
2271 that represents the number without losing information. */);
2272 Vfloat_output_format
= Qnil
;
2273 Qfloat_output_format
= intern ("float-output-format");
2274 staticpro (&Qfloat_output_format
);
2276 DEFVAR_LISP ("print-length", &Vprint_length
,
2277 doc
: /* Maximum length of list to print before abbreviating.
2278 A value of nil means no limit. See also `eval-expression-print-length'. */);
2279 Vprint_length
= Qnil
;
2281 DEFVAR_LISP ("print-level", &Vprint_level
,
2282 doc
: /* Maximum depth of list nesting to print before abbreviating.
2283 A value of nil means no limit. See also `eval-expression-print-level'. */);
2284 Vprint_level
= Qnil
;
2286 DEFVAR_BOOL ("print-escape-newlines", &print_escape_newlines
,
2287 doc
: /* Non-nil means print newlines in strings as `\\n'.
2288 Also print formfeeds as `\\f'. */);
2289 print_escape_newlines
= 0;
2291 DEFVAR_BOOL ("print-escape-nonascii", &print_escape_nonascii
,
2292 doc
: /* Non-nil means print unibyte non-ASCII chars in strings as \\OOO.
2293 \(OOO is the octal representation of the character code.)
2294 Only single-byte characters are affected, and only in `prin1'.
2295 When the output goes in a multibyte buffer, this feature is
2296 enabled regardless of the value of the variable. */);
2297 print_escape_nonascii
= 0;
2299 DEFVAR_BOOL ("print-escape-multibyte", &print_escape_multibyte
,
2300 doc
: /* Non-nil means print multibyte characters in strings as \\xXXXX.
2301 \(XXXX is the hex representation of the character code.)
2302 This affects only `prin1'. */);
2303 print_escape_multibyte
= 0;
2305 DEFVAR_BOOL ("print-quoted", &print_quoted
,
2306 doc
: /* Non-nil means print quoted forms with reader syntax.
2307 I.e., (quote foo) prints as 'foo, (function foo) as #'foo, and backquoted
2308 forms print as in the new syntax. */);
2311 DEFVAR_LISP ("print-gensym", &Vprint_gensym
,
2312 doc
: /* Non-nil means print uninterned symbols so they will read as uninterned.
2313 I.e., the value of (make-symbol \"foobar\") prints as #:foobar.
2314 When the uninterned symbol appears within a recursive data structure,
2315 and the symbol appears more than once, in addition use the #N# and #N=
2316 constructs as needed, so that multiple references to the same symbol are
2317 shared once again when the text is read back. */);
2318 Vprint_gensym
= Qnil
;
2320 DEFVAR_LISP ("print-circle", &Vprint_circle
,
2321 doc
: /* *Non-nil means print recursive structures using #N= and #N# syntax.
2322 If nil, printing proceeds recursively and may lead to
2323 `max-lisp-eval-depth' being exceeded or an error may occur:
2324 \"Apparently circular structure being printed.\" Also see
2325 `print-length' and `print-level'.
2326 If non-nil, shared substructures anywhere in the structure are printed
2327 with `#N=' before the first occurrence (in the order of the print
2328 representation) and `#N#' in place of each subsequent occurrence,
2329 where N is a positive decimal integer. */);
2330 Vprint_circle
= Qnil
;
2332 DEFVAR_LISP ("print-continuous-numbering", &Vprint_continuous_numbering
,
2333 doc
: /* *Non-nil means number continuously across print calls.
2334 This affects the numbers printed for #N= labels and #M# references.
2335 See also `print-circle', `print-gensym', and `print-number-table'.
2336 This variable should not be set with `setq'; bind it with a `let' instead. */);
2337 Vprint_continuous_numbering
= Qnil
;
2339 DEFVAR_LISP ("print-number-table", &Vprint_number_table
,
2340 doc
: /* A vector used internally to produce `#N=' labels and `#N#' references.
2341 The Lisp printer uses this vector to detect Lisp objects referenced more
2344 When you bind `print-continuous-numbering' to t, you should probably
2345 also bind `print-number-table' to nil. This ensures that the value of
2346 `print-number-table' can be garbage-collected once the printing is
2347 done. If all elements of `print-number-table' are nil, it means that
2348 the printing done so far has not found any shared structure or objects
2349 that need to be recorded in the table. */);
2350 Vprint_number_table
= Qnil
;
2352 /* prin1_to_string_buffer initialized in init_buffer_once in buffer.c */
2353 staticpro (&Vprin1_to_string_buffer
);
2356 defsubr (&Sprin1_to_string
);
2357 defsubr (&Serror_message_string
);
2361 defsubr (&Swrite_char
);
2362 defsubr (&Sexternal_debugging_output
);
2363 #ifdef WITH_REDIRECT_DEBUGGING_OUTPUT
2364 defsubr (&Sredirect_debugging_output
);
2367 Qexternal_debugging_output
= intern ("external-debugging-output");
2368 staticpro (&Qexternal_debugging_output
);
2370 Qprint_escape_newlines
= intern ("print-escape-newlines");
2371 staticpro (&Qprint_escape_newlines
);
2373 Qprint_escape_multibyte
= intern ("print-escape-multibyte");
2374 staticpro (&Qprint_escape_multibyte
);
2376 Qprint_escape_nonascii
= intern ("print-escape-nonascii");
2377 staticpro (&Qprint_escape_nonascii
);
2379 defsubr (&Swith_output_to_temp_buffer
);
2382 /* arch-tag: bc797170-94ae-41de-86e3-75e20f8f7a39
2383 (do not change this comment) */