1 /* Lisp object printing and output streams.
2 Copyright (C) 1985, 86, 88, 93, 94, 95, 97, 98, 1999, 2000, 2001
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
27 #include "character.h"
32 #include "dispextern.h"
34 #include "intervals.h"
36 Lisp_Object Vstandard_output
, Qstandard_output
;
38 Lisp_Object Qtemp_buffer_setup_hook
;
40 /* These are used to print like we read. */
41 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
43 Lisp_Object Vfloat_output_format
, Qfloat_output_format
;
45 /* Work around a problem that happens because math.h on hpux 7
46 defines two static variables--which, in Emacs, are not really static,
47 because `static' is defined as nothing. The problem is that they are
48 defined both here and in lread.c.
49 These macros prevent the name conflict. */
50 #if defined (HPUX) && !defined (HPUX8)
51 #define _MAXLDBL print_maxldbl
52 #define _NMAXLDBL print_nmaxldbl
61 /* Default to values appropriate for IEEE floating point. */
66 #define DBL_MANT_DIG 53
72 #define DBL_MIN 2.2250738585072014e-308
75 #ifdef DBL_MIN_REPLACEMENT
77 #define DBL_MIN DBL_MIN_REPLACEMENT
80 /* Define DOUBLE_DIGITS_BOUND, an upper bound on the number of decimal digits
81 needed to express a float without losing information.
82 The general-case formula is valid for the usual case, IEEE floating point,
83 but many compilers can't optimize the formula to an integer constant,
84 so make a special case for it. */
85 #if FLT_RADIX == 2 && DBL_MANT_DIG == 53
86 #define DOUBLE_DIGITS_BOUND 17 /* IEEE floating point */
88 #define DOUBLE_DIGITS_BOUND ((int) ceil (log10 (pow (FLT_RADIX, DBL_MANT_DIG))))
91 /* Avoid actual stack overflow in print. */
94 /* Detect most circularities to print finite output. */
95 #define PRINT_CIRCLE 200
96 Lisp_Object being_printed
[PRINT_CIRCLE
];
98 /* When printing into a buffer, first we put the text in this
99 block, then insert it all at once. */
102 /* Size allocated in print_buffer. */
103 int print_buffer_size
;
104 /* Chars stored in print_buffer. */
105 int print_buffer_pos
;
106 /* Bytes stored in print_buffer. */
107 int print_buffer_pos_byte
;
109 /* Maximum length of list to print in full; noninteger means
110 effectively infinity */
112 Lisp_Object Vprint_length
;
114 /* Maximum depth of list to print in full; noninteger means
115 effectively infinity. */
117 Lisp_Object Vprint_level
;
119 /* Nonzero means print newlines in strings as \n. */
121 int print_escape_newlines
;
123 /* Nonzero means to print single-byte non-ascii characters in strings as
126 int print_escape_nonascii
;
128 /* Nonzero means to print multibyte characters in strings as hex escapes. */
130 int print_escape_multibyte
;
132 Lisp_Object Qprint_escape_newlines
;
133 Lisp_Object Qprint_escape_multibyte
, Qprint_escape_nonascii
;
135 /* Nonzero means print (quote foo) forms as 'foo, etc. */
139 /* Non-nil means print #: before uninterned symbols. */
141 Lisp_Object Vprint_gensym
;
143 /* Non-nil means print recursive structures using #n= and #n# syntax. */
145 Lisp_Object Vprint_circle
;
147 /* Non-nil means keep continuous number for #n= and #n# syntax
148 between several print functions. */
150 Lisp_Object Vprint_continuous_numbering
;
152 /* Vprint_number_table is a vector like [OBJ1 STAT1 OBJ2 STAT2 ...],
153 where OBJn are objects going to be printed, and STATn are their status,
154 which may be different meanings during process. See the comments of
155 the functions print and print_preprocess for details.
156 print_number_index keeps the last position the next object should be added,
157 twice of which is the actual vector position in Vprint_number_table. */
158 int print_number_index
;
159 Lisp_Object Vprint_number_table
;
161 /* PRINT_NUMBER_OBJECT returns the I'th object in Vprint_number_table TABLE.
162 PRINT_NUMBER_STATUS returns the status of the I'th object in TABLE.
163 See the comment of the variable Vprint_number_table. */
164 #define PRINT_NUMBER_OBJECT(table,i) XVECTOR ((table))->contents[(i) * 2]
165 #define PRINT_NUMBER_STATUS(table,i) XVECTOR ((table))->contents[(i) * 2 + 1]
167 /* Nonzero means print newline to stdout before next minibuffer message.
168 Defined in xdisp.c */
170 extern int noninteractive_need_newline
;
172 extern int minibuffer_auto_raise
;
174 #ifdef MAX_PRINT_CHARS
175 static int print_chars
;
176 static int max_print
;
177 #endif /* MAX_PRINT_CHARS */
179 void print_interval ();
182 /* Low level output routines for characters and strings */
184 /* Lisp functions to do output using a stream
185 must have the stream in a variable called printcharfun
186 and must start with PRINTPREPARE, end with PRINTFINISH,
187 and use PRINTDECLARE to declare common variables.
188 Use PRINTCHAR to output one character,
189 or call strout to output a block of characters. */
191 #define PRINTDECLARE \
192 struct buffer *old = current_buffer; \
193 int old_point = -1, start_point = -1; \
194 int old_point_byte = -1, start_point_byte = -1; \
195 int specpdl_count = specpdl_ptr - specpdl; \
196 int free_print_buffer = 0; \
197 int multibyte = !NILP (current_buffer->enable_multibyte_characters); \
200 #define PRINTPREPARE \
201 original = printcharfun; \
202 if (NILP (printcharfun)) printcharfun = Qt; \
203 if (BUFFERP (printcharfun)) \
205 if (XBUFFER (printcharfun) != current_buffer) \
206 Fset_buffer (printcharfun); \
207 printcharfun = Qnil; \
209 if (MARKERP (printcharfun)) \
211 if (!(XMARKER (original)->buffer)) \
212 error ("Marker does not point anywhere"); \
213 if (XMARKER (original)->buffer != current_buffer) \
214 set_buffer_internal (XMARKER (original)->buffer); \
216 old_point_byte = PT_BYTE; \
217 SET_PT_BOTH (marker_position (printcharfun), \
218 marker_byte_position (printcharfun)); \
220 start_point_byte = PT_BYTE; \
221 printcharfun = Qnil; \
223 if (NILP (printcharfun)) \
225 Lisp_Object string; \
226 if (NILP (current_buffer->enable_multibyte_characters) \
227 && ! print_escape_multibyte) \
228 specbind (Qprint_escape_multibyte, Qt); \
229 if (! NILP (current_buffer->enable_multibyte_characters) \
230 && ! print_escape_nonascii) \
231 specbind (Qprint_escape_nonascii, Qt); \
232 if (print_buffer != 0) \
234 string = make_string_from_bytes (print_buffer, \
236 print_buffer_pos_byte); \
237 record_unwind_protect (print_unwind, string); \
241 print_buffer_size = 1000; \
242 print_buffer = (char *) xmalloc (print_buffer_size); \
243 free_print_buffer = 1; \
245 print_buffer_pos = 0; \
246 print_buffer_pos_byte = 0; \
248 if (EQ (printcharfun, Qt) && ! noninteractive) \
249 setup_echo_area_for_printing (multibyte);
251 #define PRINTFINISH \
252 if (NILP (printcharfun)) \
254 if (print_buffer_pos != print_buffer_pos_byte \
255 && NILP (current_buffer->enable_multibyte_characters)) \
257 unsigned char *temp \
258 = (unsigned char *) alloca (print_buffer_pos + 1); \
259 copy_text (print_buffer, temp, print_buffer_pos_byte, \
261 insert_1_both (temp, print_buffer_pos, \
262 print_buffer_pos, 0, 1, 0); \
265 insert_1_both (print_buffer, print_buffer_pos, \
266 print_buffer_pos_byte, 0, 1, 0); \
268 if (free_print_buffer) \
270 xfree (print_buffer); \
273 unbind_to (specpdl_count, Qnil); \
274 if (MARKERP (original)) \
275 set_marker_both (original, Qnil, PT, PT_BYTE); \
276 if (old_point >= 0) \
277 SET_PT_BOTH (old_point + (old_point >= start_point \
278 ? PT - start_point : 0), \
279 old_point_byte + (old_point_byte >= start_point_byte \
280 ? PT_BYTE - start_point_byte : 0)); \
281 if (old != current_buffer) \
282 set_buffer_internal (old);
284 #define PRINTCHAR(ch) printchar (ch, printcharfun)
286 /* This is used to restore the saved contents of print_buffer
287 when there is a recursive call to print. */
290 print_unwind (saved_text
)
291 Lisp_Object saved_text
;
293 bcopy (XSTRING (saved_text
)->data
, print_buffer
, XSTRING (saved_text
)->size
);
298 /* Print character CH using method FUN. FUN nil means print to
299 print_buffer. FUN t means print to echo area or stdout if
300 non-interactive. If FUN is neither nil nor t, call FUN with CH as
308 #ifdef MAX_PRINT_CHARS
311 #endif /* MAX_PRINT_CHARS */
313 if (!NILP (fun
) && !EQ (fun
, Qt
))
314 call1 (fun
, make_number (ch
));
317 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
318 int len
= CHAR_STRING (ch
, str
);
324 if (print_buffer_pos_byte
+ len
>= print_buffer_size
)
325 print_buffer
= (char *) xrealloc (print_buffer
,
326 print_buffer_size
*= 2);
327 bcopy (str
, print_buffer
+ print_buffer_pos_byte
, len
);
328 print_buffer_pos
+= 1;
329 print_buffer_pos_byte
+= len
;
331 else if (noninteractive
)
333 fwrite (str
, 1, len
, stdout
);
334 noninteractive_need_newline
= 1;
339 = !NILP (current_buffer
->enable_multibyte_characters
);
341 setup_echo_area_for_printing (multibyte_p
);
343 message_dolog (str
, len
, 0, multibyte_p
);
349 /* Output SIZE characters, SIZE_BYTE bytes from string PTR using
350 method PRINTCHARFUN. If SIZE < 0, use the string length of PTR for
351 both SIZE and SIZE_BYTE. PRINTCHARFUN nil means output to
352 print_buffer. PRINTCHARFUN t means output to the echo area or to
353 stdout if non-interactive. If neither nil nor t, call Lisp
354 function PRINTCHARFUN for each character printed. MULTIBYTE
355 non-zero means PTR contains multibyte characters. */
358 strout (ptr
, size
, size_byte
, printcharfun
, multibyte
)
361 Lisp_Object printcharfun
;
365 size_byte
= size
= strlen (ptr
);
367 if (NILP (printcharfun
))
369 if (print_buffer_pos_byte
+ size_byte
> print_buffer_size
)
371 print_buffer_size
= print_buffer_size
* 2 + size_byte
;
372 print_buffer
= (char *) xrealloc (print_buffer
,
375 bcopy (ptr
, print_buffer
+ print_buffer_pos_byte
, size_byte
);
376 print_buffer_pos
+= size
;
377 print_buffer_pos_byte
+= size_byte
;
379 #ifdef MAX_PRINT_CHARS
382 #endif /* MAX_PRINT_CHARS */
384 else if (noninteractive
&& EQ (printcharfun
, Qt
))
386 fwrite (ptr
, 1, size_byte
, stdout
);
387 noninteractive_need_newline
= 1;
389 else if (EQ (printcharfun
, Qt
))
391 /* Output to echo area. We're trying to avoid a little overhead
392 here, that's the reason we don't call printchar to do the
396 = !NILP (current_buffer
->enable_multibyte_characters
);
398 setup_echo_area_for_printing (multibyte_p
);
399 message_dolog (ptr
, size_byte
, 0, multibyte_p
);
401 if (size
== size_byte
)
403 for (i
= 0; i
< size
; ++i
)
404 insert_char ((unsigned char )*ptr
++);
409 for (i
= 0; i
< size_byte
; i
+= len
)
411 int ch
= STRING_CHAR_AND_LENGTH (ptr
+ i
, size_byte
- i
, len
);
416 #ifdef MAX_PRINT_CHARS
419 #endif /* MAX_PRINT_CHARS */
423 /* PRINTCHARFUN is a Lisp function. */
426 if (size
== size_byte
)
428 while (i
< size_byte
)
436 while (i
< size_byte
)
438 /* Here, we must convert each multi-byte form to the
439 corresponding character code before handing it to
442 int ch
= STRING_CHAR_AND_LENGTH (ptr
+ i
, size_byte
- i
, len
);
450 /* Print the contents of a string STRING using PRINTCHARFUN.
451 It isn't safe to use strout in many cases,
452 because printing one char can relocate. */
455 print_string (string
, printcharfun
)
457 Lisp_Object printcharfun
;
459 if (EQ (printcharfun
, Qt
) || NILP (printcharfun
))
463 if (print_escape_nonascii
)
464 string
= string_escape_byte8 (string
);
466 if (STRING_MULTIBYTE (string
))
467 chars
= XSTRING (string
)->size
;
468 else if (! print_escape_nonascii
469 && (EQ (printcharfun
, Qt
)
470 ? ! NILP (buffer_defaults
.enable_multibyte_characters
)
471 : ! NILP (current_buffer
->enable_multibyte_characters
)))
473 /* If unibyte string STRING contains 8-bit codes, we must
474 convert STRING to a multibyte string containing the same
479 chars
= STRING_BYTES (XSTRING (string
));
480 bytes
= parse_str_to_multibyte (XSTRING (string
)->data
, chars
);
483 newstr
= make_uninit_multibyte_string (chars
, bytes
);
484 bcopy (XSTRING (string
)->data
, XSTRING (newstr
)->data
, chars
);
485 str_to_multibyte (XSTRING (newstr
)->data
, bytes
, chars
);
490 chars
= STRING_BYTES (XSTRING (string
));
492 /* strout is safe for output to a frame (echo area) or to print_buffer. */
493 strout (XSTRING (string
)->data
,
494 chars
, STRING_BYTES (XSTRING (string
)),
495 printcharfun
, STRING_MULTIBYTE (string
));
499 /* Otherwise, string may be relocated by printing one char.
500 So re-fetch the string address for each character. */
502 int size
= XSTRING (string
)->size
;
503 int size_byte
= STRING_BYTES (XSTRING (string
));
506 if (size
== size_byte
)
507 for (i
= 0; i
< size
; i
++)
508 PRINTCHAR (XSTRING (string
)->data
[i
]);
510 for (i
= 0; i
< size_byte
; i
++)
512 /* Here, we must convert each multi-byte form to the
513 corresponding character code before handing it to PRINTCHAR. */
515 int ch
= STRING_CHAR_AND_LENGTH (XSTRING (string
)->data
+ i
,
517 if (!CHAR_VALID_P (ch
, 0))
519 ch
= XSTRING (string
)->data
[i
];
529 DEFUN ("write-char", Fwrite_char
, Swrite_char
, 1, 2, 0,
530 doc
: /* Output character CHARACTER to stream PRINTCHARFUN.
531 PRINTCHARFUN defaults to the value of `standard-output' (which see). */)
532 (character
, printcharfun
)
533 Lisp_Object character
, printcharfun
;
537 if (NILP (printcharfun
))
538 printcharfun
= Vstandard_output
;
539 CHECK_NUMBER (character
);
541 PRINTCHAR (XINT (character
));
546 /* Used from outside of print.c to print a block of SIZE
547 single-byte chars at DATA on the default output stream.
548 Do not use this on the contents of a Lisp string. */
551 write_string (data
, size
)
556 Lisp_Object printcharfun
;
558 printcharfun
= Vstandard_output
;
561 strout (data
, size
, size
, printcharfun
, 0);
565 /* Used from outside of print.c to print a block of SIZE
566 single-byte chars at DATA on a specified stream PRINTCHARFUN.
567 Do not use this on the contents of a Lisp string. */
570 write_string_1 (data
, size
, printcharfun
)
573 Lisp_Object printcharfun
;
578 strout (data
, size
, size
, printcharfun
, 0);
584 temp_output_buffer_setup (bufname
)
587 int count
= specpdl_ptr
- specpdl
;
588 register struct buffer
*old
= current_buffer
;
589 register Lisp_Object buf
;
591 record_unwind_protect (set_buffer_if_live
, Fcurrent_buffer ());
593 Fset_buffer (Fget_buffer_create (build_string (bufname
)));
595 current_buffer
->directory
= old
->directory
;
596 current_buffer
->read_only
= Qnil
;
597 current_buffer
->filename
= Qnil
;
598 current_buffer
->undo_list
= Qt
;
599 current_buffer
->overlays_before
= Qnil
;
600 current_buffer
->overlays_after
= Qnil
;
601 current_buffer
->enable_multibyte_characters
602 = buffer_defaults
.enable_multibyte_characters
;
604 XSETBUFFER (buf
, current_buffer
);
606 Frun_hooks (1, &Qtemp_buffer_setup_hook
);
608 unbind_to (count
, Qnil
);
610 specbind (Qstandard_output
, buf
);
614 internal_with_output_to_temp_buffer (bufname
, function
, args
)
616 Lisp_Object (*function
) P_ ((Lisp_Object
));
619 int count
= specpdl_ptr
- specpdl
;
620 Lisp_Object buf
, val
;
624 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
625 temp_output_buffer_setup (bufname
);
626 buf
= Vstandard_output
;
629 val
= (*function
) (args
);
632 temp_output_buffer_show (buf
);
635 return unbind_to (count
, val
);
638 DEFUN ("with-output-to-temp-buffer",
639 Fwith_output_to_temp_buffer
, Swith_output_to_temp_buffer
,
641 doc
: /* Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
642 The buffer is cleared out initially, and marked as unmodified when done.
643 All output done by BODY is inserted in that buffer by default.
644 The buffer is displayed in another window, but not selected.
645 The value of the last form in BODY is returned.
646 If BODY does not finish normally, the buffer BUFNAME is not displayed.
648 The hook `temp-buffer-setup-hook' is run before BODY,
649 with the buffer BUFNAME temporarily current.
650 The hook `temp-buffer-show-hook' is run after the buffer is displayed,
651 with the buffer temporarily current, and the window that was used
652 to display it temporarily selected.
654 If variable `temp-buffer-show-function' is non-nil, call it at the end
655 to get the buffer displayed instead of just displaying the non-selected
656 buffer and calling the hook. It gets one argument, the buffer to display.
658 usage: (with-output-to-temp-buffer BUFFNAME BODY ...) */)
664 int count
= specpdl_ptr
- specpdl
;
665 Lisp_Object buf
, val
;
668 name
= Feval (Fcar (args
));
670 temp_output_buffer_setup (XSTRING (name
)->data
);
671 buf
= Vstandard_output
;
674 val
= Fprogn (XCDR (args
));
677 temp_output_buffer_show (buf
);
680 return unbind_to (count
, val
);
684 static void print ();
685 static void print_preprocess ();
686 static void print_preprocess_string ();
687 static void print_object ();
689 DEFUN ("terpri", Fterpri
, Sterpri
, 0, 1, 0,
690 doc
: /* Output a newline to stream PRINTCHARFUN.
691 If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used. */)
693 Lisp_Object printcharfun
;
697 if (NILP (printcharfun
))
698 printcharfun
= Vstandard_output
;
705 DEFUN ("prin1", Fprin1
, Sprin1
, 1, 2, 0,
706 doc
: /* Output the printed representation of OBJECT, any Lisp object.
707 Quoting characters are printed when needed to make output that `read'
708 can handle, whenever this is possible. For complex objects, the behavior
709 is controlled by `print-level' and `print-length', which see.
711 OBJECT is any of the Lisp data types: a number, a string, a symbol,
712 a list, a buffer, a window, a frame, etc.
714 A printed representation of an object is text which describes that object.
716 Optional argument PRINTCHARFUN is the output stream, which can be one
719 - a buffer, in which case output is inserted into that buffer at point;
720 - a marker, in which case output is inserted at marker's position;
721 - a function, in which case that function is called once for each
722 character of OBJECT's printed representation;
723 - a symbol, in which case that symbol's function definition is called; or
724 - t, in which case the output is displayed in the echo area.
726 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
728 (object
, printcharfun
)
729 Lisp_Object object
, printcharfun
;
733 #ifdef MAX_PRINT_CHARS
735 #endif /* MAX_PRINT_CHARS */
736 if (NILP (printcharfun
))
737 printcharfun
= Vstandard_output
;
739 print (object
, printcharfun
, 1);
744 /* a buffer which is used to hold output being built by prin1-to-string */
745 Lisp_Object Vprin1_to_string_buffer
;
747 DEFUN ("prin1-to-string", Fprin1_to_string
, Sprin1_to_string
, 1, 2, 0,
748 doc
: /* Return a string containing the printed representation of OBJECT.
749 OBJECT can be any Lisp object. This function outputs quoting characters
750 when necessary to make output that `read' can handle, whenever possible,
751 unless the optional second argument NOESCAPE is non-nil.
753 OBJECT is any of the Lisp data types: a number, a string, a symbol,
754 a list, a buffer, a window, a frame, etc.
756 A printed representation of an object is text which describes that object. */)
758 Lisp_Object object
, noescape
;
761 Lisp_Object printcharfun
;
762 struct gcpro gcpro1
, gcpro2
;
765 /* Save and restore this--we are altering a buffer
766 but we don't want to deactivate the mark just for that.
767 No need for specbind, since errors deactivate the mark. */
768 tem
= Vdeactivate_mark
;
769 GCPRO2 (object
, tem
);
771 printcharfun
= Vprin1_to_string_buffer
;
773 print (object
, printcharfun
, NILP (noescape
));
774 /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
776 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer
));
777 object
= Fbuffer_string ();
780 set_buffer_internal (old
);
782 Vdeactivate_mark
= tem
;
788 DEFUN ("princ", Fprinc
, Sprinc
, 1, 2, 0,
789 doc
: /* Output the printed representation of OBJECT, any Lisp object.
790 No quoting characters are used; no delimiters are printed around
791 the contents of strings.
793 OBJECT is any of the Lisp data types: a number, a string, a symbol,
794 a list, a buffer, a window, a frame, etc.
796 A printed representation of an object is text which describes that object.
798 Optional argument PRINTCHARFUN is the output stream, which can be one
801 - a buffer, in which case output is inserted into that buffer at point;
802 - a marker, in which case output is inserted at marker's position;
803 - a function, in which case that function is called once for each
804 character of OBJECT's printed representation;
805 - a symbol, in which case that symbol's function definition is called; or
806 - t, in which case the output is displayed in the echo area.
808 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
810 (object
, printcharfun
)
811 Lisp_Object object
, printcharfun
;
815 if (NILP (printcharfun
))
816 printcharfun
= Vstandard_output
;
818 print (object
, printcharfun
, 0);
823 DEFUN ("print", Fprint
, Sprint
, 1, 2, 0,
824 doc
: /* Output the printed representation of OBJECT, with newlines around it.
825 Quoting characters are printed when needed to make output that `read'
826 can handle, whenever this is possible. For complex objects, the behavior
827 is controlled by `print-level' and `print-length', which see.
829 OBJECT is any of the Lisp data types: a number, a string, a symbol,
830 a list, a buffer, a window, a frame, etc.
832 A printed representation of an object is text which describes that object.
834 Optional argument PRINTCHARFUN is the output stream, which can be one
837 - a buffer, in which case output is inserted into that buffer at point;
838 - a marker, in which case output is inserted at marker's position;
839 - a function, in which case that function is called once for each
840 character of OBJECT's printed representation;
841 - a symbol, in which case that symbol's function definition is called; or
842 - t, in which case the output is displayed in the echo area.
844 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
846 (object
, printcharfun
)
847 Lisp_Object object
, printcharfun
;
852 #ifdef MAX_PRINT_CHARS
854 max_print
= MAX_PRINT_CHARS
;
855 #endif /* MAX_PRINT_CHARS */
856 if (NILP (printcharfun
))
857 printcharfun
= Vstandard_output
;
861 print (object
, printcharfun
, 1);
864 #ifdef MAX_PRINT_CHARS
867 #endif /* MAX_PRINT_CHARS */
872 /* The subroutine object for external-debugging-output is kept here
873 for the convenience of the debugger. */
874 Lisp_Object Qexternal_debugging_output
;
876 DEFUN ("external-debugging-output", Fexternal_debugging_output
, Sexternal_debugging_output
, 1, 1, 0,
877 doc
: /* Write CHARACTER to stderr.
878 You can call print while debugging emacs, and pass it this function
879 to make it write to the debugging output. */)
881 Lisp_Object character
;
883 CHECK_NUMBER (character
);
884 putc (XINT (character
), stderr
);
887 /* Send the output to a debugger (nothing happens if there isn't one). */
889 char buf
[2] = {(char) XINT (character
), '\0'};
890 OutputDebugString (buf
);
897 /* This is the interface for debugging printing. */
903 Fprin1 (arg
, Qexternal_debugging_output
);
904 fprintf (stderr
, "\r\n");
907 DEFUN ("error-message-string", Ferror_message_string
, Serror_message_string
,
909 doc
: /* Convert an error value (ERROR-SYMBOL . DATA) to an error message. */)
913 struct buffer
*old
= current_buffer
;
917 /* If OBJ is (error STRING), just return STRING.
918 That is not only faster, it also avoids the need to allocate
919 space here when the error is due to memory full. */
920 if (CONSP (obj
) && EQ (XCAR (obj
), Qerror
)
921 && CONSP (XCDR (obj
))
922 && STRINGP (XCAR (XCDR (obj
)))
923 && NILP (XCDR (XCDR (obj
))))
924 return XCAR (XCDR (obj
));
926 print_error_message (obj
, Vprin1_to_string_buffer
);
928 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer
));
929 value
= Fbuffer_string ();
933 set_buffer_internal (old
);
939 /* Print an error message for the error DATA onto Lisp output stream
940 STREAM (suitable for the print functions). */
943 print_error_message (data
, stream
)
944 Lisp_Object data
, stream
;
946 Lisp_Object errname
, errmsg
, file_error
, tail
;
950 errname
= Fcar (data
);
952 if (EQ (errname
, Qerror
))
957 errmsg
= Fcar (data
);
962 Lisp_Object error_conditions
;
963 errmsg
= Fget (errname
, Qerror_message
);
964 error_conditions
= Fget (errname
, Qerror_conditions
);
965 file_error
= Fmemq (Qfile_error
, error_conditions
);
968 /* Print an error message including the data items. */
970 tail
= Fcdr_safe (data
);
973 /* If we know from where the error was signaled, show it in
975 if (!NILP (Vsignaling_function
) && SYMBOLP (Vsignaling_function
))
977 char *name
= XSYMBOL (Vsignaling_function
)->name
->data
;
978 message_dolog (name
, strlen (name
), 0, 0);
979 message_dolog (": ", 2, 0, 0);
980 Vsignaling_function
= Qnil
;
983 /* For file-error, make error message by concatenating
984 all the data items. They are all strings. */
985 if (!NILP (file_error
) && CONSP (tail
))
986 errmsg
= XCAR (tail
), tail
= XCDR (tail
);
988 if (STRINGP (errmsg
))
989 Fprinc (errmsg
, stream
);
991 write_string_1 ("peculiar error", -1, stream
);
993 for (i
= 0; CONSP (tail
); tail
= XCDR (tail
), i
++)
997 write_string_1 (i
? ", " : ": ", 2, stream
);
999 if (!NILP (file_error
) || EQ (errname
, Qend_of_file
))
1000 Fprinc (obj
, stream
);
1002 Fprin1 (obj
, stream
);
1011 * The buffer should be at least as large as the max string size of the
1012 * largest float, printed in the biggest notation. This is undoubtedly
1013 * 20d float_output_format, with the negative of the C-constant "HUGE"
1016 * On the vax the worst case is -1e38 in 20d format which takes 61 bytes.
1018 * I assume that IEEE-754 format numbers can take 329 bytes for the worst
1019 * case of -1e307 in 20d float_output_format. What is one to do (short of
1020 * re-writing _doprnt to be more sane)?
1025 float_to_string (buf
, data
)
1032 /* Check for plus infinity in a way that won't lose
1033 if there is no plus infinity. */
1034 if (data
== data
/ 2 && data
> 1.0)
1036 strcpy (buf
, "1.0e+INF");
1039 /* Likewise for minus infinity. */
1040 if (data
== data
/ 2 && data
< -1.0)
1042 strcpy (buf
, "-1.0e+INF");
1045 /* Check for NaN in a way that won't fail if there are no NaNs. */
1046 if (! (data
* 0.0 >= 0.0))
1048 /* Prepend "-" if the NaN's sign bit is negative.
1049 The sign bit of a double is the bit that is 1 in -0.0. */
1051 union { double d
; char c
[sizeof (double)]; } u_data
, u_minus_zero
;
1053 u_minus_zero
.d
= - 0.0;
1054 for (i
= 0; i
< sizeof (double); i
++)
1055 if (u_data
.c
[i
] & u_minus_zero
.c
[i
])
1061 strcpy (buf
, "0.0e+NaN");
1065 if (NILP (Vfloat_output_format
)
1066 || !STRINGP (Vfloat_output_format
))
1069 /* Generate the fewest number of digits that represent the
1070 floating point value without losing information.
1071 The following method is simple but a bit slow.
1072 For ideas about speeding things up, please see:
1074 Guy L Steele Jr & Jon L White, How to print floating-point numbers
1075 accurately. SIGPLAN notices 25, 6 (June 1990), 112-126.
1077 Robert G Burger & R Kent Dybvig, Printing floating point numbers
1078 quickly and accurately, SIGPLAN notices 31, 5 (May 1996), 108-116. */
1080 width
= fabs (data
) < DBL_MIN
? 1 : DBL_DIG
;
1082 sprintf (buf
, "%.*g", width
, data
);
1083 while (width
++ < DOUBLE_DIGITS_BOUND
&& atof (buf
) != data
);
1085 else /* oink oink */
1087 /* Check that the spec we have is fully valid.
1088 This means not only valid for printf,
1089 but meant for floats, and reasonable. */
1090 cp
= XSTRING (Vfloat_output_format
)->data
;
1099 /* Check the width specification. */
1101 if ('0' <= *cp
&& *cp
<= '9')
1105 width
= (width
* 10) + (*cp
++ - '0');
1106 while (*cp
>= '0' && *cp
<= '9');
1108 /* A precision of zero is valid only for %f. */
1110 || (width
== 0 && *cp
!= 'f'))
1114 if (*cp
!= 'e' && *cp
!= 'f' && *cp
!= 'g')
1120 sprintf (buf
, XSTRING (Vfloat_output_format
)->data
, data
);
1123 /* Make sure there is a decimal point with digit after, or an
1124 exponent, so that the value is readable as a float. But don't do
1125 this with "%.0f"; it's valid for that not to produce a decimal
1126 point. Note that width can be 0 only for %.0f. */
1129 for (cp
= buf
; *cp
; cp
++)
1130 if ((*cp
< '0' || *cp
> '9') && *cp
!= '-')
1133 if (*cp
== '.' && cp
[1] == 0)
1150 print (obj
, printcharfun
, escapeflag
)
1152 register Lisp_Object printcharfun
;
1157 /* Reset print_number_index and Vprint_number_table only when
1158 the variable Vprint_continuous_numbering is nil. Otherwise,
1159 the values of these variables will be kept between several
1161 if (NILP (Vprint_continuous_numbering
))
1163 print_number_index
= 0;
1164 Vprint_number_table
= Qnil
;
1167 /* Construct Vprint_number_table for print-gensym and print-circle. */
1168 if (!NILP (Vprint_gensym
) || !NILP (Vprint_circle
))
1170 int i
, start
, index
;
1171 /* Construct Vprint_number_table. */
1172 start
= index
= print_number_index
;
1173 print_preprocess (obj
);
1174 /* Remove unnecessary objects, which appear only once in OBJ;
1175 that is, whose status is Qnil. */
1176 for (i
= start
; i
< print_number_index
; i
++)
1177 if (!NILP (PRINT_NUMBER_STATUS (Vprint_number_table
, i
)))
1179 PRINT_NUMBER_OBJECT (Vprint_number_table
, index
)
1180 = PRINT_NUMBER_OBJECT (Vprint_number_table
, i
);
1181 /* Reset the status field for the next print step. Now this
1182 field means whether the object has already been printed. */
1183 PRINT_NUMBER_STATUS (Vprint_number_table
, index
) = Qnil
;
1186 print_number_index
= index
;
1189 print_object (obj
, printcharfun
, escapeflag
);
1192 /* Construct Vprint_number_table according to the structure of OBJ.
1193 OBJ itself and all its elements will be added to Vprint_number_table
1194 recursively if it is a list, vector, compiled function, char-table,
1195 string (its text properties will be traced), or a symbol that has
1196 no obarray (this is for the print-gensym feature).
1197 The status fields of Vprint_number_table mean whether each object appears
1198 more than once in OBJ: Qnil at the first time, and Qt after that . */
1200 print_preprocess (obj
)
1206 if (STRINGP (obj
) || CONSP (obj
) || VECTORP (obj
)
1207 || COMPILEDP (obj
) || CHAR_TABLE_P (obj
)
1208 || (! NILP (Vprint_gensym
)
1210 && !SYMBOL_INTERNED_P (obj
)))
1212 /* In case print-circle is nil and print-gensym is t,
1213 add OBJ to Vprint_number_table only when OBJ is a symbol. */
1214 if (! NILP (Vprint_circle
) || SYMBOLP (obj
))
1216 for (i
= 0; i
< print_number_index
; i
++)
1217 if (EQ (PRINT_NUMBER_OBJECT (Vprint_number_table
, i
), obj
))
1219 /* OBJ appears more than once. Let's remember that. */
1220 PRINT_NUMBER_STATUS (Vprint_number_table
, i
) = Qt
;
1224 /* OBJ is not yet recorded. Let's add to the table. */
1225 if (print_number_index
== 0)
1227 /* Initialize the table. */
1228 Vprint_number_table
= Fmake_vector (make_number (40), Qnil
);
1230 else if (XVECTOR (Vprint_number_table
)->size
== print_number_index
* 2)
1232 /* Reallocate the table. */
1233 int i
= print_number_index
* 4;
1234 Lisp_Object old_table
= Vprint_number_table
;
1235 Vprint_number_table
= Fmake_vector (make_number (i
), Qnil
);
1236 for (i
= 0; i
< print_number_index
; i
++)
1238 PRINT_NUMBER_OBJECT (Vprint_number_table
, i
)
1239 = PRINT_NUMBER_OBJECT (old_table
, i
);
1240 PRINT_NUMBER_STATUS (Vprint_number_table
, i
)
1241 = PRINT_NUMBER_STATUS (old_table
, i
);
1244 PRINT_NUMBER_OBJECT (Vprint_number_table
, print_number_index
) = obj
;
1245 /* If Vprint_continuous_numbering is non-nil and OBJ is a gensym,
1246 always print the gensym with a number. This is a special for
1247 the lisp function byte-compile-output-docform. */
1248 if (!NILP (Vprint_continuous_numbering
)
1250 && !SYMBOL_INTERNED_P (obj
))
1251 PRINT_NUMBER_STATUS (Vprint_number_table
, print_number_index
) = Qt
;
1252 print_number_index
++;
1255 switch (XGCTYPE (obj
))
1258 /* A string may have text properties, which can be circular. */
1259 traverse_intervals_noorder (XSTRING (obj
)->intervals
,
1260 print_preprocess_string
, Qnil
);
1264 print_preprocess (XCAR (obj
));
1268 case Lisp_Vectorlike
:
1269 size
= XVECTOR (obj
)->size
& PSEUDOVECTOR_SIZE_MASK
;
1270 for (i
= 0; i
< size
; i
++)
1271 print_preprocess (XVECTOR (obj
)->contents
[i
]);
1281 print_preprocess_string (interval
, arg
)
1285 print_preprocess (interval
->plist
);
1289 print_object (obj
, printcharfun
, escapeflag
)
1291 register Lisp_Object printcharfun
;
1298 /* Detect circularities and truncate them. */
1299 if (STRINGP (obj
) || CONSP (obj
) || VECTORP (obj
)
1300 || COMPILEDP (obj
) || CHAR_TABLE_P (obj
)
1301 || (! NILP (Vprint_gensym
)
1303 && !SYMBOL_INTERNED_P (obj
)))
1305 if (NILP (Vprint_circle
) && NILP (Vprint_gensym
))
1307 /* Simple but incomplete way. */
1309 for (i
= 0; i
< print_depth
; i
++)
1310 if (EQ (obj
, being_printed
[i
]))
1312 sprintf (buf
, "#%d", i
);
1313 strout (buf
, -1, -1, printcharfun
, 0);
1316 being_printed
[print_depth
] = obj
;
1320 /* With the print-circle feature. */
1322 for (i
= 0; i
< print_number_index
; i
++)
1323 if (EQ (PRINT_NUMBER_OBJECT (Vprint_number_table
, i
), obj
))
1325 if (NILP (PRINT_NUMBER_STATUS (Vprint_number_table
, i
)))
1327 /* Add a prefix #n= if OBJ has not yet been printed;
1328 that is, its status field is nil. */
1329 sprintf (buf
, "#%d=", i
+ 1);
1330 strout (buf
, -1, -1, printcharfun
, 0);
1331 /* OBJ is going to be printed. Set the status to t. */
1332 PRINT_NUMBER_STATUS (Vprint_number_table
, i
) = Qt
;
1337 /* Just print #n# if OBJ has already been printed. */
1338 sprintf (buf
, "#%d#", i
+ 1);
1339 strout (buf
, -1, -1, printcharfun
, 0);
1348 if (print_depth
> PRINT_CIRCLE
)
1349 error ("Apparently circular structure being printed");
1350 #ifdef MAX_PRINT_CHARS
1351 if (max_print
&& print_chars
> max_print
)
1356 #endif /* MAX_PRINT_CHARS */
1358 switch (XGCTYPE (obj
))
1361 if (sizeof (int) == sizeof (EMACS_INT
))
1362 sprintf (buf
, "%d", XINT (obj
));
1363 else if (sizeof (long) == sizeof (EMACS_INT
))
1364 sprintf (buf
, "%ld", (long) XINT (obj
));
1367 strout (buf
, -1, -1, printcharfun
, 0);
1372 char pigbuf
[350]; /* see comments in float_to_string */
1374 float_to_string (pigbuf
, XFLOAT_DATA (obj
));
1375 strout (pigbuf
, -1, -1, printcharfun
, 0);
1381 print_string (obj
, printcharfun
);
1384 register int i
, i_byte
;
1385 struct gcpro gcpro1
;
1388 /* 1 means we must ensure that the next character we output
1389 cannot be taken as part of a hex character escape. */
1390 int need_nonhex
= 0;
1391 int multibyte
= STRING_MULTIBYTE (obj
);
1395 if (!NULL_INTERVAL_P (XSTRING (obj
)->intervals
))
1402 str
= XSTRING (obj
)->data
;
1403 size_byte
= STRING_BYTES (XSTRING (obj
));
1405 for (i
= 0, i_byte
= 0; i_byte
< size_byte
;)
1407 /* Here, we must convert each multi-byte form to the
1408 corresponding character code before handing it to PRINTCHAR. */
1414 c
= STRING_CHAR_AND_LENGTH (str
+ i_byte
,
1415 size_byte
- i_byte
, len
);
1423 if (c
== '\n' && print_escape_newlines
)
1428 else if (c
== '\f' && print_escape_newlines
)
1433 else if (multibyte
&& ! ASCII_BYTE_P (c
)
1434 && (print_escape_multibyte
|| CHAR_BYTE8_P (c
)))
1436 /* When multibyte is disabled,
1437 print multibyte string chars using hex escapes. */
1438 unsigned char outbuf
[50];
1440 if (CHAR_BYTE8_P (c
))
1441 sprintf (outbuf
, "\\%03o", CHAR_TO_BYTE8 (c
));
1443 sprintf (outbuf
, "\\x%04x", c
);
1444 strout (outbuf
, -1, -1, printcharfun
, 0);
1447 else if (! multibyte
1448 && SINGLE_BYTE_CHAR_P (c
) && ! ASCII_BYTE_P (c
)
1449 && print_escape_nonascii
)
1451 /* When printing in a multibyte buffer
1452 or when explicitly requested,
1453 print single-byte non-ASCII string chars
1454 using octal escapes. */
1455 unsigned char outbuf
[5];
1456 sprintf (outbuf
, "\\%03o", c
);
1457 strout (outbuf
, -1, -1, printcharfun
, 0);
1461 /* If we just had a hex escape, and this character
1462 could be taken as part of it,
1463 output `\ ' to prevent that. */
1467 if ((c
>= 'a' && c
<= 'f')
1468 || (c
>= 'A' && c
<= 'F')
1469 || (c
>= '0' && c
<= '9'))
1470 strout ("\\ ", -1, -1, printcharfun
, 0);
1473 if (c
== '\"' || c
== '\\')
1480 if (!NULL_INTERVAL_P (XSTRING (obj
)->intervals
))
1482 traverse_intervals (XSTRING (obj
)->intervals
,
1483 0, print_interval
, printcharfun
);
1493 register int confusing
;
1494 register unsigned char *p
= XSYMBOL (obj
)->name
->data
;
1495 register unsigned char *end
= p
+ STRING_BYTES (XSYMBOL (obj
)->name
);
1497 int i
, i_byte
, size_byte
;
1500 XSETSTRING (name
, XSYMBOL (obj
)->name
);
1502 if (p
!= end
&& (*p
== '-' || *p
== '+')) p
++;
1505 /* If symbol name begins with a digit, and ends with a digit,
1506 and contains nothing but digits and `e', it could be treated
1507 as a number. So set CONFUSING.
1509 Symbols that contain periods could also be taken as numbers,
1510 but periods are always escaped, so we don't have to worry
1512 else if (*p
>= '0' && *p
<= '9'
1513 && end
[-1] >= '0' && end
[-1] <= '9')
1515 while (p
!= end
&& ((*p
>= '0' && *p
<= '9')
1516 /* Needed for \2e10. */
1519 confusing
= (end
== p
);
1524 if (! NILP (Vprint_gensym
) && !SYMBOL_INTERNED_P (obj
))
1530 size_byte
= STRING_BYTES (XSTRING (name
));
1532 for (i
= 0, i_byte
= 0; i_byte
< size_byte
;)
1534 /* Here, we must convert each multi-byte form to the
1535 corresponding character code before handing it to PRINTCHAR. */
1536 FETCH_STRING_CHAR_ADVANCE (c
, name
, i
, i_byte
);
1541 if (c
== '\"' || c
== '\\' || c
== '\''
1542 || c
== ';' || c
== '#' || c
== '(' || c
== ')'
1543 || c
== ',' || c
=='.' || c
== '`'
1544 || c
== '[' || c
== ']' || c
== '?' || c
<= 040
1546 PRINTCHAR ('\\'), confusing
= 0;
1554 /* If deeper than spec'd depth, print placeholder. */
1555 if (INTEGERP (Vprint_level
)
1556 && print_depth
> XINT (Vprint_level
))
1557 strout ("...", -1, -1, printcharfun
, 0);
1558 else if (print_quoted
&& CONSP (XCDR (obj
)) && NILP (XCDR (XCDR (obj
)))
1559 && (EQ (XCAR (obj
), Qquote
)))
1562 print_object (XCAR (XCDR (obj
)), printcharfun
, escapeflag
);
1564 else if (print_quoted
&& CONSP (XCDR (obj
)) && NILP (XCDR (XCDR (obj
)))
1565 && (EQ (XCAR (obj
), Qfunction
)))
1569 print_object (XCAR (XCDR (obj
)), printcharfun
, escapeflag
);
1571 else if (print_quoted
&& CONSP (XCDR (obj
)) && NILP (XCDR (XCDR (obj
)))
1572 && ((EQ (XCAR (obj
), Qbackquote
)
1573 || EQ (XCAR (obj
), Qcomma
)
1574 || EQ (XCAR (obj
), Qcomma_at
)
1575 || EQ (XCAR (obj
), Qcomma_dot
))))
1577 print_object (XCAR (obj
), printcharfun
, 0);
1578 print_object (XCAR (XCDR (obj
)), printcharfun
, escapeflag
);
1584 int print_length
, i
;
1585 Lisp_Object halftail
= obj
;
1587 /* Negative values of print-length are invalid in CL.
1588 Treat them like nil, as CMUCL does. */
1589 if (NATNUMP (Vprint_length
))
1590 print_length
= XFASTINT (Vprint_length
);
1597 /* Detect circular list. */
1598 if (NILP (Vprint_circle
))
1600 /* Simple but imcomplete way. */
1601 if (i
!= 0 && EQ (obj
, halftail
))
1603 sprintf (buf
, " . #%d", i
/ 2);
1604 strout (buf
, -1, -1, printcharfun
, 0);
1610 /* With the print-circle feature. */
1614 for (i
= 0; i
< print_number_index
; i
++)
1615 if (EQ (PRINT_NUMBER_OBJECT (Vprint_number_table
, i
),
1618 if (NILP (PRINT_NUMBER_STATUS (Vprint_number_table
, i
)))
1620 strout (" . ", 3, 3, printcharfun
, 0);
1621 print_object (obj
, printcharfun
, escapeflag
);
1625 sprintf (buf
, " . #%d#", i
+ 1);
1626 strout (buf
, -1, -1, printcharfun
, 0);
1636 if (print_length
&& i
> print_length
)
1638 strout ("...", 3, 3, printcharfun
, 0);
1642 print_object (XCAR (obj
), printcharfun
, escapeflag
);
1646 halftail
= XCDR (halftail
);
1650 /* OBJ non-nil here means it's the end of a dotted list. */
1653 strout (" . ", 3, 3, printcharfun
, 0);
1654 print_object (obj
, printcharfun
, escapeflag
);
1662 case Lisp_Vectorlike
:
1667 strout ("#<process ", -1, -1, printcharfun
, 0);
1668 print_string (XPROCESS (obj
)->name
, printcharfun
);
1672 print_string (XPROCESS (obj
)->name
, printcharfun
);
1674 else if (BOOL_VECTOR_P (obj
))
1677 register unsigned char c
;
1678 struct gcpro gcpro1
;
1680 = (XBOOL_VECTOR (obj
)->size
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
;
1686 if (sizeof (int) == sizeof (EMACS_INT
))
1687 sprintf (buf
, "%d", XBOOL_VECTOR (obj
)->size
);
1688 else if (sizeof (long) == sizeof (EMACS_INT
))
1689 sprintf (buf
, "%ld", XBOOL_VECTOR (obj
)->size
);
1692 strout (buf
, -1, -1, printcharfun
, 0);
1695 /* Don't print more characters than the specified maximum.
1696 Negative values of print-length are invalid. Treat them
1697 like a print-length of nil. */
1698 if (NATNUMP (Vprint_length
)
1699 && XFASTINT (Vprint_length
) < size_in_chars
)
1700 size_in_chars
= XFASTINT (Vprint_length
);
1702 for (i
= 0; i
< size_in_chars
; i
++)
1705 c
= XBOOL_VECTOR (obj
)->data
[i
];
1706 if (c
== '\n' && print_escape_newlines
)
1711 else if (c
== '\f' && print_escape_newlines
)
1718 if (c
== '\"' || c
== '\\')
1727 else if (SUBRP (obj
))
1729 strout ("#<subr ", -1, -1, printcharfun
, 0);
1730 strout (XSUBR (obj
)->symbol_name
, -1, -1, printcharfun
, 0);
1733 else if (WINDOWP (obj
))
1735 strout ("#<window ", -1, -1, printcharfun
, 0);
1736 sprintf (buf
, "%d", XFASTINT (XWINDOW (obj
)->sequence_number
));
1737 strout (buf
, -1, -1, printcharfun
, 0);
1738 if (!NILP (XWINDOW (obj
)->buffer
))
1740 strout (" on ", -1, -1, printcharfun
, 0);
1741 print_string (XBUFFER (XWINDOW (obj
)->buffer
)->name
, printcharfun
);
1745 else if (HASH_TABLE_P (obj
))
1747 struct Lisp_Hash_Table
*h
= XHASH_TABLE (obj
);
1748 strout ("#<hash-table", -1, -1, printcharfun
, 0);
1749 if (SYMBOLP (h
->test
))
1753 strout (XSYMBOL (h
->test
)->name
->data
, -1, -1, printcharfun
, 0);
1755 strout (XSYMBOL (h
->weak
)->name
->data
, -1, -1, printcharfun
, 0);
1757 sprintf (buf
, "%d/%d", XFASTINT (h
->count
),
1758 XVECTOR (h
->next
)->size
);
1759 strout (buf
, -1, -1, printcharfun
, 0);
1761 sprintf (buf
, " 0x%lx", (unsigned long) h
);
1762 strout (buf
, -1, -1, printcharfun
, 0);
1765 else if (BUFFERP (obj
))
1767 if (NILP (XBUFFER (obj
)->name
))
1768 strout ("#<killed buffer>", -1, -1, printcharfun
, 0);
1769 else if (escapeflag
)
1771 strout ("#<buffer ", -1, -1, printcharfun
, 0);
1772 print_string (XBUFFER (obj
)->name
, printcharfun
);
1776 print_string (XBUFFER (obj
)->name
, printcharfun
);
1778 else if (WINDOW_CONFIGURATIONP (obj
))
1780 strout ("#<window-configuration>", -1, -1, printcharfun
, 0);
1782 else if (FRAMEP (obj
))
1784 strout ((FRAME_LIVE_P (XFRAME (obj
))
1785 ? "#<frame " : "#<dead frame "),
1786 -1, -1, printcharfun
, 0);
1787 print_string (XFRAME (obj
)->name
, printcharfun
);
1788 sprintf (buf
, " 0x%lx\\ ", (unsigned long) (XFRAME (obj
)));
1789 strout (buf
, -1, -1, printcharfun
, 0);
1794 int size
= XVECTOR (obj
)->size
;
1795 if (COMPILEDP (obj
))
1798 size
&= PSEUDOVECTOR_SIZE_MASK
;
1800 if (CHAR_TABLE_P (obj
) || SUB_CHAR_TABLE_P (obj
))
1802 /* We print a char-table as if it were a vector,
1803 lumping the parent and default slots in with the
1804 character slots. But we add #^ as a prefix. */
1807 if (SUB_CHAR_TABLE_P (obj
))
1809 size
&= PSEUDOVECTOR_SIZE_MASK
;
1811 if (size
& PSEUDOVECTOR_FLAG
)
1817 register Lisp_Object tem
;
1818 int real_size
= size
;
1820 /* Don't print more elements than the specified maximum. */
1821 if (NATNUMP (Vprint_length
)
1822 && XFASTINT (Vprint_length
) < size
)
1823 size
= XFASTINT (Vprint_length
);
1825 for (i
= 0; i
< size
; i
++)
1827 if (i
) PRINTCHAR (' ');
1828 tem
= XVECTOR (obj
)->contents
[i
];
1829 print_object (tem
, printcharfun
, escapeflag
);
1831 if (size
< real_size
)
1832 strout (" ...", 4, 4, printcharfun
, 0);
1839 switch (XMISCTYPE (obj
))
1841 case Lisp_Misc_Marker
:
1842 strout ("#<marker ", -1, -1, printcharfun
, 0);
1843 /* Do you think this is necessary? */
1844 if (XMARKER (obj
)->insertion_type
!= 0)
1845 strout ("(moves after insertion) ", -1, -1, printcharfun
, 0);
1846 if (!(XMARKER (obj
)->buffer
))
1847 strout ("in no buffer", -1, -1, printcharfun
, 0);
1850 sprintf (buf
, "at %d", marker_position (obj
));
1851 strout (buf
, -1, -1, printcharfun
, 0);
1852 strout (" in ", -1, -1, printcharfun
, 0);
1853 print_string (XMARKER (obj
)->buffer
->name
, printcharfun
);
1858 case Lisp_Misc_Overlay
:
1859 strout ("#<overlay ", -1, -1, printcharfun
, 0);
1860 if (!(XMARKER (OVERLAY_START (obj
))->buffer
))
1861 strout ("in no buffer", -1, -1, printcharfun
, 0);
1864 sprintf (buf
, "from %d to %d in ",
1865 marker_position (OVERLAY_START (obj
)),
1866 marker_position (OVERLAY_END (obj
)));
1867 strout (buf
, -1, -1, printcharfun
, 0);
1868 print_string (XMARKER (OVERLAY_START (obj
))->buffer
->name
,
1874 /* Remaining cases shouldn't happen in normal usage, but let's print
1875 them anyway for the benefit of the debugger. */
1876 case Lisp_Misc_Free
:
1877 strout ("#<misc free cell>", -1, -1, printcharfun
, 0);
1880 case Lisp_Misc_Intfwd
:
1881 sprintf (buf
, "#<intfwd to %d>", *XINTFWD (obj
)->intvar
);
1882 strout (buf
, -1, -1, printcharfun
, 0);
1885 case Lisp_Misc_Boolfwd
:
1886 sprintf (buf
, "#<boolfwd to %s>",
1887 (*XBOOLFWD (obj
)->boolvar
? "t" : "nil"));
1888 strout (buf
, -1, -1, printcharfun
, 0);
1891 case Lisp_Misc_Objfwd
:
1892 strout ("#<objfwd to ", -1, -1, printcharfun
, 0);
1893 print_object (*XOBJFWD (obj
)->objvar
, printcharfun
, escapeflag
);
1897 case Lisp_Misc_Buffer_Objfwd
:
1898 strout ("#<buffer_objfwd to ", -1, -1, printcharfun
, 0);
1899 print_object (PER_BUFFER_VALUE (current_buffer
,
1900 XBUFFER_OBJFWD (obj
)->offset
),
1901 printcharfun
, escapeflag
);
1905 case Lisp_Misc_Kboard_Objfwd
:
1906 strout ("#<kboard_objfwd to ", -1, -1, printcharfun
, 0);
1907 print_object (*(Lisp_Object
*)((char *) current_kboard
1908 + XKBOARD_OBJFWD (obj
)->offset
),
1909 printcharfun
, escapeflag
);
1913 case Lisp_Misc_Buffer_Local_Value
:
1914 strout ("#<buffer_local_value ", -1, -1, printcharfun
, 0);
1915 goto do_buffer_local
;
1916 case Lisp_Misc_Some_Buffer_Local_Value
:
1917 strout ("#<some_buffer_local_value ", -1, -1, printcharfun
, 0);
1919 strout ("[realvalue] ", -1, -1, printcharfun
, 0);
1920 print_object (XBUFFER_LOCAL_VALUE (obj
)->realvalue
,
1921 printcharfun
, escapeflag
);
1922 if (XBUFFER_LOCAL_VALUE (obj
)->found_for_buffer
)
1923 strout ("[local in buffer] ", -1, -1, printcharfun
, 0);
1925 strout ("[buffer] ", -1, -1, printcharfun
, 0);
1926 print_object (XBUFFER_LOCAL_VALUE (obj
)->buffer
,
1927 printcharfun
, escapeflag
);
1928 if (XBUFFER_LOCAL_VALUE (obj
)->check_frame
)
1930 if (XBUFFER_LOCAL_VALUE (obj
)->found_for_frame
)
1931 strout ("[local in frame] ", -1, -1, printcharfun
, 0);
1933 strout ("[frame] ", -1, -1, printcharfun
, 0);
1934 print_object (XBUFFER_LOCAL_VALUE (obj
)->frame
,
1935 printcharfun
, escapeflag
);
1937 strout ("[alist-elt] ", -1, -1, printcharfun
, 0);
1938 print_object (XCAR (XBUFFER_LOCAL_VALUE (obj
)->cdr
),
1939 printcharfun
, escapeflag
);
1940 strout ("[default-value] ", -1, -1, printcharfun
, 0);
1941 print_object (XCDR (XBUFFER_LOCAL_VALUE (obj
)->cdr
),
1942 printcharfun
, escapeflag
);
1954 /* We're in trouble if this happens!
1955 Probably should just abort () */
1956 strout ("#<EMACS BUG: INVALID DATATYPE ", -1, -1, printcharfun
, 0);
1958 sprintf (buf
, "(MISC 0x%04x)", (int) XMISCTYPE (obj
));
1959 else if (VECTORLIKEP (obj
))
1960 sprintf (buf
, "(PVEC 0x%08x)", (int) XVECTOR (obj
)->size
);
1962 sprintf (buf
, "(0x%02x)", (int) XTYPE (obj
));
1963 strout (buf
, -1, -1, printcharfun
, 0);
1964 strout (" Save your buffers immediately and please report this bug>",
1965 -1, -1, printcharfun
, 0);
1973 /* Print a description of INTERVAL using PRINTCHARFUN.
1974 This is part of printing a string that has text properties. */
1977 print_interval (interval
, printcharfun
)
1979 Lisp_Object printcharfun
;
1982 print_object (make_number (interval
->position
), printcharfun
, 1);
1984 print_object (make_number (interval
->position
+ LENGTH (interval
)),
1987 print_object (interval
->plist
, printcharfun
, 1);
1994 Qtemp_buffer_setup_hook
= intern ("temp-buffer-setup-hook");
1995 staticpro (&Qtemp_buffer_setup_hook
);
1997 DEFVAR_LISP ("standard-output", &Vstandard_output
,
1998 doc
: /* Output stream `print' uses by default for outputting a character.
1999 This may be any function of one argument.
2000 It may also be a buffer (output is inserted before point)
2001 or a marker (output is inserted and the marker is advanced)
2002 or the symbol t (output appears in the echo area). */);
2003 Vstandard_output
= Qt
;
2004 Qstandard_output
= intern ("standard-output");
2005 staticpro (&Qstandard_output
);
2007 DEFVAR_LISP ("float-output-format", &Vfloat_output_format
,
2008 doc
: /* The format descriptor string used to print floats.
2009 This is a %-spec like those accepted by `printf' in C,
2010 but with some restrictions. It must start with the two characters `%.'.
2011 After that comes an integer precision specification,
2012 and then a letter which controls the format.
2013 The letters allowed are `e', `f' and `g'.
2014 Use `e' for exponential notation \"DIG.DIGITSeEXPT\"
2015 Use `f' for decimal point notation \"DIGITS.DIGITS\".
2016 Use `g' to choose the shorter of those two formats for the number at hand.
2017 The precision in any of these cases is the number of digits following
2018 the decimal point. With `f', a precision of 0 means to omit the
2019 decimal point. 0 is not allowed with `e' or `g'.
2021 A value of nil means to use the shortest notation
2022 that represents the number without losing information. */);
2023 Vfloat_output_format
= Qnil
;
2024 Qfloat_output_format
= intern ("float-output-format");
2025 staticpro (&Qfloat_output_format
);
2027 DEFVAR_LISP ("print-length", &Vprint_length
,
2028 doc
: /* Maximum length of list to print before abbreviating.
2029 A value of nil means no limit. See also `eval-expression-print-length'. */);
2030 Vprint_length
= Qnil
;
2032 DEFVAR_LISP ("print-level", &Vprint_level
,
2033 doc
: /* Maximum depth of list nesting to print before abbreviating.
2034 A value of nil means no limit. See also `eval-expression-print-level'. */);
2035 Vprint_level
= Qnil
;
2037 DEFVAR_BOOL ("print-escape-newlines", &print_escape_newlines
,
2038 doc
: /* Non-nil means print newlines in strings as `\\n'.
2039 Also print formfeeds as `\\f'. */);
2040 print_escape_newlines
= 0;
2042 DEFVAR_BOOL ("print-escape-nonascii", &print_escape_nonascii
,
2043 doc
: /* Non-nil means print unibyte non-ASCII chars in strings as \\OOO.
2044 \(OOO is the octal representation of the character code.)
2045 Only single-byte characters are affected, and only in `prin1'. */);
2046 print_escape_nonascii
= 0;
2048 DEFVAR_BOOL ("print-escape-multibyte", &print_escape_multibyte
,
2049 doc
: /* Non-nil means print multibyte characters in strings as \\xXXXX.
2050 \(XXXX is the hex representation of the character code.)
2051 This affects only `prin1'. */);
2052 print_escape_multibyte
= 0;
2054 DEFVAR_BOOL ("print-quoted", &print_quoted
,
2055 doc
: /* Non-nil means print quoted forms with reader syntax.
2056 I.e., (quote foo) prints as 'foo, (function foo) as #'foo, and backquoted
2057 forms print as in the new syntax. */);
2060 DEFVAR_LISP ("print-gensym", &Vprint_gensym
,
2061 doc
: /* Non-nil means print uninterned symbols so they will read as uninterned.
2062 I.e., the value of (make-symbol \"foobar\") prints as #:foobar.
2063 When the uninterned symbol appears within a recursive data structure,
2064 and the symbol appears more than once, in addition use the #N# and #N=
2065 constructs as needed, so that multiple references to the same symbol are
2066 shared once again when the text is read back. */);
2067 Vprint_gensym
= Qnil
;
2069 DEFVAR_LISP ("print-circle", &Vprint_circle
,
2070 doc
: /* *Non-nil means print recursive structures using #N= and #N# syntax.
2071 If nil, printing proceeds recursively and may lead to
2072 `max-lisp-eval-depth' being exceeded or an error may occur:
2073 \"Apparently circular structure being printed.\" Also see
2074 `print-length' and `print-level'.
2075 If non-nil, shared substructures anywhere in the structure are printed
2076 with `#N=' before the first occurrence (in the order of the print
2077 representation) and `#N#' in place of each subsequent occurrence,
2078 where N is a positive decimal integer. */);
2079 Vprint_circle
= Qnil
;
2081 DEFVAR_LISP ("print-continuous-numbering", &Vprint_continuous_numbering
,
2082 doc
: /* *Non-nil means number continuously across print calls.
2083 This affects the numbers printed for #N= labels and #M# references.
2084 See also `print-circle', `print-gensym', and `print-number-table'.
2085 This variable should not be set with `setq'; bind it with a `let' instead. */);
2086 Vprint_continuous_numbering
= Qnil
;
2088 DEFVAR_LISP ("print-number-table", &Vprint_number_table
,
2089 doc
: /* A vector used internally to produce `#N=' labels and `#N#' references.
2090 The Lisp printer uses this vector to detect Lisp objects referenced more
2091 than once. When `print-continuous-numbering' is bound to t, you should
2092 probably also bind `print-number-table' to nil. This ensures that the
2093 value of `print-number-table' can be garbage-collected once the printing
2095 Vprint_number_table
= Qnil
;
2097 /* prin1_to_string_buffer initialized in init_buffer_once in buffer.c */
2098 staticpro (&Vprin1_to_string_buffer
);
2101 defsubr (&Sprin1_to_string
);
2102 defsubr (&Serror_message_string
);
2106 defsubr (&Swrite_char
);
2107 defsubr (&Sexternal_debugging_output
);
2109 Qexternal_debugging_output
= intern ("external-debugging-output");
2110 staticpro (&Qexternal_debugging_output
);
2112 Qprint_escape_newlines
= intern ("print-escape-newlines");
2113 staticpro (&Qprint_escape_newlines
);
2115 Qprint_escape_multibyte
= intern ("print-escape-multibyte");
2116 staticpro (&Qprint_escape_multibyte
);
2118 Qprint_escape_nonascii
= intern ("print-escape-nonascii");
2119 staticpro (&Qprint_escape_nonascii
);
2121 defsubr (&Swith_output_to_temp_buffer
);