* mark.texi (Mark): Clarify introduction.
[emacs.git] / src / print.c
blobe78f593c7b51c1c181dca122c178a9fe8f8f1884
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, 2008, 2009 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include <stdio.h>
24 #include "lisp.h"
25 #include "buffer.h"
26 #include "character.h"
27 #include "charset.h"
28 #include "keyboard.h"
29 #include "frame.h"
30 #include "window.h"
31 #include "process.h"
32 #include "dispextern.h"
33 #include "termchar.h"
34 #include "intervals.h"
35 #include "blockinput.h"
36 #include "termhooks.h" /* For struct terminal. */
37 #include "font.h"
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 #include <math.h>
50 #if STDC_HEADERS
51 #include <float.h>
52 #endif
54 /* Default to values appropriate for IEEE floating point. */
55 #ifndef FLT_RADIX
56 #define FLT_RADIX 2
57 #endif
58 #ifndef DBL_MANT_DIG
59 #define DBL_MANT_DIG 53
60 #endif
61 #ifndef DBL_DIG
62 #define DBL_DIG 15
63 #endif
64 #ifndef DBL_MIN
65 #define DBL_MIN 2.2250738585072014e-308
66 #endif
68 #ifdef DBL_MIN_REPLACEMENT
69 #undef DBL_MIN
70 #define DBL_MIN DBL_MIN_REPLACEMENT
71 #endif
73 /* Define DOUBLE_DIGITS_BOUND, an upper bound on the number of decimal digits
74 needed to express a float without losing information.
75 The general-case formula is valid for the usual case, IEEE floating point,
76 but many compilers can't optimize the formula to an integer constant,
77 so make a special case for it. */
78 #if FLT_RADIX == 2 && DBL_MANT_DIG == 53
79 #define DOUBLE_DIGITS_BOUND 17 /* IEEE floating point */
80 #else
81 #define DOUBLE_DIGITS_BOUND ((int) ceil (log10 (pow (FLT_RADIX, DBL_MANT_DIG))))
82 #endif
84 /* Avoid actual stack overflow in print. */
85 int print_depth;
87 /* Level of nesting inside outputting backquote in new style. */
88 int new_backquote_output;
90 /* Detect most circularities to print finite output. */
91 #define PRINT_CIRCLE 200
92 Lisp_Object being_printed[PRINT_CIRCLE];
94 /* When printing into a buffer, first we put the text in this
95 block, then insert it all at once. */
96 char *print_buffer;
98 /* Size allocated in print_buffer. */
99 int print_buffer_size;
100 /* Chars stored in print_buffer. */
101 int print_buffer_pos;
102 /* Bytes stored in print_buffer. */
103 int print_buffer_pos_byte;
105 /* Maximum length of list to print in full; noninteger means
106 effectively infinity */
108 Lisp_Object Vprint_length;
110 /* Maximum depth of list to print in full; noninteger means
111 effectively infinity. */
113 Lisp_Object Vprint_level;
115 /* Nonzero means print newlines in strings as \n. */
117 int print_escape_newlines;
119 /* Nonzero means to print single-byte non-ascii characters in strings as
120 octal escapes. */
122 int print_escape_nonascii;
124 /* Nonzero means to print multibyte characters in strings as hex escapes. */
126 int print_escape_multibyte;
128 Lisp_Object Qprint_escape_newlines;
129 Lisp_Object Qprint_escape_multibyte, Qprint_escape_nonascii;
131 /* Nonzero means print (quote foo) forms as 'foo, etc. */
133 int print_quoted;
135 /* Non-nil means print #: before uninterned symbols. */
137 Lisp_Object Vprint_gensym;
139 /* Non-nil means print recursive structures using #n= and #n# syntax. */
141 Lisp_Object Vprint_circle;
143 /* Non-nil means keep continuous number for #n= and #n# syntax
144 between several print functions. */
146 Lisp_Object Vprint_continuous_numbering;
148 /* Vprint_number_table is a vector like [OBJ1 STAT1 OBJ2 STAT2 ...],
149 where OBJn are objects going to be printed, and STATn are their status,
150 which may be different meanings during process. See the comments of
151 the functions print and print_preprocess for details.
152 print_number_index keeps the last position the next object should be added,
153 twice of which is the actual vector position in Vprint_number_table. */
154 int print_number_index;
155 Lisp_Object Vprint_number_table;
157 /* PRINT_NUMBER_OBJECT returns the I'th object in Vprint_number_table TABLE.
158 PRINT_NUMBER_STATUS returns the status of the I'th object in TABLE.
159 See the comment of the variable Vprint_number_table. */
160 #define PRINT_NUMBER_OBJECT(table,i) XVECTOR ((table))->contents[(i) * 2]
161 #define PRINT_NUMBER_STATUS(table,i) XVECTOR ((table))->contents[(i) * 2 + 1]
163 /* Nonzero means print newline to stdout before next minibuffer message.
164 Defined in xdisp.c */
166 extern int noninteractive_need_newline;
168 extern int minibuffer_auto_raise;
170 void print_interval ();
172 /* GDB resets this to zero on W32 to disable OutputDebugString calls. */
173 int print_output_debug_flag = 1;
176 /* Low level output routines for characters and strings */
178 /* Lisp functions to do output using a stream
179 must have the stream in a variable called printcharfun
180 and must start with PRINTPREPARE, end with PRINTFINISH,
181 and use PRINTDECLARE to declare common variables.
182 Use PRINTCHAR to output one character,
183 or call strout to output a block of characters. */
185 #define PRINTDECLARE \
186 struct buffer *old = current_buffer; \
187 int old_point = -1, start_point = -1; \
188 int old_point_byte = -1, start_point_byte = -1; \
189 int specpdl_count = SPECPDL_INDEX (); \
190 int free_print_buffer = 0; \
191 int multibyte = !NILP (current_buffer->enable_multibyte_characters); \
192 Lisp_Object original
194 #define PRINTPREPARE \
195 original = printcharfun; \
196 if (NILP (printcharfun)) printcharfun = Qt; \
197 if (BUFFERP (printcharfun)) \
199 if (XBUFFER (printcharfun) != current_buffer) \
200 Fset_buffer (printcharfun); \
201 printcharfun = Qnil; \
203 if (MARKERP (printcharfun)) \
205 EMACS_INT marker_pos; \
206 if (! XMARKER (printcharfun)->buffer) \
207 error ("Marker does not point anywhere"); \
208 if (XMARKER (printcharfun)->buffer != current_buffer) \
209 set_buffer_internal (XMARKER (printcharfun)->buffer); \
210 marker_pos = marker_position (printcharfun); \
211 if (marker_pos < BEGV || marker_pos > ZV) \
212 error ("Marker is outside the accessible part of the buffer"); \
213 old_point = PT; \
214 old_point_byte = PT_BYTE; \
215 SET_PT_BOTH (marker_pos, \
216 marker_byte_position (printcharfun)); \
217 start_point = PT; \
218 start_point_byte = PT_BYTE; \
219 printcharfun = Qnil; \
221 if (NILP (printcharfun)) \
223 Lisp_Object string; \
224 if (NILP (current_buffer->enable_multibyte_characters) \
225 && ! print_escape_multibyte) \
226 specbind (Qprint_escape_multibyte, Qt); \
227 if (! NILP (current_buffer->enable_multibyte_characters) \
228 && ! print_escape_nonascii) \
229 specbind (Qprint_escape_nonascii, Qt); \
230 if (print_buffer != 0) \
232 string = make_string_from_bytes (print_buffer, \
233 print_buffer_pos, \
234 print_buffer_pos_byte); \
235 record_unwind_protect (print_unwind, string); \
237 else \
239 print_buffer_size = 1000; \
240 print_buffer = (char *) xmalloc (print_buffer_size); \
241 free_print_buffer = 1; \
243 print_buffer_pos = 0; \
244 print_buffer_pos_byte = 0; \
246 if (EQ (printcharfun, Qt) && ! noninteractive) \
247 setup_echo_area_for_printing (multibyte);
249 #define PRINTFINISH \
250 if (NILP (printcharfun)) \
252 if (print_buffer_pos != print_buffer_pos_byte \
253 && NILP (current_buffer->enable_multibyte_characters)) \
255 unsigned char *temp \
256 = (unsigned char *) alloca (print_buffer_pos + 1); \
257 copy_text (print_buffer, temp, print_buffer_pos_byte, \
258 1, 0); \
259 insert_1_both (temp, print_buffer_pos, \
260 print_buffer_pos, 0, 1, 0); \
262 else \
263 insert_1_both (print_buffer, print_buffer_pos, \
264 print_buffer_pos_byte, 0, 1, 0); \
265 signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
267 if (free_print_buffer) \
269 xfree (print_buffer); \
270 print_buffer = 0; \
272 unbind_to (specpdl_count, Qnil); \
273 if (MARKERP (original)) \
274 set_marker_both (original, Qnil, PT, PT_BYTE); \
275 if (old_point >= 0) \
276 SET_PT_BOTH (old_point + (old_point >= start_point \
277 ? PT - start_point : 0), \
278 old_point_byte + (old_point_byte >= start_point_byte \
279 ? PT_BYTE - start_point_byte : 0)); \
280 if (old != current_buffer) \
281 set_buffer_internal (old);
283 #define PRINTCHAR(ch) printchar (ch, printcharfun)
285 /* This is used to restore the saved contents of print_buffer
286 when there is a recursive call to print. */
288 static Lisp_Object
289 print_unwind (saved_text)
290 Lisp_Object saved_text;
292 bcopy (SDATA (saved_text), print_buffer, SCHARS (saved_text));
293 return Qnil;
297 /* Print character CH using method FUN. FUN nil means print to
298 print_buffer. FUN t means print to echo area or stdout if
299 non-interactive. If FUN is neither nil nor t, call FUN with CH as
300 argument. */
302 static void
303 printchar (ch, fun)
304 unsigned int ch;
305 Lisp_Object fun;
307 if (!NILP (fun) && !EQ (fun, Qt))
308 call1 (fun, make_number (ch));
309 else
311 unsigned char str[MAX_MULTIBYTE_LENGTH];
312 int len = CHAR_STRING (ch, str);
314 QUIT;
316 if (NILP (fun))
318 if (print_buffer_pos_byte + len >= print_buffer_size)
319 print_buffer = (char *) xrealloc (print_buffer,
320 print_buffer_size *= 2);
321 bcopy (str, print_buffer + print_buffer_pos_byte, len);
322 print_buffer_pos += 1;
323 print_buffer_pos_byte += len;
325 else if (noninteractive)
327 fwrite (str, 1, len, stdout);
328 noninteractive_need_newline = 1;
330 else
332 int multibyte_p
333 = !NILP (current_buffer->enable_multibyte_characters);
335 setup_echo_area_for_printing (multibyte_p);
336 insert_char (ch);
337 message_dolog (str, len, 0, multibyte_p);
343 /* Output SIZE characters, SIZE_BYTE bytes from string PTR using
344 method PRINTCHARFUN. If SIZE < 0, use the string length of PTR for
345 both SIZE and SIZE_BYTE. PRINTCHARFUN nil means output to
346 print_buffer. PRINTCHARFUN t means output to the echo area or to
347 stdout if non-interactive. If neither nil nor t, call Lisp
348 function PRINTCHARFUN for each character printed. MULTIBYTE
349 non-zero means PTR contains multibyte characters.
351 In the case where PRINTCHARFUN is nil, it is safe for PTR to point
352 to data in a Lisp string. Otherwise that is not safe. */
354 static void
355 strout (ptr, size, size_byte, printcharfun, multibyte)
356 char *ptr;
357 int size, size_byte;
358 Lisp_Object printcharfun;
359 int multibyte;
361 if (size < 0)
362 size_byte = size = strlen (ptr);
364 if (NILP (printcharfun))
366 if (print_buffer_pos_byte + size_byte > print_buffer_size)
368 print_buffer_size = print_buffer_size * 2 + size_byte;
369 print_buffer = (char *) xrealloc (print_buffer,
370 print_buffer_size);
372 bcopy (ptr, print_buffer + print_buffer_pos_byte, size_byte);
373 print_buffer_pos += size;
374 print_buffer_pos_byte += size_byte;
376 else if (noninteractive && EQ (printcharfun, Qt))
378 fwrite (ptr, 1, size_byte, stdout);
379 noninteractive_need_newline = 1;
381 else if (EQ (printcharfun, Qt))
383 /* Output to echo area. We're trying to avoid a little overhead
384 here, that's the reason we don't call printchar to do the
385 job. */
386 int i;
387 int multibyte_p
388 = !NILP (current_buffer->enable_multibyte_characters);
390 setup_echo_area_for_printing (multibyte_p);
391 message_dolog (ptr, size_byte, 0, multibyte_p);
393 if (size == size_byte)
395 for (i = 0; i < size; ++i)
396 insert_char ((unsigned char) *ptr++);
398 else
400 int len;
401 for (i = 0; i < size_byte; i += len)
403 int ch = STRING_CHAR_AND_LENGTH (ptr + i, size_byte - i, len);
404 insert_char (ch);
408 else
410 /* PRINTCHARFUN is a Lisp function. */
411 int i = 0;
413 if (size == size_byte)
415 while (i < size_byte)
417 int ch = ptr[i++];
418 PRINTCHAR (ch);
421 else
423 while (i < size_byte)
425 /* Here, we must convert each multi-byte form to the
426 corresponding character code before handing it to
427 PRINTCHAR. */
428 int len;
429 int ch = STRING_CHAR_AND_LENGTH (ptr + i, size_byte - i, len);
430 PRINTCHAR (ch);
431 i += len;
437 /* Print the contents of a string STRING using PRINTCHARFUN.
438 It isn't safe to use strout in many cases,
439 because printing one char can relocate. */
441 static void
442 print_string (string, printcharfun)
443 Lisp_Object string;
444 Lisp_Object printcharfun;
446 if (EQ (printcharfun, Qt) || NILP (printcharfun))
448 int chars;
450 if (print_escape_nonascii)
451 string = string_escape_byte8 (string);
453 if (STRING_MULTIBYTE (string))
454 chars = SCHARS (string);
455 else if (! print_escape_nonascii
456 && (EQ (printcharfun, Qt)
457 ? ! NILP (buffer_defaults.enable_multibyte_characters)
458 : ! NILP (current_buffer->enable_multibyte_characters)))
460 /* If unibyte string STRING contains 8-bit codes, we must
461 convert STRING to a multibyte string containing the same
462 character codes. */
463 Lisp_Object newstr;
464 int bytes;
466 chars = SBYTES (string);
467 bytes = parse_str_to_multibyte (SDATA (string), chars);
468 if (chars < bytes)
470 newstr = make_uninit_multibyte_string (chars, bytes);
471 bcopy (SDATA (string), SDATA (newstr), chars);
472 str_to_multibyte (SDATA (newstr), bytes, chars);
473 string = newstr;
476 else
477 chars = SBYTES (string);
479 if (EQ (printcharfun, Qt))
481 /* Output to echo area. */
482 int nbytes = SBYTES (string);
483 char *buffer;
485 /* Copy the string contents so that relocation of STRING by
486 GC does not cause trouble. */
487 USE_SAFE_ALLOCA;
489 SAFE_ALLOCA (buffer, char *, nbytes);
490 bcopy (SDATA (string), buffer, nbytes);
492 strout (buffer, chars, SBYTES (string),
493 printcharfun, STRING_MULTIBYTE (string));
495 SAFE_FREE ();
497 else
498 /* No need to copy, since output to print_buffer can't GC. */
499 strout (SDATA (string),
500 chars, SBYTES (string),
501 printcharfun, STRING_MULTIBYTE (string));
503 else
505 /* Otherwise, string may be relocated by printing one char.
506 So re-fetch the string address for each character. */
507 int i;
508 int size = SCHARS (string);
509 int size_byte = SBYTES (string);
510 struct gcpro gcpro1;
511 GCPRO1 (string);
512 if (size == size_byte)
513 for (i = 0; i < size; i++)
514 PRINTCHAR (SREF (string, i));
515 else
516 for (i = 0; i < size_byte; )
518 /* Here, we must convert each multi-byte form to the
519 corresponding character code before handing it to PRINTCHAR. */
520 int len;
521 int ch = STRING_CHAR_AND_LENGTH (SDATA (string) + i,
522 size_byte - i, len);
523 PRINTCHAR (ch);
524 i += len;
526 UNGCPRO;
530 DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
531 doc: /* Output character CHARACTER to stream PRINTCHARFUN.
532 PRINTCHARFUN defaults to the value of `standard-output' (which see). */)
533 (character, printcharfun)
534 Lisp_Object character, printcharfun;
536 PRINTDECLARE;
538 if (NILP (printcharfun))
539 printcharfun = Vstandard_output;
540 CHECK_NUMBER (character);
541 PRINTPREPARE;
542 PRINTCHAR (XINT (character));
543 PRINTFINISH;
544 return character;
547 /* Used from outside of print.c to print a block of SIZE
548 single-byte chars at DATA on the default output stream.
549 Do not use this on the contents of a Lisp string. */
551 void
552 write_string (data, size)
553 char *data;
554 int size;
556 PRINTDECLARE;
557 Lisp_Object printcharfun;
559 printcharfun = Vstandard_output;
561 PRINTPREPARE;
562 strout (data, size, size, printcharfun, 0);
563 PRINTFINISH;
566 /* Used from outside of print.c to print a block of SIZE
567 single-byte chars at DATA on a specified stream PRINTCHARFUN.
568 Do not use this on the contents of a Lisp string. */
570 void
571 write_string_1 (data, size, printcharfun)
572 char *data;
573 int size;
574 Lisp_Object printcharfun;
576 PRINTDECLARE;
578 PRINTPREPARE;
579 strout (data, size, size, printcharfun, 0);
580 PRINTFINISH;
584 void
585 temp_output_buffer_setup (bufname)
586 const char *bufname;
588 int count = SPECPDL_INDEX ();
589 register struct buffer *old = current_buffer;
590 register Lisp_Object buf;
592 record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
594 Fset_buffer (Fget_buffer_create (build_string (bufname)));
596 Fkill_all_local_variables ();
597 delete_all_overlays (current_buffer);
598 current_buffer->directory = old->directory;
599 current_buffer->read_only = Qnil;
600 current_buffer->filename = Qnil;
601 current_buffer->undo_list = Qt;
602 eassert (current_buffer->overlays_before == NULL);
603 eassert (current_buffer->overlays_after == NULL);
604 current_buffer->enable_multibyte_characters
605 = buffer_defaults.enable_multibyte_characters;
606 specbind (Qinhibit_read_only, Qt);
607 specbind (Qinhibit_modification_hooks, Qt);
608 Ferase_buffer ();
609 XSETBUFFER (buf, current_buffer);
611 Frun_hooks (1, &Qtemp_buffer_setup_hook);
613 unbind_to (count, Qnil);
615 specbind (Qstandard_output, buf);
618 Lisp_Object
619 internal_with_output_to_temp_buffer (bufname, function, args)
620 const char *bufname;
621 Lisp_Object (*function) P_ ((Lisp_Object));
622 Lisp_Object args;
624 int count = SPECPDL_INDEX ();
625 Lisp_Object buf, val;
626 struct gcpro gcpro1;
628 GCPRO1 (args);
629 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
630 temp_output_buffer_setup (bufname);
631 buf = Vstandard_output;
632 UNGCPRO;
634 val = (*function) (args);
636 GCPRO1 (val);
637 temp_output_buffer_show (buf);
638 UNGCPRO;
640 return unbind_to (count, val);
643 DEFUN ("with-output-to-temp-buffer",
644 Fwith_output_to_temp_buffer, Swith_output_to_temp_buffer,
645 1, UNEVALLED, 0,
646 doc: /* Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
648 This construct makes buffer BUFNAME empty before running BODY.
649 It does not make the buffer current for BODY.
650 Instead it binds `standard-output' to that buffer, so that output
651 generated with `prin1' and similar functions in BODY goes into
652 the buffer.
654 At the end of BODY, this marks buffer BUFNAME unmodifed and displays
655 it in a window, but does not select it. The normal way to do this is
656 by calling `display-buffer', then running `temp-buffer-show-hook'.
657 However, if `temp-buffer-show-function' is non-nil, it calls that
658 function instead (and does not run `temp-buffer-show-hook'). The
659 function gets one argument, the buffer to display.
661 The return value of `with-output-to-temp-buffer' is the value of the
662 last form in BODY. If BODY does not finish normally, the buffer
663 BUFNAME is not displayed.
665 This runs the hook `temp-buffer-setup-hook' before BODY,
666 with the buffer BUFNAME temporarily current. It runs the hook
667 `temp-buffer-show-hook' after displaying buffer BUFNAME, with that
668 buffer temporarily current, and the window that was used to display it
669 temporarily selected. But it doesn't run `temp-buffer-show-hook'
670 if it uses `temp-buffer-show-function'.
672 usage: (with-output-to-temp-buffer BUFNAME BODY...) */)
673 (args)
674 Lisp_Object args;
676 struct gcpro gcpro1;
677 Lisp_Object name;
678 int count = SPECPDL_INDEX ();
679 Lisp_Object buf, val;
681 GCPRO1(args);
682 name = Feval (Fcar (args));
683 CHECK_STRING (name);
684 temp_output_buffer_setup (SDATA (name));
685 buf = Vstandard_output;
686 UNGCPRO;
688 val = Fprogn (XCDR (args));
690 GCPRO1 (val);
691 temp_output_buffer_show (buf);
692 UNGCPRO;
694 return unbind_to (count, val);
698 static void print ();
699 static void print_preprocess ();
700 static void print_preprocess_string ();
701 static void print_object ();
703 DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
704 doc: /* Output a newline to stream PRINTCHARFUN.
705 If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used. */)
706 (printcharfun)
707 Lisp_Object printcharfun;
709 PRINTDECLARE;
711 if (NILP (printcharfun))
712 printcharfun = Vstandard_output;
713 PRINTPREPARE;
714 PRINTCHAR ('\n');
715 PRINTFINISH;
716 return Qt;
719 DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
720 doc: /* Output the printed representation of OBJECT, any Lisp object.
721 Quoting characters are printed when needed to make output that `read'
722 can handle, whenever this is possible. For complex objects, the behavior
723 is controlled by `print-level' and `print-length', which see.
725 OBJECT is any of the Lisp data types: a number, a string, a symbol,
726 a list, a buffer, a window, a frame, etc.
728 A printed representation of an object is text which describes that object.
730 Optional argument PRINTCHARFUN is the output stream, which can be one
731 of these:
733 - a buffer, in which case output is inserted into that buffer at point;
734 - a marker, in which case output is inserted at marker's position;
735 - a function, in which case that function is called once for each
736 character of OBJECT's printed representation;
737 - a symbol, in which case that symbol's function definition is called; or
738 - t, in which case the output is displayed in the echo area.
740 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
741 is used instead. */)
742 (object, printcharfun)
743 Lisp_Object object, printcharfun;
745 PRINTDECLARE;
747 if (NILP (printcharfun))
748 printcharfun = Vstandard_output;
749 PRINTPREPARE;
750 print (object, printcharfun, 1);
751 PRINTFINISH;
752 return object;
755 /* a buffer which is used to hold output being built by prin1-to-string */
756 Lisp_Object Vprin1_to_string_buffer;
758 DEFUN ("prin1-to-string", Fprin1_to_string, Sprin1_to_string, 1, 2, 0,
759 doc: /* Return a string containing the printed representation of OBJECT.
760 OBJECT can be any Lisp object. This function outputs quoting characters
761 when necessary to make output that `read' can handle, whenever possible,
762 unless the optional second argument NOESCAPE is non-nil. For complex objects,
763 the behavior is controlled by `print-level' and `print-length', which see.
765 OBJECT is any of the Lisp data types: a number, a string, a symbol,
766 a list, a buffer, a window, a frame, etc.
768 A printed representation of an object is text which describes that object. */)
769 (object, noescape)
770 Lisp_Object object, noescape;
772 Lisp_Object printcharfun;
773 /* struct gcpro gcpro1, gcpro2; */
774 Lisp_Object save_deactivate_mark;
775 int count = SPECPDL_INDEX ();
776 struct buffer *previous;
778 specbind (Qinhibit_modification_hooks, Qt);
781 PRINTDECLARE;
783 /* Save and restore this--we are altering a buffer
784 but we don't want to deactivate the mark just for that.
785 No need for specbind, since errors deactivate the mark. */
786 save_deactivate_mark = Vdeactivate_mark;
787 /* GCPRO2 (object, save_deactivate_mark); */
788 abort_on_gc++;
790 printcharfun = Vprin1_to_string_buffer;
791 PRINTPREPARE;
792 print (object, printcharfun, NILP (noescape));
793 /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
794 PRINTFINISH;
797 previous = current_buffer;
798 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
799 object = Fbuffer_string ();
800 if (SBYTES (object) == SCHARS (object))
801 STRING_SET_UNIBYTE (object);
803 /* Note that this won't make prepare_to_modify_buffer call
804 ask-user-about-supersession-threat because this buffer
805 does not visit a file. */
806 Ferase_buffer ();
807 set_buffer_internal (previous);
809 Vdeactivate_mark = save_deactivate_mark;
810 /* UNGCPRO; */
812 abort_on_gc--;
813 return unbind_to (count, object);
816 DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
817 doc: /* Output the printed representation of OBJECT, any Lisp object.
818 No quoting characters are used; no delimiters are printed around
819 the contents of strings.
821 OBJECT is any of the Lisp data types: a number, a string, a symbol,
822 a list, a buffer, a window, a frame, etc.
824 A printed representation of an object is text which describes that object.
826 Optional argument PRINTCHARFUN is the output stream, which can be one
827 of these:
829 - a buffer, in which case output is inserted into that buffer at point;
830 - a marker, in which case output is inserted at marker's position;
831 - a function, in which case that function is called once for each
832 character of OBJECT's printed representation;
833 - a symbol, in which case that symbol's function definition is called; or
834 - t, in which case the output is displayed in the echo area.
836 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
837 is used instead. */)
838 (object, printcharfun)
839 Lisp_Object object, printcharfun;
841 PRINTDECLARE;
843 if (NILP (printcharfun))
844 printcharfun = Vstandard_output;
845 PRINTPREPARE;
846 print (object, printcharfun, 0);
847 PRINTFINISH;
848 return object;
851 DEFUN ("print", Fprint, Sprint, 1, 2, 0,
852 doc: /* Output the printed representation of OBJECT, with newlines around it.
853 Quoting characters are printed when needed to make output that `read'
854 can handle, whenever this is possible. For complex objects, the behavior
855 is controlled by `print-level' and `print-length', which see.
857 OBJECT is any of the Lisp data types: a number, a string, a symbol,
858 a list, a buffer, a window, a frame, etc.
860 A printed representation of an object is text which describes that object.
862 Optional argument PRINTCHARFUN is the output stream, which can be one
863 of these:
865 - a buffer, in which case output is inserted into that buffer at point;
866 - a marker, in which case output is inserted at marker's position;
867 - a function, in which case that function is called once for each
868 character of OBJECT's printed representation;
869 - a symbol, in which case that symbol's function definition is called; or
870 - t, in which case the output is displayed in the echo area.
872 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
873 is used instead. */)
874 (object, printcharfun)
875 Lisp_Object object, printcharfun;
877 PRINTDECLARE;
878 struct gcpro gcpro1;
880 if (NILP (printcharfun))
881 printcharfun = Vstandard_output;
882 GCPRO1 (object);
883 PRINTPREPARE;
884 PRINTCHAR ('\n');
885 print (object, printcharfun, 1);
886 PRINTCHAR ('\n');
887 PRINTFINISH;
888 UNGCPRO;
889 return object;
892 /* The subroutine object for external-debugging-output is kept here
893 for the convenience of the debugger. */
894 Lisp_Object Qexternal_debugging_output;
896 DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
897 doc: /* Write CHARACTER to stderr.
898 You can call print while debugging emacs, and pass it this function
899 to make it write to the debugging output. */)
900 (character)
901 Lisp_Object character;
903 CHECK_NUMBER (character);
904 putc (XINT (character), stderr);
906 #ifdef WINDOWSNT
907 /* Send the output to a debugger (nothing happens if there isn't one). */
908 if (print_output_debug_flag)
910 char buf[2] = {(char) XINT (character), '\0'};
911 OutputDebugString (buf);
913 #endif
915 return character;
918 /* This function is never called. Its purpose is to prevent
919 print_output_debug_flag from being optimized away. */
921 void
922 debug_output_compilation_hack (x)
923 int x;
925 print_output_debug_flag = x;
928 #if defined (GNU_LINUX)
930 /* This functionality is not vitally important in general, so we rely on
931 non-portable ability to use stderr as lvalue. */
933 #define WITH_REDIRECT_DEBUGGING_OUTPUT 1
935 FILE *initial_stderr_stream = NULL;
937 DEFUN ("redirect-debugging-output", Fredirect_debugging_output, Sredirect_debugging_output,
938 1, 2,
939 "FDebug output file: \nP",
940 doc: /* Redirect debugging output (stderr stream) to file FILE.
941 If FILE is nil, reset target to the initial stderr stream.
942 Optional arg APPEND non-nil (interactively, with prefix arg) means
943 append to existing target file. */)
944 (file, append)
945 Lisp_Object file, append;
947 if (initial_stderr_stream != NULL)
949 BLOCK_INPUT;
950 fclose (stderr);
951 UNBLOCK_INPUT;
953 stderr = initial_stderr_stream;
954 initial_stderr_stream = NULL;
956 if (STRINGP (file))
958 file = Fexpand_file_name (file, Qnil);
959 initial_stderr_stream = stderr;
960 stderr = fopen (SDATA (file), NILP (append) ? "w" : "a");
961 if (stderr == NULL)
963 stderr = initial_stderr_stream;
964 initial_stderr_stream = NULL;
965 report_file_error ("Cannot open debugging output stream",
966 Fcons (file, Qnil));
969 return Qnil;
971 #endif /* GNU_LINUX */
974 /* This is the interface for debugging printing. */
976 void
977 debug_print (arg)
978 Lisp_Object arg;
980 Fprin1 (arg, Qexternal_debugging_output);
981 fprintf (stderr, "\r\n");
984 void
985 safe_debug_print (arg)
986 Lisp_Object arg;
988 int valid = valid_lisp_object_p (arg);
990 if (valid > 0)
991 debug_print (arg);
992 else
993 fprintf (stderr, "#<%s_LISP_OBJECT 0x%08lx>\r\n",
994 !valid ? "INVALID" : "SOME",
995 (unsigned long) XHASH (arg)
1000 DEFUN ("error-message-string", Ferror_message_string, Serror_message_string,
1001 1, 1, 0,
1002 doc: /* Convert an error value (ERROR-SYMBOL . DATA) to an error message.
1003 See Info anchor `(elisp)Definition of signal' for some details on how this
1004 error message is constructed. */)
1005 (obj)
1006 Lisp_Object obj;
1008 struct buffer *old = current_buffer;
1009 Lisp_Object value;
1010 struct gcpro gcpro1;
1012 /* If OBJ is (error STRING), just return STRING.
1013 That is not only faster, it also avoids the need to allocate
1014 space here when the error is due to memory full. */
1015 if (CONSP (obj) && EQ (XCAR (obj), Qerror)
1016 && CONSP (XCDR (obj))
1017 && STRINGP (XCAR (XCDR (obj)))
1018 && NILP (XCDR (XCDR (obj))))
1019 return XCAR (XCDR (obj));
1021 print_error_message (obj, Vprin1_to_string_buffer, 0, Qnil);
1023 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
1024 value = Fbuffer_string ();
1026 GCPRO1 (value);
1027 Ferase_buffer ();
1028 set_buffer_internal (old);
1029 UNGCPRO;
1031 return value;
1034 /* Print an error message for the error DATA onto Lisp output stream
1035 STREAM (suitable for the print functions).
1036 CONTEXT is a C string describing the context of the error.
1037 CALLER is the Lisp function inside which the error was signaled. */
1039 void
1040 print_error_message (data, stream, context, caller)
1041 Lisp_Object data, stream;
1042 char *context;
1043 Lisp_Object caller;
1045 Lisp_Object errname, errmsg, file_error, tail;
1046 struct gcpro gcpro1;
1047 int i;
1049 if (context != 0)
1050 write_string_1 (context, -1, stream);
1052 /* If we know from where the error was signaled, show it in
1053 *Messages*. */
1054 if (!NILP (caller) && SYMBOLP (caller))
1056 Lisp_Object cname = SYMBOL_NAME (caller);
1057 char *name = alloca (SBYTES (cname));
1058 bcopy (SDATA (cname), name, SBYTES (cname));
1059 message_dolog (name, SBYTES (cname), 0, 0);
1060 message_dolog (": ", 2, 0, 0);
1063 errname = Fcar (data);
1065 if (EQ (errname, Qerror))
1067 data = Fcdr (data);
1068 if (!CONSP (data))
1069 data = Qnil;
1070 errmsg = Fcar (data);
1071 file_error = Qnil;
1073 else
1075 Lisp_Object error_conditions;
1076 errmsg = Fget (errname, Qerror_message);
1077 error_conditions = Fget (errname, Qerror_conditions);
1078 file_error = Fmemq (Qfile_error, error_conditions);
1081 /* Print an error message including the data items. */
1083 tail = Fcdr_safe (data);
1084 GCPRO1 (tail);
1086 /* For file-error, make error message by concatenating
1087 all the data items. They are all strings. */
1088 if (!NILP (file_error) && CONSP (tail))
1089 errmsg = XCAR (tail), tail = XCDR (tail);
1091 if (STRINGP (errmsg))
1092 Fprinc (errmsg, stream);
1093 else
1094 write_string_1 ("peculiar error", -1, stream);
1096 for (i = 0; CONSP (tail); tail = XCDR (tail), i++)
1098 Lisp_Object obj;
1100 write_string_1 (i ? ", " : ": ", 2, stream);
1101 obj = XCAR (tail);
1102 if (!NILP (file_error) || EQ (errname, Qend_of_file))
1103 Fprinc (obj, stream);
1104 else
1105 Fprin1 (obj, stream);
1108 UNGCPRO;
1114 * The buffer should be at least as large as the max string size of the
1115 * largest float, printed in the biggest notation. This is undoubtedly
1116 * 20d float_output_format, with the negative of the C-constant "HUGE"
1117 * from <math.h>.
1119 * On the vax the worst case is -1e38 in 20d format which takes 61 bytes.
1121 * I assume that IEEE-754 format numbers can take 329 bytes for the worst
1122 * case of -1e307 in 20d float_output_format. What is one to do (short of
1123 * re-writing _doprnt to be more sane)?
1124 * -wsr
1127 void
1128 float_to_string (buf, data)
1129 unsigned char *buf;
1130 double data;
1132 unsigned char *cp;
1133 int width;
1135 /* Check for plus infinity in a way that won't lose
1136 if there is no plus infinity. */
1137 if (data == data / 2 && data > 1.0)
1139 strcpy (buf, "1.0e+INF");
1140 return;
1142 /* Likewise for minus infinity. */
1143 if (data == data / 2 && data < -1.0)
1145 strcpy (buf, "-1.0e+INF");
1146 return;
1148 /* Check for NaN in a way that won't fail if there are no NaNs. */
1149 if (! (data * 0.0 >= 0.0))
1151 /* Prepend "-" if the NaN's sign bit is negative.
1152 The sign bit of a double is the bit that is 1 in -0.0. */
1153 int i;
1154 union { double d; char c[sizeof (double)]; } u_data, u_minus_zero;
1155 u_data.d = data;
1156 u_minus_zero.d = - 0.0;
1157 for (i = 0; i < sizeof (double); i++)
1158 if (u_data.c[i] & u_minus_zero.c[i])
1160 *buf++ = '-';
1161 break;
1164 strcpy (buf, "0.0e+NaN");
1165 return;
1168 if (NILP (Vfloat_output_format)
1169 || !STRINGP (Vfloat_output_format))
1170 lose:
1172 /* Generate the fewest number of digits that represent the
1173 floating point value without losing information.
1174 The following method is simple but a bit slow.
1175 For ideas about speeding things up, please see:
1177 Guy L Steele Jr & Jon L White, How to print floating-point numbers
1178 accurately. SIGPLAN notices 25, 6 (June 1990), 112-126.
1180 Robert G Burger & R Kent Dybvig, Printing floating point numbers
1181 quickly and accurately, SIGPLAN notices 31, 5 (May 1996), 108-116. */
1183 width = fabs (data) < DBL_MIN ? 1 : DBL_DIG;
1185 sprintf (buf, "%.*g", width, data);
1186 while (width++ < DOUBLE_DIGITS_BOUND && atof (buf) != data);
1188 else /* oink oink */
1190 /* Check that the spec we have is fully valid.
1191 This means not only valid for printf,
1192 but meant for floats, and reasonable. */
1193 cp = SDATA (Vfloat_output_format);
1195 if (cp[0] != '%')
1196 goto lose;
1197 if (cp[1] != '.')
1198 goto lose;
1200 cp += 2;
1202 /* Check the width specification. */
1203 width = -1;
1204 if ('0' <= *cp && *cp <= '9')
1206 width = 0;
1208 width = (width * 10) + (*cp++ - '0');
1209 while (*cp >= '0' && *cp <= '9');
1211 /* A precision of zero is valid only for %f. */
1212 if (width > DBL_DIG
1213 || (width == 0 && *cp != 'f'))
1214 goto lose;
1217 if (*cp != 'e' && *cp != 'f' && *cp != 'g')
1218 goto lose;
1220 if (cp[1] != 0)
1221 goto lose;
1223 sprintf (buf, SDATA (Vfloat_output_format), data);
1226 /* Make sure there is a decimal point with digit after, or an
1227 exponent, so that the value is readable as a float. But don't do
1228 this with "%.0f"; it's valid for that not to produce a decimal
1229 point. Note that width can be 0 only for %.0f. */
1230 if (width != 0)
1232 for (cp = buf; *cp; cp++)
1233 if ((*cp < '0' || *cp > '9') && *cp != '-')
1234 break;
1236 if (*cp == '.' && cp[1] == 0)
1238 cp[1] = '0';
1239 cp[2] = 0;
1242 if (*cp == 0)
1244 *cp++ = '.';
1245 *cp++ = '0';
1246 *cp++ = 0;
1252 static void
1253 print (obj, printcharfun, escapeflag)
1254 Lisp_Object obj;
1255 register Lisp_Object printcharfun;
1256 int escapeflag;
1258 new_backquote_output = 0;
1260 /* Reset print_number_index and Vprint_number_table only when
1261 the variable Vprint_continuous_numbering is nil. Otherwise,
1262 the values of these variables will be kept between several
1263 print functions. */
1264 if (NILP (Vprint_continuous_numbering)
1265 || NILP (Vprint_number_table))
1267 print_number_index = 0;
1268 Vprint_number_table = Qnil;
1271 /* Construct Vprint_number_table for print-gensym and print-circle. */
1272 if (!NILP (Vprint_gensym) || !NILP (Vprint_circle))
1274 int i, start, index;
1275 start = index = print_number_index;
1276 /* Construct Vprint_number_table.
1277 This increments print_number_index for the objects added. */
1278 print_depth = 0;
1279 print_preprocess (obj);
1281 /* Remove unnecessary objects, which appear only once in OBJ;
1282 that is, whose status is Qnil. Compactify the necessary objects. */
1283 for (i = start; i < print_number_index; i++)
1284 if (!NILP (PRINT_NUMBER_STATUS (Vprint_number_table, i)))
1286 PRINT_NUMBER_OBJECT (Vprint_number_table, index)
1287 = PRINT_NUMBER_OBJECT (Vprint_number_table, i);
1288 index++;
1291 /* Clear out objects outside the active part of the table. */
1292 for (i = index; i < print_number_index; i++)
1293 PRINT_NUMBER_OBJECT (Vprint_number_table, i) = Qnil;
1295 /* Reset the status field for the next print step. Now this
1296 field means whether the object has already been printed. */
1297 for (i = start; i < print_number_index; i++)
1298 PRINT_NUMBER_STATUS (Vprint_number_table, i) = Qnil;
1300 print_number_index = index;
1303 print_depth = 0;
1304 print_object (obj, printcharfun, escapeflag);
1307 /* Construct Vprint_number_table according to the structure of OBJ.
1308 OBJ itself and all its elements will be added to Vprint_number_table
1309 recursively if it is a list, vector, compiled function, char-table,
1310 string (its text properties will be traced), or a symbol that has
1311 no obarray (this is for the print-gensym feature).
1312 The status fields of Vprint_number_table mean whether each object appears
1313 more than once in OBJ: Qnil at the first time, and Qt after that . */
1314 static void
1315 print_preprocess (obj)
1316 Lisp_Object obj;
1318 int i;
1319 EMACS_INT size;
1320 int loop_count = 0;
1321 Lisp_Object halftail;
1323 /* Give up if we go so deep that print_object will get an error. */
1324 /* See similar code in print_object. */
1325 if (print_depth >= PRINT_CIRCLE)
1326 error ("Apparently circular structure being printed");
1328 /* Avoid infinite recursion for circular nested structure
1329 in the case where Vprint_circle is nil. */
1330 if (NILP (Vprint_circle))
1332 for (i = 0; i < print_depth; i++)
1333 if (EQ (obj, being_printed[i]))
1334 return;
1335 being_printed[print_depth] = obj;
1338 print_depth++;
1339 halftail = obj;
1341 loop:
1342 if (STRINGP (obj) || CONSP (obj) || VECTORP (obj)
1343 || COMPILEDP (obj) || CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj)
1344 || (! NILP (Vprint_gensym)
1345 && SYMBOLP (obj)
1346 && !SYMBOL_INTERNED_P (obj)))
1348 /* In case print-circle is nil and print-gensym is t,
1349 add OBJ to Vprint_number_table only when OBJ is a symbol. */
1350 if (! NILP (Vprint_circle) || SYMBOLP (obj))
1352 for (i = 0; i < print_number_index; i++)
1353 if (EQ (PRINT_NUMBER_OBJECT (Vprint_number_table, i), obj))
1355 /* OBJ appears more than once. Let's remember that. */
1356 PRINT_NUMBER_STATUS (Vprint_number_table, i) = Qt;
1357 print_depth--;
1358 return;
1361 /* OBJ is not yet recorded. Let's add to the table. */
1362 if (print_number_index == 0)
1364 /* Initialize the table. */
1365 Vprint_number_table = Fmake_vector (make_number (40), Qnil);
1367 else if (XVECTOR (Vprint_number_table)->size == print_number_index * 2)
1369 /* Reallocate the table. */
1370 int i = print_number_index * 4;
1371 Lisp_Object old_table = Vprint_number_table;
1372 Vprint_number_table = Fmake_vector (make_number (i), Qnil);
1373 for (i = 0; i < print_number_index; i++)
1375 PRINT_NUMBER_OBJECT (Vprint_number_table, i)
1376 = PRINT_NUMBER_OBJECT (old_table, i);
1377 PRINT_NUMBER_STATUS (Vprint_number_table, i)
1378 = PRINT_NUMBER_STATUS (old_table, i);
1381 PRINT_NUMBER_OBJECT (Vprint_number_table, print_number_index) = obj;
1382 /* If Vprint_continuous_numbering is non-nil and OBJ is a gensym,
1383 always print the gensym with a number. This is a special for
1384 the lisp function byte-compile-output-docform. */
1385 if (!NILP (Vprint_continuous_numbering)
1386 && SYMBOLP (obj)
1387 && !SYMBOL_INTERNED_P (obj))
1388 PRINT_NUMBER_STATUS (Vprint_number_table, print_number_index) = Qt;
1389 print_number_index++;
1392 switch (XTYPE (obj))
1394 case Lisp_String:
1395 /* A string may have text properties, which can be circular. */
1396 traverse_intervals_noorder (STRING_INTERVALS (obj),
1397 print_preprocess_string, Qnil);
1398 break;
1400 case Lisp_Cons:
1401 /* Use HALFTAIL and LOOP_COUNT to detect circular lists,
1402 just as in print_object. */
1403 if (loop_count && EQ (obj, halftail))
1404 break;
1405 print_preprocess (XCAR (obj));
1406 obj = XCDR (obj);
1407 loop_count++;
1408 if (!(loop_count & 1))
1409 halftail = XCDR (halftail);
1410 goto loop;
1412 case Lisp_Vectorlike:
1413 size = XVECTOR (obj)->size;
1414 if (size & PSEUDOVECTOR_FLAG)
1415 size &= PSEUDOVECTOR_SIZE_MASK;
1416 for (i = 0; i < size; i++)
1417 print_preprocess (XVECTOR (obj)->contents[i]);
1418 break;
1420 default:
1421 break;
1424 print_depth--;
1427 static void
1428 print_preprocess_string (interval, arg)
1429 INTERVAL interval;
1430 Lisp_Object arg;
1432 print_preprocess (interval->plist);
1435 /* A flag to control printing of `charset' text property.
1436 The default value is Qdefault. */
1437 Lisp_Object Vprint_charset_text_property;
1438 extern Lisp_Object Qdefault;
1440 static void print_check_string_charset_prop ();
1442 #define PRINT_STRING_NON_CHARSET_FOUND 1
1443 #define PRINT_STRING_UNSAFE_CHARSET_FOUND 2
1445 /* Bitwize or of the abobe macros. */
1446 static int print_check_string_result;
1448 static void
1449 print_check_string_charset_prop (interval, string)
1450 INTERVAL interval;
1451 Lisp_Object string;
1453 Lisp_Object val;
1455 if (NILP (interval->plist)
1456 || (print_check_string_result == (PRINT_STRING_NON_CHARSET_FOUND
1457 | PRINT_STRING_UNSAFE_CHARSET_FOUND)))
1458 return;
1459 for (val = interval->plist; CONSP (val) && ! EQ (XCAR (val), Qcharset);
1460 val = XCDR (XCDR (val)));
1461 if (! CONSP (val))
1463 print_check_string_result |= PRINT_STRING_NON_CHARSET_FOUND;
1464 return;
1466 if (! (print_check_string_result & PRINT_STRING_NON_CHARSET_FOUND))
1468 if (! EQ (val, interval->plist)
1469 || CONSP (XCDR (XCDR (val))))
1470 print_check_string_result |= PRINT_STRING_NON_CHARSET_FOUND;
1472 if (NILP (Vprint_charset_text_property)
1473 || ! (print_check_string_result & PRINT_STRING_UNSAFE_CHARSET_FOUND))
1475 int i, c;
1476 int charpos = interval->position;
1477 int bytepos = string_char_to_byte (string, charpos);
1478 Lisp_Object charset;
1480 charset = XCAR (XCDR (val));
1481 for (i = 0; i < LENGTH (interval); i++)
1483 FETCH_STRING_CHAR_ADVANCE (c, string, charpos, bytepos);
1484 if (! ASCII_CHAR_P (c)
1485 && ! EQ (CHARSET_NAME (CHAR_CHARSET (c)), charset))
1487 print_check_string_result |= PRINT_STRING_UNSAFE_CHARSET_FOUND;
1488 break;
1494 /* The value is (charset . nil). */
1495 static Lisp_Object print_prune_charset_plist;
1497 static Lisp_Object
1498 print_prune_string_charset (string)
1499 Lisp_Object string;
1501 print_check_string_result = 0;
1502 traverse_intervals (STRING_INTERVALS (string), 0,
1503 print_check_string_charset_prop, string);
1504 if (! (print_check_string_result & PRINT_STRING_UNSAFE_CHARSET_FOUND))
1506 string = Fcopy_sequence (string);
1507 if (print_check_string_result & PRINT_STRING_NON_CHARSET_FOUND)
1509 if (NILP (print_prune_charset_plist))
1510 print_prune_charset_plist = Fcons (Qcharset, Qnil);
1511 Fremove_text_properties (make_number (0),
1512 make_number (SCHARS (string)),
1513 print_prune_charset_plist, string);
1515 else
1516 Fset_text_properties (make_number (0), make_number (SCHARS (string)),
1517 Qnil, string);
1519 return string;
1522 static void
1523 print_object (obj, printcharfun, escapeflag)
1524 Lisp_Object obj;
1525 register Lisp_Object printcharfun;
1526 int escapeflag;
1528 char buf[40];
1530 QUIT;
1532 /* See similar code in print_preprocess. */
1533 if (print_depth >= PRINT_CIRCLE)
1534 error ("Apparently circular structure being printed");
1536 /* Detect circularities and truncate them. */
1537 if (STRINGP (obj) || CONSP (obj) || VECTORP (obj)
1538 || COMPILEDP (obj) || CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj)
1539 || (! NILP (Vprint_gensym)
1540 && SYMBOLP (obj)
1541 && !SYMBOL_INTERNED_P (obj)))
1543 if (NILP (Vprint_circle) && NILP (Vprint_gensym))
1545 /* Simple but incomplete way. */
1546 int i;
1547 for (i = 0; i < print_depth; i++)
1548 if (EQ (obj, being_printed[i]))
1550 sprintf (buf, "#%d", i);
1551 strout (buf, -1, -1, printcharfun, 0);
1552 return;
1554 being_printed[print_depth] = obj;
1556 else
1558 /* With the print-circle feature. */
1559 int i;
1560 for (i = 0; i < print_number_index; i++)
1561 if (EQ (PRINT_NUMBER_OBJECT (Vprint_number_table, i), obj))
1563 if (NILP (PRINT_NUMBER_STATUS (Vprint_number_table, i)))
1565 /* Add a prefix #n= if OBJ has not yet been printed;
1566 that is, its status field is nil. */
1567 sprintf (buf, "#%d=", i + 1);
1568 strout (buf, -1, -1, printcharfun, 0);
1569 /* OBJ is going to be printed. Set the status to t. */
1570 PRINT_NUMBER_STATUS (Vprint_number_table, i) = Qt;
1571 break;
1573 else
1575 /* Just print #n# if OBJ has already been printed. */
1576 sprintf (buf, "#%d#", i + 1);
1577 strout (buf, -1, -1, printcharfun, 0);
1578 return;
1584 print_depth++;
1586 switch (XTYPE (obj))
1588 case Lisp_Int:
1589 if (sizeof (int) == sizeof (EMACS_INT))
1590 sprintf (buf, "%d", (int) XINT (obj));
1591 else if (sizeof (long) == sizeof (EMACS_INT))
1592 sprintf (buf, "%ld", (long) XINT (obj));
1593 else
1594 abort ();
1595 strout (buf, -1, -1, printcharfun, 0);
1596 break;
1598 case Lisp_Float:
1600 char pigbuf[350]; /* see comments in float_to_string */
1602 float_to_string (pigbuf, XFLOAT_DATA (obj));
1603 strout (pigbuf, -1, -1, printcharfun, 0);
1605 break;
1607 case Lisp_String:
1608 if (!escapeflag)
1609 print_string (obj, printcharfun);
1610 else
1612 register int i, i_byte;
1613 struct gcpro gcpro1;
1614 unsigned char *str;
1615 int size_byte;
1616 /* 1 means we must ensure that the next character we output
1617 cannot be taken as part of a hex character escape. */
1618 int need_nonhex = 0;
1619 int multibyte = STRING_MULTIBYTE (obj);
1621 GCPRO1 (obj);
1623 if (! EQ (Vprint_charset_text_property, Qt))
1624 obj = print_prune_string_charset (obj);
1626 if (!NULL_INTERVAL_P (STRING_INTERVALS (obj)))
1628 PRINTCHAR ('#');
1629 PRINTCHAR ('(');
1632 PRINTCHAR ('\"');
1633 str = SDATA (obj);
1634 size_byte = SBYTES (obj);
1636 for (i = 0, i_byte = 0; i_byte < size_byte;)
1638 /* Here, we must convert each multi-byte form to the
1639 corresponding character code before handing it to PRINTCHAR. */
1640 int len;
1641 int c;
1643 if (multibyte)
1645 c = STRING_CHAR_AND_LENGTH (str + i_byte,
1646 size_byte - i_byte, len);
1647 i_byte += len;
1649 else
1650 c = str[i_byte++];
1652 QUIT;
1654 if (c == '\n' && print_escape_newlines)
1656 PRINTCHAR ('\\');
1657 PRINTCHAR ('n');
1659 else if (c == '\f' && print_escape_newlines)
1661 PRINTCHAR ('\\');
1662 PRINTCHAR ('f');
1664 else if (multibyte
1665 && (CHAR_BYTE8_P (c)
1666 || (! ASCII_CHAR_P (c) && print_escape_multibyte)))
1668 /* When multibyte is disabled,
1669 print multibyte string chars using hex escapes.
1670 For a char code that could be in a unibyte string,
1671 when found in a multibyte string, always use a hex escape
1672 so it reads back as multibyte. */
1673 unsigned char outbuf[50];
1675 if (CHAR_BYTE8_P (c))
1676 sprintf (outbuf, "\\%03o", CHAR_TO_BYTE8 (c));
1677 else
1679 sprintf (outbuf, "\\x%04x", c);
1680 need_nonhex = 1;
1682 strout (outbuf, -1, -1, printcharfun, 0);
1684 else if (! multibyte
1685 && SINGLE_BYTE_CHAR_P (c) && ! ASCII_BYTE_P (c)
1686 && print_escape_nonascii)
1688 /* When printing in a multibyte buffer
1689 or when explicitly requested,
1690 print single-byte non-ASCII string chars
1691 using octal escapes. */
1692 unsigned char outbuf[5];
1693 sprintf (outbuf, "\\%03o", c);
1694 strout (outbuf, -1, -1, printcharfun, 0);
1696 else
1698 /* If we just had a hex escape, and this character
1699 could be taken as part of it,
1700 output `\ ' to prevent that. */
1701 if (need_nonhex)
1703 need_nonhex = 0;
1704 if ((c >= 'a' && c <= 'f')
1705 || (c >= 'A' && c <= 'F')
1706 || (c >= '0' && c <= '9'))
1707 strout ("\\ ", -1, -1, printcharfun, 0);
1710 if (c == '\"' || c == '\\')
1711 PRINTCHAR ('\\');
1712 PRINTCHAR (c);
1715 PRINTCHAR ('\"');
1717 if (!NULL_INTERVAL_P (STRING_INTERVALS (obj)))
1719 traverse_intervals (STRING_INTERVALS (obj),
1720 0, print_interval, printcharfun);
1721 PRINTCHAR (')');
1724 UNGCPRO;
1726 break;
1728 case Lisp_Symbol:
1730 register int confusing;
1731 register unsigned char *p = SDATA (SYMBOL_NAME (obj));
1732 register unsigned char *end = p + SBYTES (SYMBOL_NAME (obj));
1733 register int c;
1734 int i, i_byte, size_byte;
1735 Lisp_Object name;
1737 name = SYMBOL_NAME (obj);
1739 if (p != end && (*p == '-' || *p == '+')) p++;
1740 if (p == end)
1741 confusing = 0;
1742 /* If symbol name begins with a digit, and ends with a digit,
1743 and contains nothing but digits and `e', it could be treated
1744 as a number. So set CONFUSING.
1746 Symbols that contain periods could also be taken as numbers,
1747 but periods are always escaped, so we don't have to worry
1748 about them here. */
1749 else if (*p >= '0' && *p <= '9'
1750 && end[-1] >= '0' && end[-1] <= '9')
1752 while (p != end && ((*p >= '0' && *p <= '9')
1753 /* Needed for \2e10. */
1754 || *p == 'e'))
1755 p++;
1756 confusing = (end == p);
1758 else
1759 confusing = 0;
1761 if (! NILP (Vprint_gensym) && !SYMBOL_INTERNED_P (obj))
1763 PRINTCHAR ('#');
1764 PRINTCHAR (':');
1767 size_byte = SBYTES (name);
1769 for (i = 0, i_byte = 0; i_byte < size_byte;)
1771 /* Here, we must convert each multi-byte form to the
1772 corresponding character code before handing it to PRINTCHAR. */
1773 FETCH_STRING_CHAR_ADVANCE (c, name, i, i_byte);
1774 QUIT;
1776 if (escapeflag)
1778 if (c == '\"' || c == '\\' || c == '\''
1779 || c == ';' || c == '#' || c == '(' || c == ')'
1780 || c == ',' || c =='.' || c == '`'
1781 || c == '[' || c == ']' || c == '?' || c <= 040
1782 || confusing)
1783 PRINTCHAR ('\\'), confusing = 0;
1785 PRINTCHAR (c);
1788 break;
1790 case Lisp_Cons:
1791 /* If deeper than spec'd depth, print placeholder. */
1792 if (INTEGERP (Vprint_level)
1793 && print_depth > XINT (Vprint_level))
1794 strout ("...", -1, -1, printcharfun, 0);
1795 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1796 && (EQ (XCAR (obj), Qquote)))
1798 PRINTCHAR ('\'');
1799 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1801 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1802 && (EQ (XCAR (obj), Qfunction)))
1804 PRINTCHAR ('#');
1805 PRINTCHAR ('\'');
1806 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1808 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1809 && ((EQ (XCAR (obj), Qbackquote))))
1811 print_object (XCAR (obj), printcharfun, 0);
1812 new_backquote_output++;
1813 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1814 new_backquote_output--;
1816 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1817 && new_backquote_output
1818 && ((EQ (XCAR (obj), Qbackquote)
1819 || EQ (XCAR (obj), Qcomma)
1820 || EQ (XCAR (obj), Qcomma_at)
1821 || EQ (XCAR (obj), Qcomma_dot))))
1823 print_object (XCAR (obj), printcharfun, 0);
1824 new_backquote_output--;
1825 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1826 new_backquote_output++;
1828 else
1830 PRINTCHAR ('(');
1832 /* If the first element is a backquote form,
1833 print it old-style so it won't be misunderstood. */
1834 if (print_quoted && CONSP (XCAR (obj))
1835 && CONSP (XCDR (XCAR (obj)))
1836 && NILP (XCDR (XCDR (XCAR (obj))))
1837 && EQ (XCAR (XCAR (obj)), Qbackquote))
1839 Lisp_Object tem;
1840 tem = XCAR (obj);
1841 PRINTCHAR ('(');
1843 print_object (Qbackquote, printcharfun, 0);
1844 PRINTCHAR (' ');
1846 print_object (XCAR (XCDR (tem)), printcharfun, 0);
1847 PRINTCHAR (')');
1849 obj = XCDR (obj);
1853 int print_length, i;
1854 Lisp_Object halftail = obj;
1856 /* Negative values of print-length are invalid in CL.
1857 Treat them like nil, as CMUCL does. */
1858 if (NATNUMP (Vprint_length))
1859 print_length = XFASTINT (Vprint_length);
1860 else
1861 print_length = 0;
1863 i = 0;
1864 while (CONSP (obj))
1866 /* Detect circular list. */
1867 if (NILP (Vprint_circle))
1869 /* Simple but imcomplete way. */
1870 if (i != 0 && EQ (obj, halftail))
1872 sprintf (buf, " . #%d", i / 2);
1873 strout (buf, -1, -1, printcharfun, 0);
1874 goto end_of_list;
1877 else
1879 /* With the print-circle feature. */
1880 if (i != 0)
1882 int i;
1883 for (i = 0; i < print_number_index; i++)
1884 if (EQ (PRINT_NUMBER_OBJECT (Vprint_number_table, i),
1885 obj))
1887 if (NILP (PRINT_NUMBER_STATUS (Vprint_number_table, i)))
1889 strout (" . ", 3, 3, printcharfun, 0);
1890 print_object (obj, printcharfun, escapeflag);
1892 else
1894 sprintf (buf, " . #%d#", i + 1);
1895 strout (buf, -1, -1, printcharfun, 0);
1897 goto end_of_list;
1902 if (i++)
1903 PRINTCHAR (' ');
1905 if (print_length && i > print_length)
1907 strout ("...", 3, 3, printcharfun, 0);
1908 goto end_of_list;
1911 print_object (XCAR (obj), printcharfun, escapeflag);
1913 obj = XCDR (obj);
1914 if (!(i & 1))
1915 halftail = XCDR (halftail);
1919 /* OBJ non-nil here means it's the end of a dotted list. */
1920 if (!NILP (obj))
1922 strout (" . ", 3, 3, printcharfun, 0);
1923 print_object (obj, printcharfun, escapeflag);
1926 end_of_list:
1927 PRINTCHAR (')');
1929 break;
1931 case Lisp_Vectorlike:
1932 if (PROCESSP (obj))
1934 if (escapeflag)
1936 strout ("#<process ", -1, -1, printcharfun, 0);
1937 print_string (XPROCESS (obj)->name, printcharfun);
1938 PRINTCHAR ('>');
1940 else
1941 print_string (XPROCESS (obj)->name, printcharfun);
1943 else if (BOOL_VECTOR_P (obj))
1945 register int i;
1946 register unsigned char c;
1947 struct gcpro gcpro1;
1948 int size_in_chars
1949 = ((XBOOL_VECTOR (obj)->size + BOOL_VECTOR_BITS_PER_CHAR - 1)
1950 / BOOL_VECTOR_BITS_PER_CHAR);
1952 GCPRO1 (obj);
1954 PRINTCHAR ('#');
1955 PRINTCHAR ('&');
1956 sprintf (buf, "%ld", (long) XBOOL_VECTOR (obj)->size);
1957 strout (buf, -1, -1, printcharfun, 0);
1958 PRINTCHAR ('\"');
1960 /* Don't print more characters than the specified maximum.
1961 Negative values of print-length are invalid. Treat them
1962 like a print-length of nil. */
1963 if (NATNUMP (Vprint_length)
1964 && XFASTINT (Vprint_length) < size_in_chars)
1965 size_in_chars = XFASTINT (Vprint_length);
1967 for (i = 0; i < size_in_chars; i++)
1969 QUIT;
1970 c = XBOOL_VECTOR (obj)->data[i];
1971 if (c == '\n' && print_escape_newlines)
1973 PRINTCHAR ('\\');
1974 PRINTCHAR ('n');
1976 else if (c == '\f' && print_escape_newlines)
1978 PRINTCHAR ('\\');
1979 PRINTCHAR ('f');
1981 else if (c > '\177')
1983 /* Use octal escapes to avoid encoding issues. */
1984 PRINTCHAR ('\\');
1985 PRINTCHAR ('0' + ((c >> 6) & 3));
1986 PRINTCHAR ('0' + ((c >> 3) & 7));
1987 PRINTCHAR ('0' + (c & 7));
1989 else
1991 if (c == '\"' || c == '\\')
1992 PRINTCHAR ('\\');
1993 PRINTCHAR (c);
1996 PRINTCHAR ('\"');
1998 UNGCPRO;
2000 else if (SUBRP (obj))
2002 strout ("#<subr ", -1, -1, printcharfun, 0);
2003 strout (XSUBR (obj)->symbol_name, -1, -1, printcharfun, 0);
2004 PRINTCHAR ('>');
2006 else if (WINDOWP (obj))
2008 strout ("#<window ", -1, -1, printcharfun, 0);
2009 sprintf (buf, "%ld", (long) XFASTINT (XWINDOW (obj)->sequence_number));
2010 strout (buf, -1, -1, printcharfun, 0);
2011 if (!NILP (XWINDOW (obj)->buffer))
2013 strout (" on ", -1, -1, printcharfun, 0);
2014 print_string (XBUFFER (XWINDOW (obj)->buffer)->name, printcharfun);
2016 PRINTCHAR ('>');
2018 else if (TERMINALP (obj))
2020 struct terminal *t = XTERMINAL (obj);
2021 strout ("#<terminal ", -1, -1, printcharfun, 0);
2022 sprintf (buf, "%d", t->id);
2023 strout (buf, -1, -1, printcharfun, 0);
2024 if (t->name)
2026 strout (" on ", -1, -1, printcharfun, 0);
2027 strout (t->name, -1, -1, printcharfun, 0);
2029 PRINTCHAR ('>');
2031 else if (HASH_TABLE_P (obj))
2033 struct Lisp_Hash_Table *h = XHASH_TABLE (obj);
2034 strout ("#<hash-table", -1, -1, printcharfun, 0);
2035 if (SYMBOLP (h->test))
2037 PRINTCHAR (' ');
2038 PRINTCHAR ('\'');
2039 strout (SDATA (SYMBOL_NAME (h->test)), -1, -1, printcharfun, 0);
2040 PRINTCHAR (' ');
2041 strout (SDATA (SYMBOL_NAME (h->weak)), -1, -1, printcharfun, 0);
2042 PRINTCHAR (' ');
2043 sprintf (buf, "%ld/%ld", (long) h->count,
2044 (long) XVECTOR (h->next)->size);
2045 strout (buf, -1, -1, printcharfun, 0);
2047 sprintf (buf, " 0x%lx", (unsigned long) h);
2048 strout (buf, -1, -1, printcharfun, 0);
2049 PRINTCHAR ('>');
2051 else if (BUFFERP (obj))
2053 if (NILP (XBUFFER (obj)->name))
2054 strout ("#<killed buffer>", -1, -1, printcharfun, 0);
2055 else if (escapeflag)
2057 strout ("#<buffer ", -1, -1, printcharfun, 0);
2058 print_string (XBUFFER (obj)->name, printcharfun);
2059 PRINTCHAR ('>');
2061 else
2062 print_string (XBUFFER (obj)->name, printcharfun);
2064 else if (WINDOW_CONFIGURATIONP (obj))
2066 strout ("#<window-configuration>", -1, -1, printcharfun, 0);
2068 else if (FRAMEP (obj))
2070 strout ((FRAME_LIVE_P (XFRAME (obj))
2071 ? "#<frame " : "#<dead frame "),
2072 -1, -1, printcharfun, 0);
2073 print_string (XFRAME (obj)->name, printcharfun);
2074 sprintf (buf, " 0x%lx", (unsigned long) (XFRAME (obj)));
2075 strout (buf, -1, -1, printcharfun, 0);
2076 PRINTCHAR ('>');
2078 else if (FONTP (obj))
2080 EMACS_INT i;
2082 if (! FONT_OBJECT_P (obj))
2084 if (FONT_SPEC_P (obj))
2085 strout ("#<font-spec", -1, -1, printcharfun, 0);
2086 else
2087 strout ("#<font-entity", -1, -1, printcharfun, 0);
2088 for (i = 0; i < FONT_SPEC_MAX; i++)
2090 PRINTCHAR (' ');
2091 if (i < FONT_WEIGHT_INDEX || i > FONT_WIDTH_INDEX)
2092 print_object (AREF (obj, i), printcharfun, escapeflag);
2093 else
2094 print_object (font_style_symbolic (obj, i, 0),
2095 printcharfun, escapeflag);
2098 else
2100 strout ("#<font-object ", -1, -1, printcharfun, 0);
2101 print_object (AREF (obj, FONT_NAME_INDEX), printcharfun,
2102 escapeflag);
2104 PRINTCHAR ('>');
2106 else
2108 EMACS_INT size = XVECTOR (obj)->size;
2109 if (COMPILEDP (obj))
2111 PRINTCHAR ('#');
2112 size &= PSEUDOVECTOR_SIZE_MASK;
2114 if (CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj))
2116 /* We print a char-table as if it were a vector,
2117 lumping the parent and default slots in with the
2118 character slots. But we add #^ as a prefix. */
2120 /* Make each lowest sub_char_table start a new line.
2121 Otherwise we'll make a line extremely long, which
2122 results in slow redisplay. */
2123 if (SUB_CHAR_TABLE_P (obj)
2124 && XINT (XSUB_CHAR_TABLE (obj)->depth) == 3)
2125 PRINTCHAR ('\n');
2126 PRINTCHAR ('#');
2127 PRINTCHAR ('^');
2128 if (SUB_CHAR_TABLE_P (obj))
2129 PRINTCHAR ('^');
2130 size &= PSEUDOVECTOR_SIZE_MASK;
2132 if (size & PSEUDOVECTOR_FLAG)
2133 goto badtype;
2135 PRINTCHAR ('[');
2137 register int i;
2138 register Lisp_Object tem;
2139 int real_size = size;
2141 /* Don't print more elements than the specified maximum. */
2142 if (NATNUMP (Vprint_length)
2143 && XFASTINT (Vprint_length) < size)
2144 size = XFASTINT (Vprint_length);
2146 for (i = 0; i < size; i++)
2148 if (i) PRINTCHAR (' ');
2149 tem = XVECTOR (obj)->contents[i];
2150 print_object (tem, printcharfun, escapeflag);
2152 if (size < real_size)
2153 strout (" ...", 4, 4, printcharfun, 0);
2155 PRINTCHAR (']');
2157 break;
2159 case Lisp_Misc:
2160 switch (XMISCTYPE (obj))
2162 case Lisp_Misc_Marker:
2163 strout ("#<marker ", -1, -1, printcharfun, 0);
2164 /* Do you think this is necessary? */
2165 if (XMARKER (obj)->insertion_type != 0)
2166 strout ("(moves after insertion) ", -1, -1, printcharfun, 0);
2167 if (! XMARKER (obj)->buffer)
2168 strout ("in no buffer", -1, -1, printcharfun, 0);
2169 else
2171 sprintf (buf, "at %d", marker_position (obj));
2172 strout (buf, -1, -1, printcharfun, 0);
2173 strout (" in ", -1, -1, printcharfun, 0);
2174 print_string (XMARKER (obj)->buffer->name, printcharfun);
2176 PRINTCHAR ('>');
2177 break;
2179 case Lisp_Misc_Overlay:
2180 strout ("#<overlay ", -1, -1, printcharfun, 0);
2181 if (! XMARKER (OVERLAY_START (obj))->buffer)
2182 strout ("in no buffer", -1, -1, printcharfun, 0);
2183 else
2185 sprintf (buf, "from %d to %d in ",
2186 marker_position (OVERLAY_START (obj)),
2187 marker_position (OVERLAY_END (obj)));
2188 strout (buf, -1, -1, printcharfun, 0);
2189 print_string (XMARKER (OVERLAY_START (obj))->buffer->name,
2190 printcharfun);
2192 PRINTCHAR ('>');
2193 break;
2195 /* Remaining cases shouldn't happen in normal usage, but let's print
2196 them anyway for the benefit of the debugger. */
2197 case Lisp_Misc_Free:
2198 strout ("#<misc free cell>", -1, -1, printcharfun, 0);
2199 break;
2201 case Lisp_Misc_Intfwd:
2202 sprintf (buf, "#<intfwd to %ld>", (long) *XINTFWD (obj)->intvar);
2203 strout (buf, -1, -1, printcharfun, 0);
2204 break;
2206 case Lisp_Misc_Boolfwd:
2207 sprintf (buf, "#<boolfwd to %s>",
2208 (*XBOOLFWD (obj)->boolvar ? "t" : "nil"));
2209 strout (buf, -1, -1, printcharfun, 0);
2210 break;
2212 case Lisp_Misc_Objfwd:
2213 strout ("#<objfwd to ", -1, -1, printcharfun, 0);
2214 print_object (*XOBJFWD (obj)->objvar, printcharfun, escapeflag);
2215 PRINTCHAR ('>');
2216 break;
2218 case Lisp_Misc_Buffer_Objfwd:
2219 strout ("#<buffer_objfwd to ", -1, -1, printcharfun, 0);
2220 print_object (PER_BUFFER_VALUE (current_buffer,
2221 XBUFFER_OBJFWD (obj)->offset),
2222 printcharfun, escapeflag);
2223 PRINTCHAR ('>');
2224 break;
2226 case Lisp_Misc_Kboard_Objfwd:
2227 strout ("#<kboard_objfwd to ", -1, -1, printcharfun, 0);
2228 print_object (*(Lisp_Object *) ((char *) current_kboard
2229 + XKBOARD_OBJFWD (obj)->offset),
2230 printcharfun, escapeflag);
2231 PRINTCHAR ('>');
2232 break;
2234 case Lisp_Misc_Buffer_Local_Value:
2235 strout ("#<buffer_local_value ", -1, -1, printcharfun, 0);
2236 if (XBUFFER_LOCAL_VALUE (obj)->local_if_set)
2237 strout ("[local-if-set] ", -1, -1, printcharfun, 0);
2238 strout ("[realvalue] ", -1, -1, printcharfun, 0);
2239 print_object (XBUFFER_LOCAL_VALUE (obj)->realvalue,
2240 printcharfun, escapeflag);
2241 if (XBUFFER_LOCAL_VALUE (obj)->found_for_buffer)
2242 strout ("[local in buffer] ", -1, -1, printcharfun, 0);
2243 else
2244 strout ("[buffer] ", -1, -1, printcharfun, 0);
2245 print_object (XBUFFER_LOCAL_VALUE (obj)->buffer,
2246 printcharfun, escapeflag);
2247 if (XBUFFER_LOCAL_VALUE (obj)->check_frame)
2249 if (XBUFFER_LOCAL_VALUE (obj)->found_for_frame)
2250 strout ("[local in frame] ", -1, -1, printcharfun, 0);
2251 else
2252 strout ("[frame] ", -1, -1, printcharfun, 0);
2253 print_object (XBUFFER_LOCAL_VALUE (obj)->frame,
2254 printcharfun, escapeflag);
2256 strout ("[alist-elt] ", -1, -1, printcharfun, 0);
2257 print_object (XCAR (XBUFFER_LOCAL_VALUE (obj)->cdr),
2258 printcharfun, escapeflag);
2259 strout ("[default-value] ", -1, -1, printcharfun, 0);
2260 print_object (XCDR (XBUFFER_LOCAL_VALUE (obj)->cdr),
2261 printcharfun, escapeflag);
2262 PRINTCHAR ('>');
2263 break;
2265 case Lisp_Misc_Save_Value:
2266 strout ("#<save_value ", -1, -1, printcharfun, 0);
2267 sprintf(buf, "ptr=0x%08lx int=%d",
2268 (unsigned long) XSAVE_VALUE (obj)->pointer,
2269 XSAVE_VALUE (obj)->integer);
2270 strout (buf, -1, -1, printcharfun, 0);
2271 PRINTCHAR ('>');
2272 break;
2274 default:
2275 goto badtype;
2277 break;
2279 default:
2280 badtype:
2282 /* We're in trouble if this happens!
2283 Probably should just abort () */
2284 strout ("#<EMACS BUG: INVALID DATATYPE ", -1, -1, printcharfun, 0);
2285 if (MISCP (obj))
2286 sprintf (buf, "(MISC 0x%04x)", (int) XMISCTYPE (obj));
2287 else if (VECTORLIKEP (obj))
2288 sprintf (buf, "(PVEC 0x%08x)", (int) XVECTOR (obj)->size);
2289 else
2290 sprintf (buf, "(0x%02x)", (int) XTYPE (obj));
2291 strout (buf, -1, -1, printcharfun, 0);
2292 strout (" Save your buffers immediately and please report this bug>",
2293 -1, -1, printcharfun, 0);
2297 print_depth--;
2301 /* Print a description of INTERVAL using PRINTCHARFUN.
2302 This is part of printing a string that has text properties. */
2304 void
2305 print_interval (interval, printcharfun)
2306 INTERVAL interval;
2307 Lisp_Object printcharfun;
2309 if (NILP (interval->plist))
2310 return;
2311 PRINTCHAR (' ');
2312 print_object (make_number (interval->position), printcharfun, 1);
2313 PRINTCHAR (' ');
2314 print_object (make_number (interval->position + LENGTH (interval)),
2315 printcharfun, 1);
2316 PRINTCHAR (' ');
2317 print_object (interval->plist, printcharfun, 1);
2321 void
2322 syms_of_print ()
2324 Qtemp_buffer_setup_hook = intern ("temp-buffer-setup-hook");
2325 staticpro (&Qtemp_buffer_setup_hook);
2327 DEFVAR_LISP ("standard-output", &Vstandard_output,
2328 doc: /* Output stream `print' uses by default for outputting a character.
2329 This may be any function of one argument.
2330 It may also be a buffer (output is inserted before point)
2331 or a marker (output is inserted and the marker is advanced)
2332 or the symbol t (output appears in the echo area). */);
2333 Vstandard_output = Qt;
2334 Qstandard_output = intern ("standard-output");
2335 staticpro (&Qstandard_output);
2337 DEFVAR_LISP ("float-output-format", &Vfloat_output_format,
2338 doc: /* The format descriptor string used to print floats.
2339 This is a %-spec like those accepted by `printf' in C,
2340 but with some restrictions. It must start with the two characters `%.'.
2341 After that comes an integer precision specification,
2342 and then a letter which controls the format.
2343 The letters allowed are `e', `f' and `g'.
2344 Use `e' for exponential notation \"DIG.DIGITSeEXPT\"
2345 Use `f' for decimal point notation \"DIGITS.DIGITS\".
2346 Use `g' to choose the shorter of those two formats for the number at hand.
2347 The precision in any of these cases is the number of digits following
2348 the decimal point. With `f', a precision of 0 means to omit the
2349 decimal point. 0 is not allowed with `e' or `g'.
2351 A value of nil means to use the shortest notation
2352 that represents the number without losing information. */);
2353 Vfloat_output_format = Qnil;
2354 Qfloat_output_format = intern ("float-output-format");
2355 staticpro (&Qfloat_output_format);
2357 DEFVAR_LISP ("print-length", &Vprint_length,
2358 doc: /* Maximum length of list to print before abbreviating.
2359 A value of nil means no limit. See also `eval-expression-print-length'. */);
2360 Vprint_length = Qnil;
2362 DEFVAR_LISP ("print-level", &Vprint_level,
2363 doc: /* Maximum depth of list nesting to print before abbreviating.
2364 A value of nil means no limit. See also `eval-expression-print-level'. */);
2365 Vprint_level = Qnil;
2367 DEFVAR_BOOL ("print-escape-newlines", &print_escape_newlines,
2368 doc: /* Non-nil means print newlines in strings as `\\n'.
2369 Also print formfeeds as `\\f'. */);
2370 print_escape_newlines = 0;
2372 DEFVAR_BOOL ("print-escape-nonascii", &print_escape_nonascii,
2373 doc: /* Non-nil means print unibyte non-ASCII chars in strings as \\OOO.
2374 \(OOO is the octal representation of the character code.)
2375 Only single-byte characters are affected, and only in `prin1'.
2376 When the output goes in a multibyte buffer, this feature is
2377 enabled regardless of the value of the variable. */);
2378 print_escape_nonascii = 0;
2380 DEFVAR_BOOL ("print-escape-multibyte", &print_escape_multibyte,
2381 doc: /* Non-nil means print multibyte characters in strings as \\xXXXX.
2382 \(XXXX is the hex representation of the character code.)
2383 This affects only `prin1'. */);
2384 print_escape_multibyte = 0;
2386 DEFVAR_BOOL ("print-quoted", &print_quoted,
2387 doc: /* Non-nil means print quoted forms with reader syntax.
2388 I.e., (quote foo) prints as 'foo, (function foo) as #'foo. */);
2389 print_quoted = 0;
2391 DEFVAR_LISP ("print-gensym", &Vprint_gensym,
2392 doc: /* Non-nil means print uninterned symbols so they will read as uninterned.
2393 I.e., the value of (make-symbol \"foobar\") prints as #:foobar.
2394 When the uninterned symbol appears within a recursive data structure,
2395 and the symbol appears more than once, in addition use the #N# and #N=
2396 constructs as needed, so that multiple references to the same symbol are
2397 shared once again when the text is read back. */);
2398 Vprint_gensym = Qnil;
2400 DEFVAR_LISP ("print-circle", &Vprint_circle,
2401 doc: /* *Non-nil means print recursive structures using #N= and #N# syntax.
2402 If nil, printing proceeds recursively and may lead to
2403 `max-lisp-eval-depth' being exceeded or an error may occur:
2404 \"Apparently circular structure being printed.\" Also see
2405 `print-length' and `print-level'.
2406 If non-nil, shared substructures anywhere in the structure are printed
2407 with `#N=' before the first occurrence (in the order of the print
2408 representation) and `#N#' in place of each subsequent occurrence,
2409 where N is a positive decimal integer. */);
2410 Vprint_circle = Qnil;
2412 DEFVAR_LISP ("print-continuous-numbering", &Vprint_continuous_numbering,
2413 doc: /* *Non-nil means number continuously across print calls.
2414 This affects the numbers printed for #N= labels and #M# references.
2415 See also `print-circle', `print-gensym', and `print-number-table'.
2416 This variable should not be set with `setq'; bind it with a `let' instead. */);
2417 Vprint_continuous_numbering = Qnil;
2419 DEFVAR_LISP ("print-number-table", &Vprint_number_table,
2420 doc: /* A vector used internally to produce `#N=' labels and `#N#' references.
2421 The Lisp printer uses this vector to detect Lisp objects referenced more
2422 than once.
2424 When you bind `print-continuous-numbering' to t, you should probably
2425 also bind `print-number-table' to nil. This ensures that the value of
2426 `print-number-table' can be garbage-collected once the printing is
2427 done. If all elements of `print-number-table' are nil, it means that
2428 the printing done so far has not found any shared structure or objects
2429 that need to be recorded in the table. */);
2430 Vprint_number_table = Qnil;
2432 DEFVAR_LISP ("print-charset-text-property", &Vprint_charset_text_property,
2433 doc: /* A flag to control printing of `charset' text property on printing a string.
2434 The value must be nil, t, or `default'.
2436 If the value is nil, don't print the text property `charset'.
2438 If the value is t, always print the text property `charset'.
2440 If the value is `default', print the text property `charset' only when
2441 the value is different from what is guessed in the current charset
2442 priorities. */);
2443 Vprint_charset_text_property = Qdefault;
2445 /* prin1_to_string_buffer initialized in init_buffer_once in buffer.c */
2446 staticpro (&Vprin1_to_string_buffer);
2448 defsubr (&Sprin1);
2449 defsubr (&Sprin1_to_string);
2450 defsubr (&Serror_message_string);
2451 defsubr (&Sprinc);
2452 defsubr (&Sprint);
2453 defsubr (&Sterpri);
2454 defsubr (&Swrite_char);
2455 defsubr (&Sexternal_debugging_output);
2456 #ifdef WITH_REDIRECT_DEBUGGING_OUTPUT
2457 defsubr (&Sredirect_debugging_output);
2458 #endif
2460 Qexternal_debugging_output = intern ("external-debugging-output");
2461 staticpro (&Qexternal_debugging_output);
2463 Qprint_escape_newlines = intern ("print-escape-newlines");
2464 staticpro (&Qprint_escape_newlines);
2466 Qprint_escape_multibyte = intern ("print-escape-multibyte");
2467 staticpro (&Qprint_escape_multibyte);
2469 Qprint_escape_nonascii = intern ("print-escape-nonascii");
2470 staticpro (&Qprint_escape_nonascii);
2472 print_prune_charset_plist = Qnil;
2473 staticpro (&print_prune_charset_plist);
2475 defsubr (&Swith_output_to_temp_buffer);
2478 /* arch-tag: bc797170-94ae-41de-86e3-75e20f8f7a39
2479 (do not change this comment) */