(cal-html-insert-link-yearpage, (cal-html-htmlify-list): Doc fix.
[emacs.git] / src / print.c
blobd5781e28bd427af1e9566f21d6e8a7f44a0450aa
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 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
11 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; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
24 #include <config.h>
25 #include <stdio.h>
26 #include "lisp.h"
27 #include "buffer.h"
28 #include "character.h"
29 #include "charset.h"
30 #include "keyboard.h"
31 #include "frame.h"
32 #include "window.h"
33 #include "process.h"
34 #include "dispextern.h"
35 #include "termchar.h"
36 #include "intervals.h"
37 #include "blockinput.h"
38 #include "termhooks.h" /* For struct terminal. */
40 Lisp_Object Vstandard_output, Qstandard_output;
42 Lisp_Object Qtemp_buffer_setup_hook;
44 /* These are used to print like we read. */
45 extern Lisp_Object Qbackquote, Qcomma, Qcomma_at, Qcomma_dot, Qfunction;
47 Lisp_Object Vfloat_output_format, Qfloat_output_format;
49 /* Work around a problem that happens because math.h on hpux 7
50 defines two static variables--which, in Emacs, are not really static,
51 because `static' is defined as nothing. The problem is that they are
52 defined both here and in lread.c.
53 These macros prevent the name conflict. */
54 #if defined (HPUX) && !defined (HPUX8)
55 #define _MAXLDBL print_maxldbl
56 #define _NMAXLDBL print_nmaxldbl
57 #endif
59 #include <math.h>
61 #if STDC_HEADERS
62 #include <float.h>
63 #endif
65 /* Default to values appropriate for IEEE floating point. */
66 #ifndef FLT_RADIX
67 #define FLT_RADIX 2
68 #endif
69 #ifndef DBL_MANT_DIG
70 #define DBL_MANT_DIG 53
71 #endif
72 #ifndef DBL_DIG
73 #define DBL_DIG 15
74 #endif
75 #ifndef DBL_MIN
76 #define DBL_MIN 2.2250738585072014e-308
77 #endif
79 #ifdef DBL_MIN_REPLACEMENT
80 #undef DBL_MIN
81 #define DBL_MIN DBL_MIN_REPLACEMENT
82 #endif
84 /* Define DOUBLE_DIGITS_BOUND, an upper bound on the number of decimal digits
85 needed to express a float without losing information.
86 The general-case formula is valid for the usual case, IEEE floating point,
87 but many compilers can't optimize the formula to an integer constant,
88 so make a special case for it. */
89 #if FLT_RADIX == 2 && DBL_MANT_DIG == 53
90 #define DOUBLE_DIGITS_BOUND 17 /* IEEE floating point */
91 #else
92 #define DOUBLE_DIGITS_BOUND ((int) ceil (log10 (pow (FLT_RADIX, DBL_MANT_DIG))))
93 #endif
95 /* Avoid actual stack overflow in print. */
96 int print_depth;
98 /* Level of nesting inside outputting backquote in new style. */
99 int new_backquote_output;
101 /* Detect most circularities to print finite output. */
102 #define PRINT_CIRCLE 200
103 Lisp_Object being_printed[PRINT_CIRCLE];
105 /* When printing into a buffer, first we put the text in this
106 block, then insert it all at once. */
107 char *print_buffer;
109 /* Size allocated in print_buffer. */
110 int print_buffer_size;
111 /* Chars stored in print_buffer. */
112 int print_buffer_pos;
113 /* Bytes stored in print_buffer. */
114 int print_buffer_pos_byte;
116 /* Maximum length of list to print in full; noninteger means
117 effectively infinity */
119 Lisp_Object Vprint_length;
121 /* Maximum depth of list to print in full; noninteger means
122 effectively infinity. */
124 Lisp_Object Vprint_level;
126 /* Nonzero means print newlines in strings as \n. */
128 int print_escape_newlines;
130 /* Nonzero means to print single-byte non-ascii characters in strings as
131 octal escapes. */
133 int print_escape_nonascii;
135 /* Nonzero means to print multibyte characters in strings as hex escapes. */
137 int print_escape_multibyte;
139 Lisp_Object Qprint_escape_newlines;
140 Lisp_Object Qprint_escape_multibyte, Qprint_escape_nonascii;
142 /* Nonzero means print (quote foo) forms as 'foo, etc. */
144 int print_quoted;
146 /* Non-nil means print #: before uninterned symbols. */
148 Lisp_Object Vprint_gensym;
150 /* Non-nil means print recursive structures using #n= and #n# syntax. */
152 Lisp_Object Vprint_circle;
154 /* Non-nil means keep continuous number for #n= and #n# syntax
155 between several print functions. */
157 Lisp_Object Vprint_continuous_numbering;
159 /* Vprint_number_table is a vector like [OBJ1 STAT1 OBJ2 STAT2 ...],
160 where OBJn are objects going to be printed, and STATn are their status,
161 which may be different meanings during process. See the comments of
162 the functions print and print_preprocess for details.
163 print_number_index keeps the last position the next object should be added,
164 twice of which is the actual vector position in Vprint_number_table. */
165 int print_number_index;
166 Lisp_Object Vprint_number_table;
168 /* PRINT_NUMBER_OBJECT returns the I'th object in Vprint_number_table TABLE.
169 PRINT_NUMBER_STATUS returns the status of the I'th object in TABLE.
170 See the comment of the variable Vprint_number_table. */
171 #define PRINT_NUMBER_OBJECT(table,i) XVECTOR ((table))->contents[(i) * 2]
172 #define PRINT_NUMBER_STATUS(table,i) XVECTOR ((table))->contents[(i) * 2 + 1]
174 /* Nonzero means print newline to stdout before next minibuffer message.
175 Defined in xdisp.c */
177 extern int noninteractive_need_newline;
179 extern int minibuffer_auto_raise;
181 #ifdef MAX_PRINT_CHARS
182 static int print_chars;
183 static int max_print;
184 #endif /* MAX_PRINT_CHARS */
186 void print_interval ();
188 /* GDB resets this to zero on W32 to disable OutputDebugString calls. */
189 int print_output_debug_flag = 1;
192 /* Low level output routines for characters and strings */
194 /* Lisp functions to do output using a stream
195 must have the stream in a variable called printcharfun
196 and must start with PRINTPREPARE, end with PRINTFINISH,
197 and use PRINTDECLARE to declare common variables.
198 Use PRINTCHAR to output one character,
199 or call strout to output a block of characters. */
201 #define PRINTDECLARE \
202 struct buffer *old = current_buffer; \
203 int old_point = -1, start_point = -1; \
204 int old_point_byte = -1, start_point_byte = -1; \
205 int specpdl_count = SPECPDL_INDEX (); \
206 int free_print_buffer = 0; \
207 int multibyte = !NILP (current_buffer->enable_multibyte_characters); \
208 Lisp_Object original
210 #define PRINTPREPARE \
211 original = printcharfun; \
212 if (NILP (printcharfun)) printcharfun = Qt; \
213 if (BUFFERP (printcharfun)) \
215 if (XBUFFER (printcharfun) != current_buffer) \
216 Fset_buffer (printcharfun); \
217 printcharfun = Qnil; \
219 if (MARKERP (printcharfun)) \
221 EMACS_INT marker_pos; \
222 if (! XMARKER (printcharfun)->buffer) \
223 error ("Marker does not point anywhere"); \
224 if (XMARKER (printcharfun)->buffer != current_buffer) \
225 set_buffer_internal (XMARKER (printcharfun)->buffer); \
226 marker_pos = marker_position (printcharfun); \
227 if (marker_pos < BEGV || marker_pos > ZV) \
228 error ("Marker is outside the accessible part of the buffer"); \
229 old_point = PT; \
230 old_point_byte = PT_BYTE; \
231 SET_PT_BOTH (marker_pos, \
232 marker_byte_position (printcharfun)); \
233 start_point = PT; \
234 start_point_byte = PT_BYTE; \
235 printcharfun = Qnil; \
237 if (NILP (printcharfun)) \
239 Lisp_Object string; \
240 if (NILP (current_buffer->enable_multibyte_characters) \
241 && ! print_escape_multibyte) \
242 specbind (Qprint_escape_multibyte, Qt); \
243 if (! NILP (current_buffer->enable_multibyte_characters) \
244 && ! print_escape_nonascii) \
245 specbind (Qprint_escape_nonascii, Qt); \
246 if (print_buffer != 0) \
248 string = make_string_from_bytes (print_buffer, \
249 print_buffer_pos, \
250 print_buffer_pos_byte); \
251 record_unwind_protect (print_unwind, string); \
253 else \
255 print_buffer_size = 1000; \
256 print_buffer = (char *) xmalloc (print_buffer_size); \
257 free_print_buffer = 1; \
259 print_buffer_pos = 0; \
260 print_buffer_pos_byte = 0; \
262 if (EQ (printcharfun, Qt) && ! noninteractive) \
263 setup_echo_area_for_printing (multibyte);
265 #define PRINTFINISH \
266 if (NILP (printcharfun)) \
268 if (print_buffer_pos != print_buffer_pos_byte \
269 && NILP (current_buffer->enable_multibyte_characters)) \
271 unsigned char *temp \
272 = (unsigned char *) alloca (print_buffer_pos + 1); \
273 copy_text (print_buffer, temp, print_buffer_pos_byte, \
274 1, 0); \
275 insert_1_both (temp, print_buffer_pos, \
276 print_buffer_pos, 0, 1, 0); \
278 else \
279 insert_1_both (print_buffer, print_buffer_pos, \
280 print_buffer_pos_byte, 0, 1, 0); \
281 signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
283 if (free_print_buffer) \
285 xfree (print_buffer); \
286 print_buffer = 0; \
288 unbind_to (specpdl_count, Qnil); \
289 if (MARKERP (original)) \
290 set_marker_both (original, Qnil, PT, PT_BYTE); \
291 if (old_point >= 0) \
292 SET_PT_BOTH (old_point + (old_point >= start_point \
293 ? PT - start_point : 0), \
294 old_point_byte + (old_point_byte >= start_point_byte \
295 ? PT_BYTE - start_point_byte : 0)); \
296 if (old != current_buffer) \
297 set_buffer_internal (old);
299 #define PRINTCHAR(ch) printchar (ch, printcharfun)
301 /* This is used to restore the saved contents of print_buffer
302 when there is a recursive call to print. */
304 static Lisp_Object
305 print_unwind (saved_text)
306 Lisp_Object saved_text;
308 bcopy (SDATA (saved_text), print_buffer, SCHARS (saved_text));
309 return Qnil;
313 /* Print character CH using method FUN. FUN nil means print to
314 print_buffer. FUN t means print to echo area or stdout if
315 non-interactive. If FUN is neither nil nor t, call FUN with CH as
316 argument. */
318 static void
319 printchar (ch, fun)
320 unsigned int ch;
321 Lisp_Object fun;
323 #ifdef MAX_PRINT_CHARS
324 if (max_print)
325 print_chars++;
326 #endif /* MAX_PRINT_CHARS */
328 if (!NILP (fun) && !EQ (fun, Qt))
329 call1 (fun, make_number (ch));
330 else
332 unsigned char str[MAX_MULTIBYTE_LENGTH];
333 int len = CHAR_STRING (ch, str);
335 QUIT;
337 if (NILP (fun))
339 if (print_buffer_pos_byte + len >= print_buffer_size)
340 print_buffer = (char *) xrealloc (print_buffer,
341 print_buffer_size *= 2);
342 bcopy (str, print_buffer + print_buffer_pos_byte, len);
343 print_buffer_pos += 1;
344 print_buffer_pos_byte += len;
346 else if (noninteractive)
348 fwrite (str, 1, len, stdout);
349 noninteractive_need_newline = 1;
351 else
353 int multibyte_p
354 = !NILP (current_buffer->enable_multibyte_characters);
356 setup_echo_area_for_printing (multibyte_p);
357 insert_char (ch);
358 message_dolog (str, len, 0, multibyte_p);
364 /* Output SIZE characters, SIZE_BYTE bytes from string PTR using
365 method PRINTCHARFUN. If SIZE < 0, use the string length of PTR for
366 both SIZE and SIZE_BYTE. PRINTCHARFUN nil means output to
367 print_buffer. PRINTCHARFUN t means output to the echo area or to
368 stdout if non-interactive. If neither nil nor t, call Lisp
369 function PRINTCHARFUN for each character printed. MULTIBYTE
370 non-zero means PTR contains multibyte characters.
372 In the case where PRINTCHARFUN is nil, it is safe for PTR to point
373 to data in a Lisp string. Otherwise that is not safe. */
375 static void
376 strout (ptr, size, size_byte, printcharfun, multibyte)
377 char *ptr;
378 int size, size_byte;
379 Lisp_Object printcharfun;
380 int multibyte;
382 if (size < 0)
383 size_byte = size = strlen (ptr);
385 if (NILP (printcharfun))
387 if (print_buffer_pos_byte + size_byte > print_buffer_size)
389 print_buffer_size = print_buffer_size * 2 + size_byte;
390 print_buffer = (char *) xrealloc (print_buffer,
391 print_buffer_size);
393 bcopy (ptr, print_buffer + print_buffer_pos_byte, size_byte);
394 print_buffer_pos += size;
395 print_buffer_pos_byte += size_byte;
397 #ifdef MAX_PRINT_CHARS
398 if (max_print)
399 print_chars += size;
400 #endif /* MAX_PRINT_CHARS */
402 else if (noninteractive && EQ (printcharfun, Qt))
404 fwrite (ptr, 1, size_byte, stdout);
405 noninteractive_need_newline = 1;
407 else if (EQ (printcharfun, Qt))
409 /* Output to echo area. We're trying to avoid a little overhead
410 here, that's the reason we don't call printchar to do the
411 job. */
412 int i;
413 int multibyte_p
414 = !NILP (current_buffer->enable_multibyte_characters);
416 setup_echo_area_for_printing (multibyte_p);
417 message_dolog (ptr, size_byte, 0, multibyte_p);
419 if (size == size_byte)
421 for (i = 0; i < size; ++i)
422 insert_char ((unsigned char) *ptr++);
424 else
426 int len;
427 for (i = 0; i < size_byte; i += len)
429 int ch = STRING_CHAR_AND_LENGTH (ptr + i, size_byte - i, len);
430 insert_char (ch);
434 #ifdef MAX_PRINT_CHARS
435 if (max_print)
436 print_chars += size;
437 #endif /* MAX_PRINT_CHARS */
439 else
441 /* PRINTCHARFUN is a Lisp function. */
442 int i = 0;
444 if (size == size_byte)
446 while (i < size_byte)
448 int ch = ptr[i++];
449 PRINTCHAR (ch);
452 else
454 while (i < size_byte)
456 /* Here, we must convert each multi-byte form to the
457 corresponding character code before handing it to
458 PRINTCHAR. */
459 int len;
460 int ch = STRING_CHAR_AND_LENGTH (ptr + i, size_byte - i, len);
461 PRINTCHAR (ch);
462 i += len;
468 /* Print the contents of a string STRING using PRINTCHARFUN.
469 It isn't safe to use strout in many cases,
470 because printing one char can relocate. */
472 static void
473 print_string (string, printcharfun)
474 Lisp_Object string;
475 Lisp_Object printcharfun;
477 if (EQ (printcharfun, Qt) || NILP (printcharfun))
479 int chars;
481 if (print_escape_nonascii)
482 string = string_escape_byte8 (string);
484 if (STRING_MULTIBYTE (string))
485 chars = SCHARS (string);
486 else if (! print_escape_nonascii
487 && (EQ (printcharfun, Qt)
488 ? ! NILP (buffer_defaults.enable_multibyte_characters)
489 : ! NILP (current_buffer->enable_multibyte_characters)))
491 /* If unibyte string STRING contains 8-bit codes, we must
492 convert STRING to a multibyte string containing the same
493 character codes. */
494 Lisp_Object newstr;
495 int bytes;
497 chars = SBYTES (string);
498 bytes = parse_str_to_multibyte (SDATA (string), chars);
499 if (chars < bytes)
501 newstr = make_uninit_multibyte_string (chars, bytes);
502 bcopy (SDATA (string), SDATA (newstr), chars);
503 str_to_multibyte (SDATA (newstr), bytes, chars);
504 string = newstr;
507 else
508 chars = SBYTES (string);
510 if (EQ (printcharfun, Qt))
512 /* Output to echo area. */
513 int nbytes = SBYTES (string);
514 char *buffer;
516 /* Copy the string contents so that relocation of STRING by
517 GC does not cause trouble. */
518 USE_SAFE_ALLOCA;
520 SAFE_ALLOCA (buffer, char *, nbytes);
521 bcopy (SDATA (string), buffer, nbytes);
523 strout (buffer, chars, SBYTES (string),
524 printcharfun, STRING_MULTIBYTE (string));
526 SAFE_FREE ();
528 else
529 /* No need to copy, since output to print_buffer can't GC. */
530 strout (SDATA (string),
531 chars, SBYTES (string),
532 printcharfun, STRING_MULTIBYTE (string));
534 else
536 /* Otherwise, string may be relocated by printing one char.
537 So re-fetch the string address for each character. */
538 int i;
539 int size = SCHARS (string);
540 int size_byte = SBYTES (string);
541 struct gcpro gcpro1;
542 GCPRO1 (string);
543 if (size == size_byte)
544 for (i = 0; i < size; i++)
545 PRINTCHAR (SREF (string, i));
546 else
547 for (i = 0; i < size_byte; )
549 /* Here, we must convert each multi-byte form to the
550 corresponding character code before handing it to PRINTCHAR. */
551 int len;
552 int ch = STRING_CHAR_AND_LENGTH (SDATA (string) + i,
553 size_byte - i, len);
554 PRINTCHAR (ch);
555 i += len;
557 UNGCPRO;
561 DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
562 doc: /* Output character CHARACTER to stream PRINTCHARFUN.
563 PRINTCHARFUN defaults to the value of `standard-output' (which see). */)
564 (character, printcharfun)
565 Lisp_Object character, printcharfun;
567 PRINTDECLARE;
569 if (NILP (printcharfun))
570 printcharfun = Vstandard_output;
571 CHECK_NUMBER (character);
572 PRINTPREPARE;
573 PRINTCHAR (XINT (character));
574 PRINTFINISH;
575 return character;
578 /* Used from outside of print.c to print a block of SIZE
579 single-byte chars at DATA on the default output stream.
580 Do not use this on the contents of a Lisp string. */
582 void
583 write_string (data, size)
584 char *data;
585 int size;
587 PRINTDECLARE;
588 Lisp_Object printcharfun;
590 printcharfun = Vstandard_output;
592 PRINTPREPARE;
593 strout (data, size, size, printcharfun, 0);
594 PRINTFINISH;
597 /* Used from outside of print.c to print a block of SIZE
598 single-byte chars at DATA on a specified stream PRINTCHARFUN.
599 Do not use this on the contents of a Lisp string. */
601 void
602 write_string_1 (data, size, printcharfun)
603 char *data;
604 int size;
605 Lisp_Object printcharfun;
607 PRINTDECLARE;
609 PRINTPREPARE;
610 strout (data, size, size, printcharfun, 0);
611 PRINTFINISH;
615 void
616 temp_output_buffer_setup (bufname)
617 const char *bufname;
619 int count = SPECPDL_INDEX ();
620 register struct buffer *old = current_buffer;
621 register Lisp_Object buf;
623 record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
625 Fset_buffer (Fget_buffer_create (build_string (bufname)));
627 Fkill_all_local_variables ();
628 delete_all_overlays (current_buffer);
629 current_buffer->directory = old->directory;
630 current_buffer->read_only = Qnil;
631 current_buffer->filename = Qnil;
632 current_buffer->undo_list = Qt;
633 eassert (current_buffer->overlays_before == NULL);
634 eassert (current_buffer->overlays_after == NULL);
635 current_buffer->enable_multibyte_characters
636 = buffer_defaults.enable_multibyte_characters;
637 specbind (Qinhibit_read_only, Qt);
638 specbind (Qinhibit_modification_hooks, Qt);
639 Ferase_buffer ();
640 XSETBUFFER (buf, current_buffer);
642 Frun_hooks (1, &Qtemp_buffer_setup_hook);
644 unbind_to (count, Qnil);
646 specbind (Qstandard_output, buf);
649 Lisp_Object
650 internal_with_output_to_temp_buffer (bufname, function, args)
651 const char *bufname;
652 Lisp_Object (*function) P_ ((Lisp_Object));
653 Lisp_Object args;
655 int count = SPECPDL_INDEX ();
656 Lisp_Object buf, val;
657 struct gcpro gcpro1;
659 GCPRO1 (args);
660 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
661 temp_output_buffer_setup (bufname);
662 buf = Vstandard_output;
663 UNGCPRO;
665 val = (*function) (args);
667 GCPRO1 (val);
668 temp_output_buffer_show (buf);
669 UNGCPRO;
671 return unbind_to (count, val);
674 DEFUN ("with-output-to-temp-buffer",
675 Fwith_output_to_temp_buffer, Swith_output_to_temp_buffer,
676 1, UNEVALLED, 0,
677 doc: /* Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
679 This construct makes buffer BUFNAME empty before running BODY.
680 It does not make the buffer current for BODY.
681 Instead it binds `standard-output' to that buffer, so that output
682 generated with `prin1' and similar functions in BODY goes into
683 the buffer.
685 At the end of BODY, this marks buffer BUFNAME unmodifed and displays
686 it in a window, but does not select it. The normal way to do this is
687 by calling `display-buffer', then running `temp-buffer-show-hook'.
688 However, if `temp-buffer-show-function' is non-nil, it calls that
689 function instead (and does not run `temp-buffer-show-hook'). The
690 function gets one argument, the buffer to display.
692 The return value of `with-output-to-temp-buffer' is the value of the
693 last form in BODY. If BODY does not finish normally, the buffer
694 BUFNAME is not displayed.
696 This runs the hook `temp-buffer-setup-hook' before BODY,
697 with the buffer BUFNAME temporarily current. It runs the hook
698 `temp-buffer-show-hook' after displaying buffer BUFNAME, with that
699 buffer temporarily current, and the window that was used to display it
700 temporarily selected. But it doesn't run `temp-buffer-show-hook'
701 if it uses `temp-buffer-show-function'.
703 usage: (with-output-to-temp-buffer BUFNAME BODY...) */)
704 (args)
705 Lisp_Object args;
707 struct gcpro gcpro1;
708 Lisp_Object name;
709 int count = SPECPDL_INDEX ();
710 Lisp_Object buf, val;
712 GCPRO1(args);
713 name = Feval (Fcar (args));
714 CHECK_STRING (name);
715 temp_output_buffer_setup (SDATA (name));
716 buf = Vstandard_output;
717 UNGCPRO;
719 val = Fprogn (XCDR (args));
721 GCPRO1 (val);
722 temp_output_buffer_show (buf);
723 UNGCPRO;
725 return unbind_to (count, val);
729 static void print ();
730 static void print_preprocess ();
731 static void print_preprocess_string ();
732 static void print_object ();
734 DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
735 doc: /* Output a newline to stream PRINTCHARFUN.
736 If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used. */)
737 (printcharfun)
738 Lisp_Object printcharfun;
740 PRINTDECLARE;
742 if (NILP (printcharfun))
743 printcharfun = Vstandard_output;
744 PRINTPREPARE;
745 PRINTCHAR ('\n');
746 PRINTFINISH;
747 return Qt;
750 DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
751 doc: /* Output the printed representation of OBJECT, any Lisp object.
752 Quoting characters are printed when needed to make output that `read'
753 can handle, whenever this is possible. For complex objects, the behavior
754 is controlled by `print-level' and `print-length', which see.
756 OBJECT is any of the Lisp data types: a number, a string, a symbol,
757 a list, a buffer, a window, a frame, etc.
759 A printed representation of an object is text which describes that object.
761 Optional argument PRINTCHARFUN is the output stream, which can be one
762 of these:
764 - a buffer, in which case output is inserted into that buffer at point;
765 - a marker, in which case output is inserted at marker's position;
766 - a function, in which case that function is called once for each
767 character of OBJECT's printed representation;
768 - a symbol, in which case that symbol's function definition is called; or
769 - t, in which case the output is displayed in the echo area.
771 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
772 is used instead. */)
773 (object, printcharfun)
774 Lisp_Object object, printcharfun;
776 PRINTDECLARE;
778 #ifdef MAX_PRINT_CHARS
779 max_print = 0;
780 #endif /* MAX_PRINT_CHARS */
781 if (NILP (printcharfun))
782 printcharfun = Vstandard_output;
783 PRINTPREPARE;
784 print (object, printcharfun, 1);
785 PRINTFINISH;
786 return object;
789 /* a buffer which is used to hold output being built by prin1-to-string */
790 Lisp_Object Vprin1_to_string_buffer;
792 DEFUN ("prin1-to-string", Fprin1_to_string, Sprin1_to_string, 1, 2, 0,
793 doc: /* Return a string containing the printed representation of OBJECT.
794 OBJECT can be any Lisp object. This function outputs quoting characters
795 when necessary to make output that `read' can handle, whenever possible,
796 unless the optional second argument NOESCAPE is non-nil. For complex objects,
797 the behavior is controlled by `print-level' and `print-length', which see.
799 OBJECT is any of the Lisp data types: a number, a string, a symbol,
800 a list, a buffer, a window, a frame, etc.
802 A printed representation of an object is text which describes that object. */)
803 (object, noescape)
804 Lisp_Object object, noescape;
806 Lisp_Object printcharfun;
807 /* struct gcpro gcpro1, gcpro2; */
808 Lisp_Object save_deactivate_mark;
809 int count = SPECPDL_INDEX ();
810 struct buffer *previous;
812 specbind (Qinhibit_modification_hooks, Qt);
815 PRINTDECLARE;
817 /* Save and restore this--we are altering a buffer
818 but we don't want to deactivate the mark just for that.
819 No need for specbind, since errors deactivate the mark. */
820 save_deactivate_mark = Vdeactivate_mark;
821 /* GCPRO2 (object, save_deactivate_mark); */
822 abort_on_gc++;
824 printcharfun = Vprin1_to_string_buffer;
825 PRINTPREPARE;
826 print (object, printcharfun, NILP (noescape));
827 /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINSH */
828 PRINTFINISH;
831 previous = current_buffer;
832 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
833 object = Fbuffer_string ();
834 if (SBYTES (object) == SCHARS (object))
835 STRING_SET_UNIBYTE (object);
837 /* Note that this won't make prepare_to_modify_buffer call
838 ask-user-about-supersession-threat because this buffer
839 does not visit a file. */
840 Ferase_buffer ();
841 set_buffer_internal (previous);
843 Vdeactivate_mark = save_deactivate_mark;
844 /* UNGCPRO; */
846 abort_on_gc--;
847 return unbind_to (count, object);
850 DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
851 doc: /* Output the printed representation of OBJECT, any Lisp object.
852 No quoting characters are used; no delimiters are printed around
853 the contents of strings.
855 OBJECT is any of the Lisp data types: a number, a string, a symbol,
856 a list, a buffer, a window, a frame, etc.
858 A printed representation of an object is text which describes that object.
860 Optional argument PRINTCHARFUN is the output stream, which can be one
861 of these:
863 - a buffer, in which case output is inserted into that buffer at point;
864 - a marker, in which case output is inserted at marker's position;
865 - a function, in which case that function is called once for each
866 character of OBJECT's printed representation;
867 - a symbol, in which case that symbol's function definition is called; or
868 - t, in which case the output is displayed in the echo area.
870 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
871 is used instead. */)
872 (object, printcharfun)
873 Lisp_Object object, printcharfun;
875 PRINTDECLARE;
877 if (NILP (printcharfun))
878 printcharfun = Vstandard_output;
879 PRINTPREPARE;
880 print (object, printcharfun, 0);
881 PRINTFINISH;
882 return object;
885 DEFUN ("print", Fprint, Sprint, 1, 2, 0,
886 doc: /* Output the printed representation of OBJECT, with newlines around it.
887 Quoting characters are printed when needed to make output that `read'
888 can handle, whenever this is possible. For complex objects, the behavior
889 is controlled by `print-level' and `print-length', which see.
891 OBJECT is any of the Lisp data types: a number, a string, a symbol,
892 a list, a buffer, a window, a frame, etc.
894 A printed representation of an object is text which describes that object.
896 Optional argument PRINTCHARFUN is the output stream, which can be one
897 of these:
899 - a buffer, in which case output is inserted into that buffer at point;
900 - a marker, in which case output is inserted at marker's position;
901 - a function, in which case that function is called once for each
902 character of OBJECT's printed representation;
903 - a symbol, in which case that symbol's function definition is called; or
904 - t, in which case the output is displayed in the echo area.
906 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
907 is used instead. */)
908 (object, printcharfun)
909 Lisp_Object object, printcharfun;
911 PRINTDECLARE;
912 struct gcpro gcpro1;
914 #ifdef MAX_PRINT_CHARS
915 print_chars = 0;
916 max_print = MAX_PRINT_CHARS;
917 #endif /* MAX_PRINT_CHARS */
918 if (NILP (printcharfun))
919 printcharfun = Vstandard_output;
920 GCPRO1 (object);
921 PRINTPREPARE;
922 PRINTCHAR ('\n');
923 print (object, printcharfun, 1);
924 PRINTCHAR ('\n');
925 PRINTFINISH;
926 #ifdef MAX_PRINT_CHARS
927 max_print = 0;
928 print_chars = 0;
929 #endif /* MAX_PRINT_CHARS */
930 UNGCPRO;
931 return object;
934 /* The subroutine object for external-debugging-output is kept here
935 for the convenience of the debugger. */
936 Lisp_Object Qexternal_debugging_output;
938 DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
939 doc: /* Write CHARACTER to stderr.
940 You can call print while debugging emacs, and pass it this function
941 to make it write to the debugging output. */)
942 (character)
943 Lisp_Object character;
945 CHECK_NUMBER (character);
946 putc (XINT (character), stderr);
948 #ifdef WINDOWSNT
949 /* Send the output to a debugger (nothing happens if there isn't one). */
950 if (print_output_debug_flag)
952 char buf[2] = {(char) XINT (character), '\0'};
953 OutputDebugString (buf);
955 #endif
957 return character;
960 /* This function is never called. Its purpose is to prevent
961 print_output_debug_flag from being optimized away. */
963 void
964 debug_output_compilation_hack (x)
965 int x;
967 print_output_debug_flag = x;
970 #if defined (GNU_LINUX)
972 /* This functionality is not vitally important in general, so we rely on
973 non-portable ability to use stderr as lvalue. */
975 #define WITH_REDIRECT_DEBUGGING_OUTPUT 1
977 FILE *initial_stderr_stream = NULL;
979 DEFUN ("redirect-debugging-output", Fredirect_debugging_output, Sredirect_debugging_output,
980 1, 2,
981 "FDebug output file: \nP",
982 doc: /* Redirect debugging output (stderr stream) to file FILE.
983 If FILE is nil, reset target to the initial stderr stream.
984 Optional arg APPEND non-nil (interactively, with prefix arg) means
985 append to existing target file. */)
986 (file, append)
987 Lisp_Object file, append;
989 if (initial_stderr_stream != NULL)
991 BLOCK_INPUT;
992 fclose (stderr);
993 UNBLOCK_INPUT;
995 stderr = initial_stderr_stream;
996 initial_stderr_stream = NULL;
998 if (STRINGP (file))
1000 file = Fexpand_file_name (file, Qnil);
1001 initial_stderr_stream = stderr;
1002 stderr = fopen (SDATA (file), NILP (append) ? "w" : "a");
1003 if (stderr == NULL)
1005 stderr = initial_stderr_stream;
1006 initial_stderr_stream = NULL;
1007 report_file_error ("Cannot open debugging output stream",
1008 Fcons (file, Qnil));
1011 return Qnil;
1013 #endif /* GNU_LINUX */
1016 /* This is the interface for debugging printing. */
1018 void
1019 debug_print (arg)
1020 Lisp_Object arg;
1022 Fprin1 (arg, Qexternal_debugging_output);
1023 fprintf (stderr, "\r\n");
1026 void
1027 safe_debug_print (arg)
1028 Lisp_Object arg;
1030 int valid = valid_lisp_object_p (arg);
1032 if (valid > 0)
1033 debug_print (arg);
1034 else
1035 fprintf (stderr, "#<%s_LISP_OBJECT 0x%08lx>\r\n",
1036 !valid ? "INVALID" : "SOME",
1037 (unsigned long) XHASH (arg)
1042 DEFUN ("error-message-string", Ferror_message_string, Serror_message_string,
1043 1, 1, 0,
1044 doc: /* Convert an error value (ERROR-SYMBOL . DATA) to an error message.
1045 See Info anchor `(elisp)Definition of signal' for some details on how this
1046 error message is constructed. */)
1047 (obj)
1048 Lisp_Object obj;
1050 struct buffer *old = current_buffer;
1051 Lisp_Object value;
1052 struct gcpro gcpro1;
1054 /* If OBJ is (error STRING), just return STRING.
1055 That is not only faster, it also avoids the need to allocate
1056 space here when the error is due to memory full. */
1057 if (CONSP (obj) && EQ (XCAR (obj), Qerror)
1058 && CONSP (XCDR (obj))
1059 && STRINGP (XCAR (XCDR (obj)))
1060 && NILP (XCDR (XCDR (obj))))
1061 return XCAR (XCDR (obj));
1063 print_error_message (obj, Vprin1_to_string_buffer, 0, Qnil);
1065 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
1066 value = Fbuffer_string ();
1068 GCPRO1 (value);
1069 Ferase_buffer ();
1070 set_buffer_internal (old);
1071 UNGCPRO;
1073 return value;
1076 /* Print an error message for the error DATA onto Lisp output stream
1077 STREAM (suitable for the print functions).
1078 CONTEXT is a C string describing the context of the error.
1079 CALLER is the Lisp function inside which the error was signaled. */
1081 void
1082 print_error_message (data, stream, context, caller)
1083 Lisp_Object data, stream;
1084 char *context;
1085 Lisp_Object caller;
1087 Lisp_Object errname, errmsg, file_error, tail;
1088 struct gcpro gcpro1;
1089 int i;
1091 if (context != 0)
1092 write_string_1 (context, -1, stream);
1094 /* If we know from where the error was signaled, show it in
1095 *Messages*. */
1096 if (!NILP (caller) && SYMBOLP (caller))
1098 Lisp_Object cname = SYMBOL_NAME (caller);
1099 char *name = alloca (SBYTES (cname));
1100 bcopy (SDATA (cname), name, SBYTES (cname));
1101 message_dolog (name, SBYTES (cname), 0, 0);
1102 message_dolog (": ", 2, 0, 0);
1105 errname = Fcar (data);
1107 if (EQ (errname, Qerror))
1109 data = Fcdr (data);
1110 if (!CONSP (data))
1111 data = Qnil;
1112 errmsg = Fcar (data);
1113 file_error = Qnil;
1115 else
1117 Lisp_Object error_conditions;
1118 errmsg = Fget (errname, Qerror_message);
1119 error_conditions = Fget (errname, Qerror_conditions);
1120 file_error = Fmemq (Qfile_error, error_conditions);
1123 /* Print an error message including the data items. */
1125 tail = Fcdr_safe (data);
1126 GCPRO1 (tail);
1128 /* For file-error, make error message by concatenating
1129 all the data items. They are all strings. */
1130 if (!NILP (file_error) && CONSP (tail))
1131 errmsg = XCAR (tail), tail = XCDR (tail);
1133 if (STRINGP (errmsg))
1134 Fprinc (errmsg, stream);
1135 else
1136 write_string_1 ("peculiar error", -1, stream);
1138 for (i = 0; CONSP (tail); tail = XCDR (tail), i++)
1140 Lisp_Object obj;
1142 write_string_1 (i ? ", " : ": ", 2, stream);
1143 obj = XCAR (tail);
1144 if (!NILP (file_error) || EQ (errname, Qend_of_file))
1145 Fprinc (obj, stream);
1146 else
1147 Fprin1 (obj, stream);
1150 UNGCPRO;
1156 * The buffer should be at least as large as the max string size of the
1157 * largest float, printed in the biggest notation. This is undoubtedly
1158 * 20d float_output_format, with the negative of the C-constant "HUGE"
1159 * from <math.h>.
1161 * On the vax the worst case is -1e38 in 20d format which takes 61 bytes.
1163 * I assume that IEEE-754 format numbers can take 329 bytes for the worst
1164 * case of -1e307 in 20d float_output_format. What is one to do (short of
1165 * re-writing _doprnt to be more sane)?
1166 * -wsr
1169 void
1170 float_to_string (buf, data)
1171 unsigned char *buf;
1172 double data;
1174 unsigned char *cp;
1175 int width;
1177 /* Check for plus infinity in a way that won't lose
1178 if there is no plus infinity. */
1179 if (data == data / 2 && data > 1.0)
1181 strcpy (buf, "1.0e+INF");
1182 return;
1184 /* Likewise for minus infinity. */
1185 if (data == data / 2 && data < -1.0)
1187 strcpy (buf, "-1.0e+INF");
1188 return;
1190 /* Check for NaN in a way that won't fail if there are no NaNs. */
1191 if (! (data * 0.0 >= 0.0))
1193 /* Prepend "-" if the NaN's sign bit is negative.
1194 The sign bit of a double is the bit that is 1 in -0.0. */
1195 int i;
1196 union { double d; char c[sizeof (double)]; } u_data, u_minus_zero;
1197 u_data.d = data;
1198 u_minus_zero.d = - 0.0;
1199 for (i = 0; i < sizeof (double); i++)
1200 if (u_data.c[i] & u_minus_zero.c[i])
1202 *buf++ = '-';
1203 break;
1206 strcpy (buf, "0.0e+NaN");
1207 return;
1210 if (NILP (Vfloat_output_format)
1211 || !STRINGP (Vfloat_output_format))
1212 lose:
1214 /* Generate the fewest number of digits that represent the
1215 floating point value without losing information.
1216 The following method is simple but a bit slow.
1217 For ideas about speeding things up, please see:
1219 Guy L Steele Jr & Jon L White, How to print floating-point numbers
1220 accurately. SIGPLAN notices 25, 6 (June 1990), 112-126.
1222 Robert G Burger & R Kent Dybvig, Printing floating point numbers
1223 quickly and accurately, SIGPLAN notices 31, 5 (May 1996), 108-116. */
1225 width = fabs (data) < DBL_MIN ? 1 : DBL_DIG;
1227 sprintf (buf, "%.*g", width, data);
1228 while (width++ < DOUBLE_DIGITS_BOUND && atof (buf) != data);
1230 else /* oink oink */
1232 /* Check that the spec we have is fully valid.
1233 This means not only valid for printf,
1234 but meant for floats, and reasonable. */
1235 cp = SDATA (Vfloat_output_format);
1237 if (cp[0] != '%')
1238 goto lose;
1239 if (cp[1] != '.')
1240 goto lose;
1242 cp += 2;
1244 /* Check the width specification. */
1245 width = -1;
1246 if ('0' <= *cp && *cp <= '9')
1248 width = 0;
1250 width = (width * 10) + (*cp++ - '0');
1251 while (*cp >= '0' && *cp <= '9');
1253 /* A precision of zero is valid only for %f. */
1254 if (width > DBL_DIG
1255 || (width == 0 && *cp != 'f'))
1256 goto lose;
1259 if (*cp != 'e' && *cp != 'f' && *cp != 'g')
1260 goto lose;
1262 if (cp[1] != 0)
1263 goto lose;
1265 sprintf (buf, SDATA (Vfloat_output_format), data);
1268 /* Make sure there is a decimal point with digit after, or an
1269 exponent, so that the value is readable as a float. But don't do
1270 this with "%.0f"; it's valid for that not to produce a decimal
1271 point. Note that width can be 0 only for %.0f. */
1272 if (width != 0)
1274 for (cp = buf; *cp; cp++)
1275 if ((*cp < '0' || *cp > '9') && *cp != '-')
1276 break;
1278 if (*cp == '.' && cp[1] == 0)
1280 cp[1] = '0';
1281 cp[2] = 0;
1284 if (*cp == 0)
1286 *cp++ = '.';
1287 *cp++ = '0';
1288 *cp++ = 0;
1294 static void
1295 print (obj, printcharfun, escapeflag)
1296 Lisp_Object obj;
1297 register Lisp_Object printcharfun;
1298 int escapeflag;
1300 new_backquote_output = 0;
1302 /* Reset print_number_index and Vprint_number_table only when
1303 the variable Vprint_continuous_numbering is nil. Otherwise,
1304 the values of these variables will be kept between several
1305 print functions. */
1306 if (NILP (Vprint_continuous_numbering)
1307 || NILP (Vprint_number_table))
1309 print_number_index = 0;
1310 Vprint_number_table = Qnil;
1313 /* Construct Vprint_number_table for print-gensym and print-circle. */
1314 if (!NILP (Vprint_gensym) || !NILP (Vprint_circle))
1316 int i, start, index;
1317 start = index = print_number_index;
1318 /* Construct Vprint_number_table.
1319 This increments print_number_index for the objects added. */
1320 print_depth = 0;
1321 print_preprocess (obj);
1323 /* Remove unnecessary objects, which appear only once in OBJ;
1324 that is, whose status is Qnil. Compactify the necessary objects. */
1325 for (i = start; i < print_number_index; i++)
1326 if (!NILP (PRINT_NUMBER_STATUS (Vprint_number_table, i)))
1328 PRINT_NUMBER_OBJECT (Vprint_number_table, index)
1329 = PRINT_NUMBER_OBJECT (Vprint_number_table, i);
1330 index++;
1333 /* Clear out objects outside the active part of the table. */
1334 for (i = index; i < print_number_index; i++)
1335 PRINT_NUMBER_OBJECT (Vprint_number_table, i) = Qnil;
1337 /* Reset the status field for the next print step. Now this
1338 field means whether the object has already been printed. */
1339 for (i = start; i < print_number_index; i++)
1340 PRINT_NUMBER_STATUS (Vprint_number_table, i) = Qnil;
1342 print_number_index = index;
1345 print_depth = 0;
1346 print_object (obj, printcharfun, escapeflag);
1349 /* Construct Vprint_number_table according to the structure of OBJ.
1350 OBJ itself and all its elements will be added to Vprint_number_table
1351 recursively if it is a list, vector, compiled function, char-table,
1352 string (its text properties will be traced), or a symbol that has
1353 no obarray (this is for the print-gensym feature).
1354 The status fields of Vprint_number_table mean whether each object appears
1355 more than once in OBJ: Qnil at the first time, and Qt after that . */
1356 static void
1357 print_preprocess (obj)
1358 Lisp_Object obj;
1360 int i;
1361 EMACS_INT size;
1362 int loop_count = 0;
1363 Lisp_Object halftail;
1365 /* Give up if we go so deep that print_object will get an error. */
1366 /* See similar code in print_object. */
1367 if (print_depth >= PRINT_CIRCLE)
1368 error ("Apparently circular structure being printed");
1370 /* Avoid infinite recursion for circular nested structure
1371 in the case where Vprint_circle is nil. */
1372 if (NILP (Vprint_circle))
1374 for (i = 0; i < print_depth; i++)
1375 if (EQ (obj, being_printed[i]))
1376 return;
1377 being_printed[print_depth] = obj;
1380 print_depth++;
1381 halftail = obj;
1383 loop:
1384 if (STRINGP (obj) || CONSP (obj) || VECTORP (obj)
1385 || COMPILEDP (obj) || CHAR_TABLE_P (obj)
1386 || (! NILP (Vprint_gensym)
1387 && SYMBOLP (obj)
1388 && !SYMBOL_INTERNED_P (obj)))
1390 /* In case print-circle is nil and print-gensym is t,
1391 add OBJ to Vprint_number_table only when OBJ is a symbol. */
1392 if (! NILP (Vprint_circle) || SYMBOLP (obj))
1394 for (i = 0; i < print_number_index; i++)
1395 if (EQ (PRINT_NUMBER_OBJECT (Vprint_number_table, i), obj))
1397 /* OBJ appears more than once. Let's remember that. */
1398 PRINT_NUMBER_STATUS (Vprint_number_table, i) = Qt;
1399 print_depth--;
1400 return;
1403 /* OBJ is not yet recorded. Let's add to the table. */
1404 if (print_number_index == 0)
1406 /* Initialize the table. */
1407 Vprint_number_table = Fmake_vector (make_number (40), Qnil);
1409 else if (XVECTOR (Vprint_number_table)->size == print_number_index * 2)
1411 /* Reallocate the table. */
1412 int i = print_number_index * 4;
1413 Lisp_Object old_table = Vprint_number_table;
1414 Vprint_number_table = Fmake_vector (make_number (i), Qnil);
1415 for (i = 0; i < print_number_index; i++)
1417 PRINT_NUMBER_OBJECT (Vprint_number_table, i)
1418 = PRINT_NUMBER_OBJECT (old_table, i);
1419 PRINT_NUMBER_STATUS (Vprint_number_table, i)
1420 = PRINT_NUMBER_STATUS (old_table, i);
1423 PRINT_NUMBER_OBJECT (Vprint_number_table, print_number_index) = obj;
1424 /* If Vprint_continuous_numbering is non-nil and OBJ is a gensym,
1425 always print the gensym with a number. This is a special for
1426 the lisp function byte-compile-output-docform. */
1427 if (!NILP (Vprint_continuous_numbering)
1428 && SYMBOLP (obj)
1429 && !SYMBOL_INTERNED_P (obj))
1430 PRINT_NUMBER_STATUS (Vprint_number_table, print_number_index) = Qt;
1431 print_number_index++;
1434 switch (XTYPE (obj))
1436 case Lisp_String:
1437 /* A string may have text properties, which can be circular. */
1438 traverse_intervals_noorder (STRING_INTERVALS (obj),
1439 print_preprocess_string, Qnil);
1440 break;
1442 case Lisp_Cons:
1443 /* Use HALFTAIL and LOOP_COUNT to detect circular lists,
1444 just as in print_object. */
1445 if (loop_count && EQ (obj, halftail))
1446 break;
1447 print_preprocess (XCAR (obj));
1448 obj = XCDR (obj);
1449 loop_count++;
1450 if (!(loop_count & 1))
1451 halftail = XCDR (halftail);
1452 goto loop;
1454 case Lisp_Vectorlike:
1455 size = XVECTOR (obj)->size;
1456 if (size & PSEUDOVECTOR_FLAG)
1457 size &= PSEUDOVECTOR_SIZE_MASK;
1458 for (i = 0; i < size; i++)
1459 print_preprocess (XVECTOR (obj)->contents[i]);
1460 break;
1462 default:
1463 break;
1466 print_depth--;
1469 static void
1470 print_preprocess_string (interval, arg)
1471 INTERVAL interval;
1472 Lisp_Object arg;
1474 print_preprocess (interval->plist);
1477 /* A flag to control printing of `charset' text property.
1478 The default value is Qdefault. */
1479 Lisp_Object Vprint_charset_text_property;
1480 extern Lisp_Object Qdefault;
1482 static void print_check_string_charset_prop ();
1484 #define PRINT_STRING_NON_CHARSET_FOUND 1
1485 #define PRINT_STRING_UNSAFE_CHARSET_FOUND 2
1487 /* Bitwize or of the abobe macros. */
1488 static int print_check_string_result;
1490 static void
1491 print_check_string_charset_prop (interval, string)
1492 INTERVAL interval;
1493 Lisp_Object string;
1495 Lisp_Object val;
1497 if (NILP (interval->plist)
1498 || (print_check_string_result == (PRINT_STRING_NON_CHARSET_FOUND
1499 | PRINT_STRING_UNSAFE_CHARSET_FOUND)))
1500 return;
1501 for (val = interval->plist; CONSP (val) && ! EQ (XCAR (val), Qcharset);
1502 val = XCDR (XCDR (val)));
1503 if (! CONSP (val))
1505 print_check_string_result |= PRINT_STRING_NON_CHARSET_FOUND;
1506 return;
1508 if (! (print_check_string_result & PRINT_STRING_NON_CHARSET_FOUND))
1510 if (! EQ (val, interval->plist)
1511 || CONSP (XCDR (XCDR (val))))
1512 print_check_string_result |= PRINT_STRING_NON_CHARSET_FOUND;
1514 if (NILP (Vprint_charset_text_property)
1515 || ! (print_check_string_result & PRINT_STRING_UNSAFE_CHARSET_FOUND))
1517 int i, c;
1518 int charpos = interval->position;
1519 int bytepos = string_char_to_byte (string, charpos);
1520 Lisp_Object charset;
1522 charset = XCAR (XCDR (val));
1523 for (i = 0; i < LENGTH (interval); i++)
1525 FETCH_STRING_CHAR_ADVANCE (c, string, charpos, bytepos);
1526 if (! ASCII_CHAR_P (c)
1527 && ! EQ (CHARSET_NAME (CHAR_CHARSET (c)), charset))
1529 print_check_string_result |= PRINT_STRING_UNSAFE_CHARSET_FOUND;
1530 break;
1536 /* The value is (charset . nil). */
1537 static Lisp_Object print_prune_charset_plist;
1539 static Lisp_Object
1540 print_prune_string_charset (string)
1541 Lisp_Object string;
1543 print_check_string_result = 0;
1544 traverse_intervals (STRING_INTERVALS (string), 0,
1545 print_check_string_charset_prop, string);
1546 if (! (print_check_string_result & PRINT_STRING_UNSAFE_CHARSET_FOUND))
1548 string = Fcopy_sequence (string);
1549 if (print_check_string_result & PRINT_STRING_NON_CHARSET_FOUND)
1551 if (NILP (print_prune_charset_plist))
1552 print_prune_charset_plist = Fcons (Qcharset, Qnil);
1553 Fremove_text_properties (make_number (0),
1554 make_number (SCHARS (string)),
1555 print_prune_charset_plist, string);
1557 else
1558 Fset_text_properties (make_number (0), make_number (SCHARS (string)),
1559 Qnil, string);
1561 return string;
1564 static void
1565 print_object (obj, printcharfun, escapeflag)
1566 Lisp_Object obj;
1567 register Lisp_Object printcharfun;
1568 int escapeflag;
1570 char buf[40];
1572 QUIT;
1574 /* Detect circularities and truncate them. */
1575 if (STRINGP (obj) || CONSP (obj) || VECTORP (obj)
1576 || COMPILEDP (obj) || CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj)
1577 || (! NILP (Vprint_gensym)
1578 && SYMBOLP (obj)
1579 && !SYMBOL_INTERNED_P (obj)))
1581 if (NILP (Vprint_circle) && NILP (Vprint_gensym))
1583 /* Simple but incomplete way. */
1584 int i;
1585 for (i = 0; i < print_depth; i++)
1586 if (EQ (obj, being_printed[i]))
1588 sprintf (buf, "#%d", i);
1589 strout (buf, -1, -1, printcharfun, 0);
1590 return;
1592 being_printed[print_depth] = obj;
1594 else
1596 /* With the print-circle feature. */
1597 int i;
1598 for (i = 0; i < print_number_index; i++)
1599 if (EQ (PRINT_NUMBER_OBJECT (Vprint_number_table, i), obj))
1601 if (NILP (PRINT_NUMBER_STATUS (Vprint_number_table, i)))
1603 /* Add a prefix #n= if OBJ has not yet been printed;
1604 that is, its status field is nil. */
1605 sprintf (buf, "#%d=", i + 1);
1606 strout (buf, -1, -1, printcharfun, 0);
1607 /* OBJ is going to be printed. Set the status to t. */
1608 PRINT_NUMBER_STATUS (Vprint_number_table, i) = Qt;
1609 break;
1611 else
1613 /* Just print #n# if OBJ has already been printed. */
1614 sprintf (buf, "#%d#", i + 1);
1615 strout (buf, -1, -1, printcharfun, 0);
1616 return;
1622 print_depth++;
1624 /* See similar code in print_preprocess. */
1625 if (print_depth > PRINT_CIRCLE)
1626 error ("Apparently circular structure being printed");
1627 #ifdef MAX_PRINT_CHARS
1628 if (max_print && print_chars > max_print)
1630 PRINTCHAR ('\n');
1631 print_chars = 0;
1633 #endif /* MAX_PRINT_CHARS */
1635 switch (XTYPE (obj))
1637 case Lisp_Int:
1638 if (sizeof (int) == sizeof (EMACS_INT))
1639 sprintf (buf, "%d", (int) XINT (obj));
1640 else if (sizeof (long) == sizeof (EMACS_INT))
1641 sprintf (buf, "%ld", (long) XINT (obj));
1642 else
1643 abort ();
1644 strout (buf, -1, -1, printcharfun, 0);
1645 break;
1647 case Lisp_Float:
1649 char pigbuf[350]; /* see comments in float_to_string */
1651 float_to_string (pigbuf, XFLOAT_DATA (obj));
1652 strout (pigbuf, -1, -1, printcharfun, 0);
1654 break;
1656 case Lisp_String:
1657 if (!escapeflag)
1658 print_string (obj, printcharfun);
1659 else
1661 register int i, i_byte;
1662 struct gcpro gcpro1;
1663 unsigned char *str;
1664 int size_byte;
1665 /* 1 means we must ensure that the next character we output
1666 cannot be taken as part of a hex character escape. */
1667 int need_nonhex = 0;
1668 int multibyte = STRING_MULTIBYTE (obj);
1670 GCPRO1 (obj);
1672 if (! EQ (Vprint_charset_text_property, Qt))
1673 obj = print_prune_string_charset (obj);
1675 if (!NULL_INTERVAL_P (STRING_INTERVALS (obj)))
1677 PRINTCHAR ('#');
1678 PRINTCHAR ('(');
1681 PRINTCHAR ('\"');
1682 str = SDATA (obj);
1683 size_byte = SBYTES (obj);
1685 for (i = 0, i_byte = 0; i_byte < size_byte;)
1687 /* Here, we must convert each multi-byte form to the
1688 corresponding character code before handing it to PRINTCHAR. */
1689 int len;
1690 int c;
1692 if (multibyte)
1694 c = STRING_CHAR_AND_LENGTH (str + i_byte,
1695 size_byte - i_byte, len);
1696 i_byte += len;
1698 else
1699 c = str[i_byte++];
1701 QUIT;
1703 if (c == '\n' && print_escape_newlines)
1705 PRINTCHAR ('\\');
1706 PRINTCHAR ('n');
1708 else if (c == '\f' && print_escape_newlines)
1710 PRINTCHAR ('\\');
1711 PRINTCHAR ('f');
1713 else if (multibyte
1714 && (CHAR_BYTE8_P (c)
1715 || (! ASCII_CHAR_P (c) && print_escape_multibyte)))
1717 /* When multibyte is disabled,
1718 print multibyte string chars using hex escapes.
1719 For a char code that could be in a unibyte string,
1720 when found in a multibyte string, always use a hex escape
1721 so it reads back as multibyte. */
1722 unsigned char outbuf[50];
1724 if (CHAR_BYTE8_P (c))
1725 sprintf (outbuf, "\\%03o", CHAR_TO_BYTE8 (c));
1726 else
1728 sprintf (outbuf, "\\x%04x", c);
1729 need_nonhex = 1;
1731 strout (outbuf, -1, -1, printcharfun, 0);
1733 else if (! multibyte
1734 && SINGLE_BYTE_CHAR_P (c) && ! ASCII_BYTE_P (c)
1735 && print_escape_nonascii)
1737 /* When printing in a multibyte buffer
1738 or when explicitly requested,
1739 print single-byte non-ASCII string chars
1740 using octal escapes. */
1741 unsigned char outbuf[5];
1742 sprintf (outbuf, "\\%03o", c);
1743 strout (outbuf, -1, -1, printcharfun, 0);
1745 else
1747 /* If we just had a hex escape, and this character
1748 could be taken as part of it,
1749 output `\ ' to prevent that. */
1750 if (need_nonhex)
1752 need_nonhex = 0;
1753 if ((c >= 'a' && c <= 'f')
1754 || (c >= 'A' && c <= 'F')
1755 || (c >= '0' && c <= '9'))
1756 strout ("\\ ", -1, -1, printcharfun, 0);
1759 if (c == '\"' || c == '\\')
1760 PRINTCHAR ('\\');
1761 PRINTCHAR (c);
1764 PRINTCHAR ('\"');
1766 if (!NULL_INTERVAL_P (STRING_INTERVALS (obj)))
1768 traverse_intervals (STRING_INTERVALS (obj),
1769 0, print_interval, printcharfun);
1770 PRINTCHAR (')');
1773 UNGCPRO;
1775 break;
1777 case Lisp_Symbol:
1779 register int confusing;
1780 register unsigned char *p = SDATA (SYMBOL_NAME (obj));
1781 register unsigned char *end = p + SBYTES (SYMBOL_NAME (obj));
1782 register int c;
1783 int i, i_byte, size_byte;
1784 Lisp_Object name;
1786 name = SYMBOL_NAME (obj);
1788 if (p != end && (*p == '-' || *p == '+')) p++;
1789 if (p == end)
1790 confusing = 0;
1791 /* If symbol name begins with a digit, and ends with a digit,
1792 and contains nothing but digits and `e', it could be treated
1793 as a number. So set CONFUSING.
1795 Symbols that contain periods could also be taken as numbers,
1796 but periods are always escaped, so we don't have to worry
1797 about them here. */
1798 else if (*p >= '0' && *p <= '9'
1799 && end[-1] >= '0' && end[-1] <= '9')
1801 while (p != end && ((*p >= '0' && *p <= '9')
1802 /* Needed for \2e10. */
1803 || *p == 'e'))
1804 p++;
1805 confusing = (end == p);
1807 else
1808 confusing = 0;
1810 if (! NILP (Vprint_gensym) && !SYMBOL_INTERNED_P (obj))
1812 PRINTCHAR ('#');
1813 PRINTCHAR (':');
1816 size_byte = SBYTES (name);
1818 for (i = 0, i_byte = 0; i_byte < size_byte;)
1820 /* Here, we must convert each multi-byte form to the
1821 corresponding character code before handing it to PRINTCHAR. */
1822 FETCH_STRING_CHAR_ADVANCE (c, name, i, i_byte);
1823 QUIT;
1825 if (escapeflag)
1827 if (c == '\"' || c == '\\' || c == '\''
1828 || c == ';' || c == '#' || c == '(' || c == ')'
1829 || c == ',' || c =='.' || c == '`'
1830 || c == '[' || c == ']' || c == '?' || c <= 040
1831 || confusing)
1832 PRINTCHAR ('\\'), confusing = 0;
1834 PRINTCHAR (c);
1837 break;
1839 case Lisp_Cons:
1840 /* If deeper than spec'd depth, print placeholder. */
1841 if (INTEGERP (Vprint_level)
1842 && print_depth > XINT (Vprint_level))
1843 strout ("...", -1, -1, printcharfun, 0);
1844 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1845 && (EQ (XCAR (obj), Qquote)))
1847 PRINTCHAR ('\'');
1848 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1850 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1851 && (EQ (XCAR (obj), Qfunction)))
1853 PRINTCHAR ('#');
1854 PRINTCHAR ('\'');
1855 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1857 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1858 && ((EQ (XCAR (obj), Qbackquote))))
1860 print_object (XCAR (obj), printcharfun, 0);
1861 new_backquote_output++;
1862 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1863 new_backquote_output--;
1865 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1866 && new_backquote_output
1867 && ((EQ (XCAR (obj), Qbackquote)
1868 || EQ (XCAR (obj), Qcomma)
1869 || EQ (XCAR (obj), Qcomma_at)
1870 || EQ (XCAR (obj), Qcomma_dot))))
1872 print_object (XCAR (obj), printcharfun, 0);
1873 new_backquote_output--;
1874 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1875 new_backquote_output++;
1877 else
1879 PRINTCHAR ('(');
1881 /* If the first element is a backquote form,
1882 print it old-style so it won't be misunderstood. */
1883 if (print_quoted && CONSP (XCAR (obj))
1884 && CONSP (XCDR (XCAR (obj)))
1885 && NILP (XCDR (XCDR (XCAR (obj))))
1886 && EQ (XCAR (XCAR (obj)), Qbackquote))
1888 Lisp_Object tem;
1889 tem = XCAR (obj);
1890 PRINTCHAR ('(');
1892 print_object (Qbackquote, printcharfun, 0);
1893 PRINTCHAR (' ');
1895 print_object (XCAR (XCDR (tem)), printcharfun, 0);
1896 PRINTCHAR (')');
1898 obj = XCDR (obj);
1902 int print_length, i;
1903 Lisp_Object halftail = obj;
1905 /* Negative values of print-length are invalid in CL.
1906 Treat them like nil, as CMUCL does. */
1907 if (NATNUMP (Vprint_length))
1908 print_length = XFASTINT (Vprint_length);
1909 else
1910 print_length = 0;
1912 i = 0;
1913 while (CONSP (obj))
1915 /* Detect circular list. */
1916 if (NILP (Vprint_circle))
1918 /* Simple but imcomplete way. */
1919 if (i != 0 && EQ (obj, halftail))
1921 sprintf (buf, " . #%d", i / 2);
1922 strout (buf, -1, -1, printcharfun, 0);
1923 goto end_of_list;
1926 else
1928 /* With the print-circle feature. */
1929 if (i != 0)
1931 int i;
1932 for (i = 0; i < print_number_index; i++)
1933 if (EQ (PRINT_NUMBER_OBJECT (Vprint_number_table, i),
1934 obj))
1936 if (NILP (PRINT_NUMBER_STATUS (Vprint_number_table, i)))
1938 strout (" . ", 3, 3, printcharfun, 0);
1939 print_object (obj, printcharfun, escapeflag);
1941 else
1943 sprintf (buf, " . #%d#", i + 1);
1944 strout (buf, -1, -1, printcharfun, 0);
1946 goto end_of_list;
1951 if (i++)
1952 PRINTCHAR (' ');
1954 if (print_length && i > print_length)
1956 strout ("...", 3, 3, printcharfun, 0);
1957 goto end_of_list;
1960 print_object (XCAR (obj), printcharfun, escapeflag);
1962 obj = XCDR (obj);
1963 if (!(i & 1))
1964 halftail = XCDR (halftail);
1968 /* OBJ non-nil here means it's the end of a dotted list. */
1969 if (!NILP (obj))
1971 strout (" . ", 3, 3, printcharfun, 0);
1972 print_object (obj, printcharfun, escapeflag);
1975 end_of_list:
1976 PRINTCHAR (')');
1978 break;
1980 case Lisp_Vectorlike:
1981 if (PROCESSP (obj))
1983 if (escapeflag)
1985 strout ("#<process ", -1, -1, printcharfun, 0);
1986 print_string (XPROCESS (obj)->name, printcharfun);
1987 PRINTCHAR ('>');
1989 else
1990 print_string (XPROCESS (obj)->name, printcharfun);
1992 else if (BOOL_VECTOR_P (obj))
1994 register int i;
1995 register unsigned char c;
1996 struct gcpro gcpro1;
1997 int size_in_chars
1998 = ((XBOOL_VECTOR (obj)->size + BOOL_VECTOR_BITS_PER_CHAR - 1)
1999 / BOOL_VECTOR_BITS_PER_CHAR);
2001 GCPRO1 (obj);
2003 PRINTCHAR ('#');
2004 PRINTCHAR ('&');
2005 sprintf (buf, "%ld", (long) XBOOL_VECTOR (obj)->size);
2006 strout (buf, -1, -1, printcharfun, 0);
2007 PRINTCHAR ('\"');
2009 /* Don't print more characters than the specified maximum.
2010 Negative values of print-length are invalid. Treat them
2011 like a print-length of nil. */
2012 if (NATNUMP (Vprint_length)
2013 && XFASTINT (Vprint_length) < size_in_chars)
2014 size_in_chars = XFASTINT (Vprint_length);
2016 for (i = 0; i < size_in_chars; i++)
2018 QUIT;
2019 c = XBOOL_VECTOR (obj)->data[i];
2020 if (! ASCII_BYTE_P (c))
2022 sprintf (buf, "\\%03o", c);
2023 strout (buf, -1, -1, printcharfun, 0);
2025 else if (c == '\n' && print_escape_newlines)
2027 PRINTCHAR ('\\');
2028 PRINTCHAR ('n');
2030 else if (c == '\f' && print_escape_newlines)
2032 PRINTCHAR ('\\');
2033 PRINTCHAR ('f');
2035 else if (c > '\177')
2037 /* Use octal escapes to avoid encoding issues. */
2038 PRINTCHAR ('\\');
2039 PRINTCHAR ('0' + ((c >> 6) & 3));
2040 PRINTCHAR ('0' + ((c >> 3) & 7));
2041 PRINTCHAR ('0' + (c & 7));
2043 else
2045 if (c == '\"' || c == '\\')
2046 PRINTCHAR ('\\');
2047 PRINTCHAR (c);
2050 PRINTCHAR ('\"');
2052 UNGCPRO;
2054 else if (SUBRP (obj))
2056 strout ("#<subr ", -1, -1, printcharfun, 0);
2057 strout (XSUBR (obj)->symbol_name, -1, -1, printcharfun, 0);
2058 PRINTCHAR ('>');
2060 else if (WINDOWP (obj))
2062 strout ("#<window ", -1, -1, printcharfun, 0);
2063 sprintf (buf, "%ld", (long) XFASTINT (XWINDOW (obj)->sequence_number));
2064 strout (buf, -1, -1, printcharfun, 0);
2065 if (!NILP (XWINDOW (obj)->buffer))
2067 strout (" on ", -1, -1, printcharfun, 0);
2068 print_string (XBUFFER (XWINDOW (obj)->buffer)->name, printcharfun);
2070 PRINTCHAR ('>');
2072 else if (TERMINALP (obj))
2074 struct terminal *t = XTERMINAL (obj);
2075 strout ("#<terminal ", -1, -1, printcharfun, 0);
2076 sprintf (buf, "%d", t->id);
2077 strout (buf, -1, -1, printcharfun, 0);
2078 if (t->name)
2080 strout (" on ", -1, -1, printcharfun, 0);
2081 strout (t->name, -1, -1, printcharfun, 0);
2083 PRINTCHAR ('>');
2085 else if (HASH_TABLE_P (obj))
2087 struct Lisp_Hash_Table *h = XHASH_TABLE (obj);
2088 strout ("#<hash-table", -1, -1, printcharfun, 0);
2089 if (SYMBOLP (h->test))
2091 PRINTCHAR (' ');
2092 PRINTCHAR ('\'');
2093 strout (SDATA (SYMBOL_NAME (h->test)), -1, -1, printcharfun, 0);
2094 PRINTCHAR (' ');
2095 strout (SDATA (SYMBOL_NAME (h->weak)), -1, -1, printcharfun, 0);
2096 PRINTCHAR (' ');
2097 sprintf (buf, "%ld/%ld", (long) h->count,
2098 (long) XVECTOR (h->next)->size);
2099 strout (buf, -1, -1, printcharfun, 0);
2101 sprintf (buf, " 0x%lx", (unsigned long) h);
2102 strout (buf, -1, -1, printcharfun, 0);
2103 PRINTCHAR ('>');
2105 else if (BUFFERP (obj))
2107 if (NILP (XBUFFER (obj)->name))
2108 strout ("#<killed buffer>", -1, -1, printcharfun, 0);
2109 else if (escapeflag)
2111 strout ("#<buffer ", -1, -1, printcharfun, 0);
2112 print_string (XBUFFER (obj)->name, printcharfun);
2113 PRINTCHAR ('>');
2115 else
2116 print_string (XBUFFER (obj)->name, printcharfun);
2118 else if (WINDOW_CONFIGURATIONP (obj))
2120 strout ("#<window-configuration>", -1, -1, printcharfun, 0);
2122 else if (FRAMEP (obj))
2124 strout ((FRAME_LIVE_P (XFRAME (obj))
2125 ? "#<frame " : "#<dead frame "),
2126 -1, -1, printcharfun, 0);
2127 print_string (XFRAME (obj)->name, printcharfun);
2128 sprintf (buf, " 0x%lx", (unsigned long) (XFRAME (obj)));
2129 strout (buf, -1, -1, printcharfun, 0);
2130 PRINTCHAR ('>');
2132 else
2134 EMACS_INT size = XVECTOR (obj)->size;
2135 if (COMPILEDP (obj))
2137 PRINTCHAR ('#');
2138 size &= PSEUDOVECTOR_SIZE_MASK;
2140 if (CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj))
2142 /* We print a char-table as if it were a vector,
2143 lumping the parent and default slots in with the
2144 character slots. But we add #^ as a prefix. */
2145 PRINTCHAR ('#');
2146 PRINTCHAR ('^');
2147 if (SUB_CHAR_TABLE_P (obj))
2148 PRINTCHAR ('^');
2149 size &= PSEUDOVECTOR_SIZE_MASK;
2151 if (size & PSEUDOVECTOR_FLAG)
2152 goto badtype;
2154 PRINTCHAR ('[');
2156 register int i;
2157 register Lisp_Object tem;
2158 int real_size = size;
2160 /* Don't print more elements than the specified maximum. */
2161 if (NATNUMP (Vprint_length)
2162 && XFASTINT (Vprint_length) < size)
2163 size = XFASTINT (Vprint_length);
2165 for (i = 0; i < size; i++)
2167 if (i) PRINTCHAR (' ');
2168 tem = XVECTOR (obj)->contents[i];
2169 print_object (tem, printcharfun, escapeflag);
2171 if (size < real_size)
2172 strout (" ...", 4, 4, printcharfun, 0);
2174 PRINTCHAR (']');
2176 break;
2178 case Lisp_Misc:
2179 switch (XMISCTYPE (obj))
2181 case Lisp_Misc_Marker:
2182 strout ("#<marker ", -1, -1, printcharfun, 0);
2183 /* Do you think this is necessary? */
2184 if (XMARKER (obj)->insertion_type != 0)
2185 strout ("(moves after insertion) ", -1, -1, printcharfun, 0);
2186 if (! XMARKER (obj)->buffer)
2187 strout ("in no buffer", -1, -1, printcharfun, 0);
2188 else
2190 sprintf (buf, "at %d", marker_position (obj));
2191 strout (buf, -1, -1, printcharfun, 0);
2192 strout (" in ", -1, -1, printcharfun, 0);
2193 print_string (XMARKER (obj)->buffer->name, printcharfun);
2195 PRINTCHAR ('>');
2196 break;
2198 case Lisp_Misc_Overlay:
2199 strout ("#<overlay ", -1, -1, printcharfun, 0);
2200 if (! XMARKER (OVERLAY_START (obj))->buffer)
2201 strout ("in no buffer", -1, -1, printcharfun, 0);
2202 else
2204 sprintf (buf, "from %d to %d in ",
2205 marker_position (OVERLAY_START (obj)),
2206 marker_position (OVERLAY_END (obj)));
2207 strout (buf, -1, -1, printcharfun, 0);
2208 print_string (XMARKER (OVERLAY_START (obj))->buffer->name,
2209 printcharfun);
2211 PRINTCHAR ('>');
2212 break;
2214 /* Remaining cases shouldn't happen in normal usage, but let's print
2215 them anyway for the benefit of the debugger. */
2216 case Lisp_Misc_Free:
2217 strout ("#<misc free cell>", -1, -1, printcharfun, 0);
2218 break;
2220 case Lisp_Misc_Intfwd:
2221 sprintf (buf, "#<intfwd to %ld>", (long) *XINTFWD (obj)->intvar);
2222 strout (buf, -1, -1, printcharfun, 0);
2223 break;
2225 case Lisp_Misc_Boolfwd:
2226 sprintf (buf, "#<boolfwd to %s>",
2227 (*XBOOLFWD (obj)->boolvar ? "t" : "nil"));
2228 strout (buf, -1, -1, printcharfun, 0);
2229 break;
2231 case Lisp_Misc_Objfwd:
2232 strout ("#<objfwd to ", -1, -1, printcharfun, 0);
2233 print_object (*XOBJFWD (obj)->objvar, printcharfun, escapeflag);
2234 PRINTCHAR ('>');
2235 break;
2237 case Lisp_Misc_Buffer_Objfwd:
2238 strout ("#<buffer_objfwd to ", -1, -1, printcharfun, 0);
2239 print_object (PER_BUFFER_VALUE (current_buffer,
2240 XBUFFER_OBJFWD (obj)->offset),
2241 printcharfun, escapeflag);
2242 PRINTCHAR ('>');
2243 break;
2245 case Lisp_Misc_Kboard_Objfwd:
2246 strout ("#<kboard_objfwd to ", -1, -1, printcharfun, 0);
2247 print_object (*(Lisp_Object *) ((char *) current_kboard
2248 + XKBOARD_OBJFWD (obj)->offset),
2249 printcharfun, escapeflag);
2250 PRINTCHAR ('>');
2251 break;
2253 case Lisp_Misc_Buffer_Local_Value:
2254 strout ("#<buffer_local_value ", -1, -1, printcharfun, 0);
2255 if (XBUFFER_LOCAL_VALUE (obj)->local_if_set)
2256 strout ("[local-if-set] ", -1, -1, printcharfun, 0);
2257 strout ("[realvalue] ", -1, -1, printcharfun, 0);
2258 print_object (XBUFFER_LOCAL_VALUE (obj)->realvalue,
2259 printcharfun, escapeflag);
2260 if (XBUFFER_LOCAL_VALUE (obj)->found_for_buffer)
2261 strout ("[local in buffer] ", -1, -1, printcharfun, 0);
2262 else
2263 strout ("[buffer] ", -1, -1, printcharfun, 0);
2264 print_object (XBUFFER_LOCAL_VALUE (obj)->buffer,
2265 printcharfun, escapeflag);
2266 if (XBUFFER_LOCAL_VALUE (obj)->check_frame)
2268 if (XBUFFER_LOCAL_VALUE (obj)->found_for_frame)
2269 strout ("[local in frame] ", -1, -1, printcharfun, 0);
2270 else
2271 strout ("[frame] ", -1, -1, printcharfun, 0);
2272 print_object (XBUFFER_LOCAL_VALUE (obj)->frame,
2273 printcharfun, escapeflag);
2275 strout ("[alist-elt] ", -1, -1, printcharfun, 0);
2276 print_object (XCAR (XBUFFER_LOCAL_VALUE (obj)->cdr),
2277 printcharfun, escapeflag);
2278 strout ("[default-value] ", -1, -1, printcharfun, 0);
2279 print_object (XCDR (XBUFFER_LOCAL_VALUE (obj)->cdr),
2280 printcharfun, escapeflag);
2281 PRINTCHAR ('>');
2282 break;
2284 case Lisp_Misc_Save_Value:
2285 strout ("#<save_value ", -1, -1, printcharfun, 0);
2286 sprintf(buf, "ptr=0x%08lx int=%d",
2287 (unsigned long) XSAVE_VALUE (obj)->pointer,
2288 XSAVE_VALUE (obj)->integer);
2289 strout (buf, -1, -1, printcharfun, 0);
2290 PRINTCHAR ('>');
2291 break;
2293 default:
2294 goto badtype;
2296 break;
2298 default:
2299 badtype:
2301 /* We're in trouble if this happens!
2302 Probably should just abort () */
2303 strout ("#<EMACS BUG: INVALID DATATYPE ", -1, -1, printcharfun, 0);
2304 if (MISCP (obj))
2305 sprintf (buf, "(MISC 0x%04x)", (int) XMISCTYPE (obj));
2306 else if (VECTORLIKEP (obj))
2307 sprintf (buf, "(PVEC 0x%08x)", (int) XVECTOR (obj)->size);
2308 else
2309 sprintf (buf, "(0x%02x)", (int) XTYPE (obj));
2310 strout (buf, -1, -1, printcharfun, 0);
2311 strout (" Save your buffers immediately and please report this bug>",
2312 -1, -1, printcharfun, 0);
2316 print_depth--;
2320 /* Print a description of INTERVAL using PRINTCHARFUN.
2321 This is part of printing a string that has text properties. */
2323 void
2324 print_interval (interval, printcharfun)
2325 INTERVAL interval;
2326 Lisp_Object printcharfun;
2328 if (NILP (interval->plist))
2329 return;
2330 PRINTCHAR (' ');
2331 print_object (make_number (interval->position), printcharfun, 1);
2332 PRINTCHAR (' ');
2333 print_object (make_number (interval->position + LENGTH (interval)),
2334 printcharfun, 1);
2335 PRINTCHAR (' ');
2336 print_object (interval->plist, printcharfun, 1);
2340 void
2341 syms_of_print ()
2343 Qtemp_buffer_setup_hook = intern ("temp-buffer-setup-hook");
2344 staticpro (&Qtemp_buffer_setup_hook);
2346 DEFVAR_LISP ("standard-output", &Vstandard_output,
2347 doc: /* Output stream `print' uses by default for outputting a character.
2348 This may be any function of one argument.
2349 It may also be a buffer (output is inserted before point)
2350 or a marker (output is inserted and the marker is advanced)
2351 or the symbol t (output appears in the echo area). */);
2352 Vstandard_output = Qt;
2353 Qstandard_output = intern ("standard-output");
2354 staticpro (&Qstandard_output);
2356 DEFVAR_LISP ("float-output-format", &Vfloat_output_format,
2357 doc: /* The format descriptor string used to print floats.
2358 This is a %-spec like those accepted by `printf' in C,
2359 but with some restrictions. It must start with the two characters `%.'.
2360 After that comes an integer precision specification,
2361 and then a letter which controls the format.
2362 The letters allowed are `e', `f' and `g'.
2363 Use `e' for exponential notation \"DIG.DIGITSeEXPT\"
2364 Use `f' for decimal point notation \"DIGITS.DIGITS\".
2365 Use `g' to choose the shorter of those two formats for the number at hand.
2366 The precision in any of these cases is the number of digits following
2367 the decimal point. With `f', a precision of 0 means to omit the
2368 decimal point. 0 is not allowed with `e' or `g'.
2370 A value of nil means to use the shortest notation
2371 that represents the number without losing information. */);
2372 Vfloat_output_format = Qnil;
2373 Qfloat_output_format = intern ("float-output-format");
2374 staticpro (&Qfloat_output_format);
2376 DEFVAR_LISP ("print-length", &Vprint_length,
2377 doc: /* Maximum length of list to print before abbreviating.
2378 A value of nil means no limit. See also `eval-expression-print-length'. */);
2379 Vprint_length = Qnil;
2381 DEFVAR_LISP ("print-level", &Vprint_level,
2382 doc: /* Maximum depth of list nesting to print before abbreviating.
2383 A value of nil means no limit. See also `eval-expression-print-level'. */);
2384 Vprint_level = Qnil;
2386 DEFVAR_BOOL ("print-escape-newlines", &print_escape_newlines,
2387 doc: /* Non-nil means print newlines in strings as `\\n'.
2388 Also print formfeeds as `\\f'. */);
2389 print_escape_newlines = 0;
2391 DEFVAR_BOOL ("print-escape-nonascii", &print_escape_nonascii,
2392 doc: /* Non-nil means print unibyte non-ASCII chars in strings as \\OOO.
2393 \(OOO is the octal representation of the character code.)
2394 Only single-byte characters are affected, and only in `prin1'.
2395 When the output goes in a multibyte buffer, this feature is
2396 enabled regardless of the value of the variable. */);
2397 print_escape_nonascii = 0;
2399 DEFVAR_BOOL ("print-escape-multibyte", &print_escape_multibyte,
2400 doc: /* Non-nil means print multibyte characters in strings as \\xXXXX.
2401 \(XXXX is the hex representation of the character code.)
2402 This affects only `prin1'. */);
2403 print_escape_multibyte = 0;
2405 DEFVAR_BOOL ("print-quoted", &print_quoted,
2406 doc: /* Non-nil means print quoted forms with reader syntax.
2407 I.e., (quote foo) prints as 'foo, (function foo) as #'foo, and backquoted
2408 forms print as in the new syntax. */);
2409 print_quoted = 0;
2411 DEFVAR_LISP ("print-gensym", &Vprint_gensym,
2412 doc: /* Non-nil means print uninterned symbols so they will read as uninterned.
2413 I.e., the value of (make-symbol \"foobar\") prints as #:foobar.
2414 When the uninterned symbol appears within a recursive data structure,
2415 and the symbol appears more than once, in addition use the #N# and #N=
2416 constructs as needed, so that multiple references to the same symbol are
2417 shared once again when the text is read back. */);
2418 Vprint_gensym = Qnil;
2420 DEFVAR_LISP ("print-circle", &Vprint_circle,
2421 doc: /* *Non-nil means print recursive structures using #N= and #N# syntax.
2422 If nil, printing proceeds recursively and may lead to
2423 `max-lisp-eval-depth' being exceeded or an error may occur:
2424 \"Apparently circular structure being printed.\" Also see
2425 `print-length' and `print-level'.
2426 If non-nil, shared substructures anywhere in the structure are printed
2427 with `#N=' before the first occurrence (in the order of the print
2428 representation) and `#N#' in place of each subsequent occurrence,
2429 where N is a positive decimal integer. */);
2430 Vprint_circle = Qnil;
2432 DEFVAR_LISP ("print-continuous-numbering", &Vprint_continuous_numbering,
2433 doc: /* *Non-nil means number continuously across print calls.
2434 This affects the numbers printed for #N= labels and #M# references.
2435 See also `print-circle', `print-gensym', and `print-number-table'.
2436 This variable should not be set with `setq'; bind it with a `let' instead. */);
2437 Vprint_continuous_numbering = Qnil;
2439 DEFVAR_LISP ("print-number-table", &Vprint_number_table,
2440 doc: /* A vector used internally to produce `#N=' labels and `#N#' references.
2441 The Lisp printer uses this vector to detect Lisp objects referenced more
2442 than once.
2444 When you bind `print-continuous-numbering' to t, you should probably
2445 also bind `print-number-table' to nil. This ensures that the value of
2446 `print-number-table' can be garbage-collected once the printing is
2447 done. If all elements of `print-number-table' are nil, it means that
2448 the printing done so far has not found any shared structure or objects
2449 that need to be recorded in the table. */);
2450 Vprint_number_table = Qnil;
2452 DEFVAR_LISP ("print-charset-text-property", &Vprint_charset_text_property,
2453 doc: /* A flag to control printing of `charset' text property on printing a string.
2454 The value must be nil, t, or `default'.
2456 If the value is nil, don't print the text property `charset'.
2458 If the value is t, always print the text property `charset'.
2460 If the value is `default', print the text property `charset' only when
2461 the value is different from what is guessed in the current charset
2462 priorities. */);
2463 Vprint_charset_text_property = Qdefault;
2465 /* prin1_to_string_buffer initialized in init_buffer_once in buffer.c */
2466 staticpro (&Vprin1_to_string_buffer);
2468 defsubr (&Sprin1);
2469 defsubr (&Sprin1_to_string);
2470 defsubr (&Serror_message_string);
2471 defsubr (&Sprinc);
2472 defsubr (&Sprint);
2473 defsubr (&Sterpri);
2474 defsubr (&Swrite_char);
2475 defsubr (&Sexternal_debugging_output);
2476 #ifdef WITH_REDIRECT_DEBUGGING_OUTPUT
2477 defsubr (&Sredirect_debugging_output);
2478 #endif
2480 Qexternal_debugging_output = intern ("external-debugging-output");
2481 staticpro (&Qexternal_debugging_output);
2483 Qprint_escape_newlines = intern ("print-escape-newlines");
2484 staticpro (&Qprint_escape_newlines);
2486 Qprint_escape_multibyte = intern ("print-escape-multibyte");
2487 staticpro (&Qprint_escape_multibyte);
2489 Qprint_escape_nonascii = intern ("print-escape-nonascii");
2490 staticpro (&Qprint_escape_nonascii);
2492 print_prune_charset_plist = Qnil;
2493 staticpro (&print_prune_charset_plist);
2495 defsubr (&Swith_output_to_temp_buffer);
2498 /* arch-tag: bc797170-94ae-41de-86e3-75e20f8f7a39
2499 (do not change this comment) */