(dabbrev--minibuffer-origin): Use minibuffer-selected-window.
[emacs.git] / src / print.c
bloba011cb885fac6f3487374a38df8766ee86c6133c
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 <setjmp.h>
25 #include "lisp.h"
26 #include "buffer.h"
27 #include "character.h"
28 #include "charset.h"
29 #include "keyboard.h"
30 #include "frame.h"
31 #include "window.h"
32 #include "process.h"
33 #include "dispextern.h"
34 #include "termchar.h"
35 #include "intervals.h"
36 #include "blockinput.h"
37 #include "termhooks.h" /* For struct terminal. */
38 #include "font.h"
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 #include <math.h>
51 #if STDC_HEADERS
52 #include <float.h>
53 #endif
55 /* Default to values appropriate for IEEE floating point. */
56 #ifndef FLT_RADIX
57 #define FLT_RADIX 2
58 #endif
59 #ifndef DBL_MANT_DIG
60 #define DBL_MANT_DIG 53
61 #endif
62 #ifndef DBL_DIG
63 #define DBL_DIG 15
64 #endif
65 #ifndef DBL_MIN
66 #define DBL_MIN 2.2250738585072014e-308
67 #endif
69 #ifdef DBL_MIN_REPLACEMENT
70 #undef DBL_MIN
71 #define DBL_MIN DBL_MIN_REPLACEMENT
72 #endif
74 /* Define DOUBLE_DIGITS_BOUND, an upper bound on the number of decimal digits
75 needed to express a float without losing information.
76 The general-case formula is valid for the usual case, IEEE floating point,
77 but many compilers can't optimize the formula to an integer constant,
78 so make a special case for it. */
79 #if FLT_RADIX == 2 && DBL_MANT_DIG == 53
80 #define DOUBLE_DIGITS_BOUND 17 /* IEEE floating point */
81 #else
82 #define DOUBLE_DIGITS_BOUND ((int) ceil (log10 (pow (FLT_RADIX, DBL_MANT_DIG))))
83 #endif
85 /* Avoid actual stack overflow in print. */
86 int print_depth;
88 /* Level of nesting inside outputting backquote in new style. */
89 int new_backquote_output;
91 /* Detect most circularities to print finite output. */
92 #define PRINT_CIRCLE 200
93 Lisp_Object being_printed[PRINT_CIRCLE];
95 /* When printing into a buffer, first we put the text in this
96 block, then insert it all at once. */
97 char *print_buffer;
99 /* Size allocated in print_buffer. */
100 int print_buffer_size;
101 /* Chars stored in print_buffer. */
102 int print_buffer_pos;
103 /* Bytes stored in print_buffer. */
104 int print_buffer_pos_byte;
106 /* Maximum length of list to print in full; noninteger means
107 effectively infinity */
109 Lisp_Object Vprint_length;
111 /* Maximum depth of list to print in full; noninteger means
112 effectively infinity. */
114 Lisp_Object Vprint_level;
116 /* Nonzero means print newlines in strings as \n. */
118 int print_escape_newlines;
120 /* Nonzero means to print single-byte non-ascii characters in strings as
121 octal escapes. */
123 int print_escape_nonascii;
125 /* Nonzero means to print multibyte characters in strings as hex escapes. */
127 int print_escape_multibyte;
129 Lisp_Object Qprint_escape_newlines;
130 Lisp_Object Qprint_escape_multibyte, Qprint_escape_nonascii;
132 /* Nonzero means print (quote foo) forms as 'foo, etc. */
134 int print_quoted;
136 /* Non-nil means print #: before uninterned symbols. */
138 Lisp_Object Vprint_gensym;
140 /* Non-nil means print recursive structures using #n= and #n# syntax. */
142 Lisp_Object Vprint_circle;
144 /* Non-nil means keep continuous number for #n= and #n# syntax
145 between several print functions. */
147 Lisp_Object Vprint_continuous_numbering;
149 /* Vprint_number_table is a vector like [OBJ1 STAT1 OBJ2 STAT2 ...],
150 where OBJn are objects going to be printed, and STATn are their status,
151 which may be different meanings during process. See the comments of
152 the functions print and print_preprocess for details.
153 print_number_index keeps the last position the next object should be added,
154 twice of which is the actual vector position in Vprint_number_table. */
155 int print_number_index;
156 Lisp_Object Vprint_number_table;
158 /* PRINT_NUMBER_OBJECT returns the I'th object in Vprint_number_table TABLE.
159 PRINT_NUMBER_STATUS returns the status of the I'th object in TABLE.
160 See the comment of the variable Vprint_number_table. */
161 #define PRINT_NUMBER_OBJECT(table,i) XVECTOR ((table))->contents[(i) * 2]
162 #define PRINT_NUMBER_STATUS(table,i) XVECTOR ((table))->contents[(i) * 2 + 1]
164 /* Nonzero means print newline to stdout before next minibuffer message.
165 Defined in xdisp.c */
167 extern int noninteractive_need_newline;
169 extern int minibuffer_auto_raise;
171 void print_interval ();
173 /* GDB resets this to zero on W32 to disable OutputDebugString calls. */
174 int print_output_debug_flag = 1;
177 /* Low level output routines for characters and strings */
179 /* Lisp functions to do output using a stream
180 must have the stream in a variable called printcharfun
181 and must start with PRINTPREPARE, end with PRINTFINISH,
182 and use PRINTDECLARE to declare common variables.
183 Use PRINTCHAR to output one character,
184 or call strout to output a block of characters. */
186 #define PRINTDECLARE \
187 struct buffer *old = current_buffer; \
188 int old_point = -1, start_point = -1; \
189 int old_point_byte = -1, start_point_byte = -1; \
190 int specpdl_count = SPECPDL_INDEX (); \
191 int free_print_buffer = 0; \
192 int multibyte = !NILP (current_buffer->enable_multibyte_characters); \
193 Lisp_Object original
195 #define PRINTPREPARE \
196 original = printcharfun; \
197 if (NILP (printcharfun)) printcharfun = Qt; \
198 if (BUFFERP (printcharfun)) \
200 if (XBUFFER (printcharfun) != current_buffer) \
201 Fset_buffer (printcharfun); \
202 printcharfun = Qnil; \
204 if (MARKERP (printcharfun)) \
206 EMACS_INT marker_pos; \
207 if (! XMARKER (printcharfun)->buffer) \
208 error ("Marker does not point anywhere"); \
209 if (XMARKER (printcharfun)->buffer != current_buffer) \
210 set_buffer_internal (XMARKER (printcharfun)->buffer); \
211 marker_pos = marker_position (printcharfun); \
212 if (marker_pos < BEGV || marker_pos > ZV) \
213 error ("Marker is outside the accessible part of the buffer"); \
214 old_point = PT; \
215 old_point_byte = PT_BYTE; \
216 SET_PT_BOTH (marker_pos, \
217 marker_byte_position (printcharfun)); \
218 start_point = PT; \
219 start_point_byte = PT_BYTE; \
220 printcharfun = Qnil; \
222 if (NILP (printcharfun)) \
224 Lisp_Object string; \
225 if (NILP (current_buffer->enable_multibyte_characters) \
226 && ! print_escape_multibyte) \
227 specbind (Qprint_escape_multibyte, Qt); \
228 if (! NILP (current_buffer->enable_multibyte_characters) \
229 && ! print_escape_nonascii) \
230 specbind (Qprint_escape_nonascii, Qt); \
231 if (print_buffer != 0) \
233 string = make_string_from_bytes (print_buffer, \
234 print_buffer_pos, \
235 print_buffer_pos_byte); \
236 record_unwind_protect (print_unwind, string); \
238 else \
240 print_buffer_size = 1000; \
241 print_buffer = (char *) xmalloc (print_buffer_size); \
242 free_print_buffer = 1; \
244 print_buffer_pos = 0; \
245 print_buffer_pos_byte = 0; \
247 if (EQ (printcharfun, Qt) && ! noninteractive) \
248 setup_echo_area_for_printing (multibyte);
250 #define PRINTFINISH \
251 if (NILP (printcharfun)) \
253 if (print_buffer_pos != print_buffer_pos_byte \
254 && NILP (current_buffer->enable_multibyte_characters)) \
256 unsigned char *temp \
257 = (unsigned char *) alloca (print_buffer_pos + 1); \
258 copy_text (print_buffer, temp, print_buffer_pos_byte, \
259 1, 0); \
260 insert_1_both (temp, print_buffer_pos, \
261 print_buffer_pos, 0, 1, 0); \
263 else \
264 insert_1_both (print_buffer, print_buffer_pos, \
265 print_buffer_pos_byte, 0, 1, 0); \
266 signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
268 if (free_print_buffer) \
270 xfree (print_buffer); \
271 print_buffer = 0; \
273 unbind_to (specpdl_count, Qnil); \
274 if (MARKERP (original)) \
275 set_marker_both (original, Qnil, PT, PT_BYTE); \
276 if (old_point >= 0) \
277 SET_PT_BOTH (old_point + (old_point >= start_point \
278 ? PT - start_point : 0), \
279 old_point_byte + (old_point_byte >= start_point_byte \
280 ? PT_BYTE - start_point_byte : 0)); \
281 if (old != current_buffer) \
282 set_buffer_internal (old);
284 #define PRINTCHAR(ch) printchar (ch, printcharfun)
286 /* This is used to restore the saved contents of print_buffer
287 when there is a recursive call to print. */
289 static Lisp_Object
290 print_unwind (saved_text)
291 Lisp_Object saved_text;
293 bcopy (SDATA (saved_text), print_buffer, SCHARS (saved_text));
294 return Qnil;
298 /* Print character CH using method FUN. FUN nil means print to
299 print_buffer. FUN t means print to echo area or stdout if
300 non-interactive. If FUN is neither nil nor t, call FUN with CH as
301 argument. */
303 static void
304 printchar (ch, fun)
305 unsigned int ch;
306 Lisp_Object fun;
308 if (!NILP (fun) && !EQ (fun, Qt))
309 call1 (fun, make_number (ch));
310 else
312 unsigned char str[MAX_MULTIBYTE_LENGTH];
313 int len = CHAR_STRING (ch, str);
315 QUIT;
317 if (NILP (fun))
319 if (print_buffer_pos_byte + len >= print_buffer_size)
320 print_buffer = (char *) xrealloc (print_buffer,
321 print_buffer_size *= 2);
322 bcopy (str, print_buffer + print_buffer_pos_byte, len);
323 print_buffer_pos += 1;
324 print_buffer_pos_byte += len;
326 else if (noninteractive)
328 fwrite (str, 1, len, stdout);
329 noninteractive_need_newline = 1;
331 else
333 int multibyte_p
334 = !NILP (current_buffer->enable_multibyte_characters);
336 setup_echo_area_for_printing (multibyte_p);
337 insert_char (ch);
338 message_dolog (str, len, 0, multibyte_p);
344 /* Output SIZE characters, SIZE_BYTE bytes from string PTR using
345 method PRINTCHARFUN. If SIZE < 0, use the string length of PTR for
346 both SIZE and SIZE_BYTE. PRINTCHARFUN nil means output to
347 print_buffer. PRINTCHARFUN t means output to the echo area or to
348 stdout if non-interactive. If neither nil nor t, call Lisp
349 function PRINTCHARFUN for each character printed. MULTIBYTE
350 non-zero means PTR contains multibyte characters.
352 In the case where PRINTCHARFUN is nil, it is safe for PTR to point
353 to data in a Lisp string. Otherwise that is not safe. */
355 static void
356 strout (ptr, size, size_byte, printcharfun, multibyte)
357 char *ptr;
358 int size, size_byte;
359 Lisp_Object printcharfun;
360 int multibyte;
362 if (size < 0)
363 size_byte = size = strlen (ptr);
365 if (NILP (printcharfun))
367 if (print_buffer_pos_byte + size_byte > print_buffer_size)
369 print_buffer_size = print_buffer_size * 2 + size_byte;
370 print_buffer = (char *) xrealloc (print_buffer,
371 print_buffer_size);
373 bcopy (ptr, print_buffer + print_buffer_pos_byte, size_byte);
374 print_buffer_pos += size;
375 print_buffer_pos_byte += size_byte;
377 else if (noninteractive && EQ (printcharfun, Qt))
379 fwrite (ptr, 1, size_byte, stdout);
380 noninteractive_need_newline = 1;
382 else if (EQ (printcharfun, Qt))
384 /* Output to echo area. We're trying to avoid a little overhead
385 here, that's the reason we don't call printchar to do the
386 job. */
387 int i;
388 int multibyte_p
389 = !NILP (current_buffer->enable_multibyte_characters);
391 setup_echo_area_for_printing (multibyte_p);
392 message_dolog (ptr, size_byte, 0, multibyte_p);
394 if (size == size_byte)
396 for (i = 0; i < size; ++i)
397 insert_char ((unsigned char) *ptr++);
399 else
401 int len;
402 for (i = 0; i < size_byte; i += len)
404 int ch = STRING_CHAR_AND_LENGTH (ptr + i, len);
405 insert_char (ch);
409 else
411 /* PRINTCHARFUN is a Lisp function. */
412 int i = 0;
414 if (size == size_byte)
416 while (i < size_byte)
418 int ch = ptr[i++];
419 PRINTCHAR (ch);
422 else
424 while (i < size_byte)
426 /* Here, we must convert each multi-byte form to the
427 corresponding character code before handing it to
428 PRINTCHAR. */
429 int len;
430 int ch = STRING_CHAR_AND_LENGTH (ptr + i, len);
431 PRINTCHAR (ch);
432 i += len;
438 /* Print the contents of a string STRING using PRINTCHARFUN.
439 It isn't safe to use strout in many cases,
440 because printing one char can relocate. */
442 static void
443 print_string (string, printcharfun)
444 Lisp_Object string;
445 Lisp_Object printcharfun;
447 if (EQ (printcharfun, Qt) || NILP (printcharfun))
449 int chars;
451 if (print_escape_nonascii)
452 string = string_escape_byte8 (string);
454 if (STRING_MULTIBYTE (string))
455 chars = SCHARS (string);
456 else if (! print_escape_nonascii
457 && (EQ (printcharfun, Qt)
458 ? ! NILP (buffer_defaults.enable_multibyte_characters)
459 : ! NILP (current_buffer->enable_multibyte_characters)))
461 /* If unibyte string STRING contains 8-bit codes, we must
462 convert STRING to a multibyte string containing the same
463 character codes. */
464 Lisp_Object newstr;
465 int bytes;
467 chars = SBYTES (string);
468 bytes = parse_str_to_multibyte (SDATA (string), chars);
469 if (chars < bytes)
471 newstr = make_uninit_multibyte_string (chars, bytes);
472 bcopy (SDATA (string), SDATA (newstr), chars);
473 str_to_multibyte (SDATA (newstr), bytes, chars);
474 string = newstr;
477 else
478 chars = SBYTES (string);
480 if (EQ (printcharfun, Qt))
482 /* Output to echo area. */
483 int nbytes = SBYTES (string);
484 char *buffer;
486 /* Copy the string contents so that relocation of STRING by
487 GC does not cause trouble. */
488 USE_SAFE_ALLOCA;
490 SAFE_ALLOCA (buffer, char *, nbytes);
491 bcopy (SDATA (string), buffer, nbytes);
493 strout (buffer, chars, SBYTES (string),
494 printcharfun, STRING_MULTIBYTE (string));
496 SAFE_FREE ();
498 else
499 /* No need to copy, since output to print_buffer can't GC. */
500 strout (SDATA (string),
501 chars, SBYTES (string),
502 printcharfun, STRING_MULTIBYTE (string));
504 else
506 /* Otherwise, string may be relocated by printing one char.
507 So re-fetch the string address for each character. */
508 int i;
509 int size = SCHARS (string);
510 int size_byte = SBYTES (string);
511 struct gcpro gcpro1;
512 GCPRO1 (string);
513 if (size == size_byte)
514 for (i = 0; i < size; i++)
515 PRINTCHAR (SREF (string, i));
516 else
517 for (i = 0; i < size_byte; )
519 /* Here, we must convert each multi-byte form to the
520 corresponding character code before handing it to PRINTCHAR. */
521 int len;
522 int ch = STRING_CHAR_AND_LENGTH (SDATA (string) + 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 || HASH_TABLE_P (obj)
1345 || (! NILP (Vprint_gensym)
1346 && SYMBOLP (obj)
1347 && !SYMBOL_INTERNED_P (obj)))
1349 /* In case print-circle is nil and print-gensym is t,
1350 add OBJ to Vprint_number_table only when OBJ is a symbol. */
1351 if (! NILP (Vprint_circle) || SYMBOLP (obj))
1353 for (i = 0; i < print_number_index; i++)
1354 if (EQ (PRINT_NUMBER_OBJECT (Vprint_number_table, i), obj))
1356 /* OBJ appears more than once. Let's remember that. */
1357 PRINT_NUMBER_STATUS (Vprint_number_table, i) = Qt;
1358 print_depth--;
1359 return;
1362 /* OBJ is not yet recorded. Let's add to the table. */
1363 if (print_number_index == 0)
1365 /* Initialize the table. */
1366 Vprint_number_table = Fmake_vector (make_number (40), Qnil);
1368 else if (XVECTOR (Vprint_number_table)->size == print_number_index * 2)
1370 /* Reallocate the table. */
1371 int i = print_number_index * 4;
1372 Lisp_Object old_table = Vprint_number_table;
1373 Vprint_number_table = Fmake_vector (make_number (i), Qnil);
1374 for (i = 0; i < print_number_index; i++)
1376 PRINT_NUMBER_OBJECT (Vprint_number_table, i)
1377 = PRINT_NUMBER_OBJECT (old_table, i);
1378 PRINT_NUMBER_STATUS (Vprint_number_table, i)
1379 = PRINT_NUMBER_STATUS (old_table, i);
1382 PRINT_NUMBER_OBJECT (Vprint_number_table, print_number_index) = obj;
1383 /* If Vprint_continuous_numbering is non-nil and OBJ is a gensym,
1384 always print the gensym with a number. This is a special for
1385 the lisp function byte-compile-output-docform. */
1386 if (!NILP (Vprint_continuous_numbering)
1387 && SYMBOLP (obj)
1388 && !SYMBOL_INTERNED_P (obj))
1389 PRINT_NUMBER_STATUS (Vprint_number_table, print_number_index) = Qt;
1390 print_number_index++;
1393 switch (XTYPE (obj))
1395 case Lisp_String:
1396 /* A string may have text properties, which can be circular. */
1397 traverse_intervals_noorder (STRING_INTERVALS (obj),
1398 print_preprocess_string, Qnil);
1399 break;
1401 case Lisp_Cons:
1402 /* Use HALFTAIL and LOOP_COUNT to detect circular lists,
1403 just as in print_object. */
1404 if (loop_count && EQ (obj, halftail))
1405 break;
1406 print_preprocess (XCAR (obj));
1407 obj = XCDR (obj);
1408 loop_count++;
1409 if (!(loop_count & 1))
1410 halftail = XCDR (halftail);
1411 goto loop;
1413 case Lisp_Vectorlike:
1414 size = XVECTOR (obj)->size;
1415 if (size & PSEUDOVECTOR_FLAG)
1416 size &= PSEUDOVECTOR_SIZE_MASK;
1417 for (i = 0; i < size; i++)
1418 print_preprocess (XVECTOR (obj)->contents[i]);
1419 break;
1421 default:
1422 break;
1425 print_depth--;
1428 static void
1429 print_preprocess_string (interval, arg)
1430 INTERVAL interval;
1431 Lisp_Object arg;
1433 print_preprocess (interval->plist);
1436 /* A flag to control printing of `charset' text property.
1437 The default value is Qdefault. */
1438 Lisp_Object Vprint_charset_text_property;
1439 extern Lisp_Object Qdefault;
1441 static void print_check_string_charset_prop ();
1443 #define PRINT_STRING_NON_CHARSET_FOUND 1
1444 #define PRINT_STRING_UNSAFE_CHARSET_FOUND 2
1446 /* Bitwize or of the abobe macros. */
1447 static int print_check_string_result;
1449 static void
1450 print_check_string_charset_prop (interval, string)
1451 INTERVAL interval;
1452 Lisp_Object string;
1454 Lisp_Object val;
1456 if (NILP (interval->plist)
1457 || (print_check_string_result == (PRINT_STRING_NON_CHARSET_FOUND
1458 | PRINT_STRING_UNSAFE_CHARSET_FOUND)))
1459 return;
1460 for (val = interval->plist; CONSP (val) && ! EQ (XCAR (val), Qcharset);
1461 val = XCDR (XCDR (val)));
1462 if (! CONSP (val))
1464 print_check_string_result |= PRINT_STRING_NON_CHARSET_FOUND;
1465 return;
1467 if (! (print_check_string_result & PRINT_STRING_NON_CHARSET_FOUND))
1469 if (! EQ (val, interval->plist)
1470 || CONSP (XCDR (XCDR (val))))
1471 print_check_string_result |= PRINT_STRING_NON_CHARSET_FOUND;
1473 if (NILP (Vprint_charset_text_property)
1474 || ! (print_check_string_result & PRINT_STRING_UNSAFE_CHARSET_FOUND))
1476 int i, c;
1477 int charpos = interval->position;
1478 int bytepos = string_char_to_byte (string, charpos);
1479 Lisp_Object charset;
1481 charset = XCAR (XCDR (val));
1482 for (i = 0; i < LENGTH (interval); i++)
1484 FETCH_STRING_CHAR_ADVANCE (c, string, charpos, bytepos);
1485 if (! ASCII_CHAR_P (c)
1486 && ! EQ (CHARSET_NAME (CHAR_CHARSET (c)), charset))
1488 print_check_string_result |= PRINT_STRING_UNSAFE_CHARSET_FOUND;
1489 break;
1495 /* The value is (charset . nil). */
1496 static Lisp_Object print_prune_charset_plist;
1498 static Lisp_Object
1499 print_prune_string_charset (string)
1500 Lisp_Object string;
1502 print_check_string_result = 0;
1503 traverse_intervals (STRING_INTERVALS (string), 0,
1504 print_check_string_charset_prop, string);
1505 if (! (print_check_string_result & PRINT_STRING_UNSAFE_CHARSET_FOUND))
1507 string = Fcopy_sequence (string);
1508 if (print_check_string_result & PRINT_STRING_NON_CHARSET_FOUND)
1510 if (NILP (print_prune_charset_plist))
1511 print_prune_charset_plist = Fcons (Qcharset, Qnil);
1512 Fremove_text_properties (make_number (0),
1513 make_number (SCHARS (string)),
1514 print_prune_charset_plist, string);
1516 else
1517 Fset_text_properties (make_number (0), make_number (SCHARS (string)),
1518 Qnil, string);
1520 return string;
1523 static void
1524 print_object (obj, printcharfun, escapeflag)
1525 Lisp_Object obj;
1526 register Lisp_Object printcharfun;
1527 int escapeflag;
1529 char buf[40];
1531 QUIT;
1533 /* See similar code in print_preprocess. */
1534 if (print_depth >= PRINT_CIRCLE)
1535 error ("Apparently circular structure being printed");
1537 /* Detect circularities and truncate them. */
1538 if (STRINGP (obj) || CONSP (obj) || VECTORP (obj)
1539 || COMPILEDP (obj) || CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj)
1540 || HASH_TABLE_P (obj)
1541 || (! NILP (Vprint_gensym)
1542 && SYMBOLP (obj)
1543 && !SYMBOL_INTERNED_P (obj)))
1545 if (NILP (Vprint_circle) && NILP (Vprint_gensym))
1547 /* Simple but incomplete way. */
1548 int i;
1549 for (i = 0; i < print_depth; i++)
1550 if (EQ (obj, being_printed[i]))
1552 sprintf (buf, "#%d", i);
1553 strout (buf, -1, -1, printcharfun, 0);
1554 return;
1556 being_printed[print_depth] = obj;
1558 else
1560 /* With the print-circle feature. */
1561 int i;
1562 for (i = 0; i < print_number_index; i++)
1563 if (EQ (PRINT_NUMBER_OBJECT (Vprint_number_table, i), obj))
1565 if (NILP (PRINT_NUMBER_STATUS (Vprint_number_table, i)))
1567 /* Add a prefix #n= if OBJ has not yet been printed;
1568 that is, its status field is nil. */
1569 sprintf (buf, "#%d=", i + 1);
1570 strout (buf, -1, -1, printcharfun, 0);
1571 /* OBJ is going to be printed. Set the status to t. */
1572 PRINT_NUMBER_STATUS (Vprint_number_table, i) = Qt;
1573 break;
1575 else
1577 /* Just print #n# if OBJ has already been printed. */
1578 sprintf (buf, "#%d#", i + 1);
1579 strout (buf, -1, -1, printcharfun, 0);
1580 return;
1586 print_depth++;
1588 switch (XTYPE (obj))
1590 case_Lisp_Int:
1591 if (sizeof (int) == sizeof (EMACS_INT))
1592 sprintf (buf, "%d", (int) XINT (obj));
1593 else if (sizeof (long) == sizeof (EMACS_INT))
1594 sprintf (buf, "%ld", (long) XINT (obj));
1595 else
1596 abort ();
1597 strout (buf, -1, -1, printcharfun, 0);
1598 break;
1600 case Lisp_Float:
1602 char pigbuf[350]; /* see comments in float_to_string */
1604 float_to_string (pigbuf, XFLOAT_DATA (obj));
1605 strout (pigbuf, -1, -1, printcharfun, 0);
1607 break;
1609 case Lisp_String:
1610 if (!escapeflag)
1611 print_string (obj, printcharfun);
1612 else
1614 register int i, i_byte;
1615 struct gcpro gcpro1;
1616 unsigned char *str;
1617 int size_byte;
1618 /* 1 means we must ensure that the next character we output
1619 cannot be taken as part of a hex character escape. */
1620 int need_nonhex = 0;
1621 int multibyte = STRING_MULTIBYTE (obj);
1623 GCPRO1 (obj);
1625 if (! EQ (Vprint_charset_text_property, Qt))
1626 obj = print_prune_string_charset (obj);
1628 if (!NULL_INTERVAL_P (STRING_INTERVALS (obj)))
1630 PRINTCHAR ('#');
1631 PRINTCHAR ('(');
1634 PRINTCHAR ('\"');
1635 str = SDATA (obj);
1636 size_byte = SBYTES (obj);
1638 for (i = 0, i_byte = 0; i_byte < size_byte;)
1640 /* Here, we must convert each multi-byte form to the
1641 corresponding character code before handing it to PRINTCHAR. */
1642 int len;
1643 int c;
1645 if (multibyte)
1647 c = STRING_CHAR_AND_LENGTH (str + i_byte, len);
1648 i_byte += len;
1650 else
1651 c = str[i_byte++];
1653 QUIT;
1655 if (c == '\n' && print_escape_newlines)
1657 PRINTCHAR ('\\');
1658 PRINTCHAR ('n');
1660 else if (c == '\f' && print_escape_newlines)
1662 PRINTCHAR ('\\');
1663 PRINTCHAR ('f');
1665 else if (multibyte
1666 && (CHAR_BYTE8_P (c)
1667 || (! ASCII_CHAR_P (c) && print_escape_multibyte)))
1669 /* When multibyte is disabled,
1670 print multibyte string chars using hex escapes.
1671 For a char code that could be in a unibyte string,
1672 when found in a multibyte string, always use a hex escape
1673 so it reads back as multibyte. */
1674 unsigned char outbuf[50];
1676 if (CHAR_BYTE8_P (c))
1677 sprintf (outbuf, "\\%03o", CHAR_TO_BYTE8 (c));
1678 else
1680 sprintf (outbuf, "\\x%04x", c);
1681 need_nonhex = 1;
1683 strout (outbuf, -1, -1, printcharfun, 0);
1685 else if (! multibyte
1686 && SINGLE_BYTE_CHAR_P (c) && ! ASCII_BYTE_P (c)
1687 && print_escape_nonascii)
1689 /* When printing in a multibyte buffer
1690 or when explicitly requested,
1691 print single-byte non-ASCII string chars
1692 using octal escapes. */
1693 unsigned char outbuf[5];
1694 sprintf (outbuf, "\\%03o", c);
1695 strout (outbuf, -1, -1, printcharfun, 0);
1697 else
1699 /* If we just had a hex escape, and this character
1700 could be taken as part of it,
1701 output `\ ' to prevent that. */
1702 if (need_nonhex)
1704 need_nonhex = 0;
1705 if ((c >= 'a' && c <= 'f')
1706 || (c >= 'A' && c <= 'F')
1707 || (c >= '0' && c <= '9'))
1708 strout ("\\ ", -1, -1, printcharfun, 0);
1711 if (c == '\"' || c == '\\')
1712 PRINTCHAR ('\\');
1713 PRINTCHAR (c);
1716 PRINTCHAR ('\"');
1718 if (!NULL_INTERVAL_P (STRING_INTERVALS (obj)))
1720 traverse_intervals (STRING_INTERVALS (obj),
1721 0, print_interval, printcharfun);
1722 PRINTCHAR (')');
1725 UNGCPRO;
1727 break;
1729 case Lisp_Symbol:
1731 register int confusing;
1732 register unsigned char *p = SDATA (SYMBOL_NAME (obj));
1733 register unsigned char *end = p + SBYTES (SYMBOL_NAME (obj));
1734 register int c;
1735 int i, i_byte, size_byte;
1736 Lisp_Object name;
1738 name = SYMBOL_NAME (obj);
1740 if (p != end && (*p == '-' || *p == '+')) p++;
1741 if (p == end)
1742 confusing = 0;
1743 /* If symbol name begins with a digit, and ends with a digit,
1744 and contains nothing but digits and `e', it could be treated
1745 as a number. So set CONFUSING.
1747 Symbols that contain periods could also be taken as numbers,
1748 but periods are always escaped, so we don't have to worry
1749 about them here. */
1750 else if (*p >= '0' && *p <= '9'
1751 && end[-1] >= '0' && end[-1] <= '9')
1753 while (p != end && ((*p >= '0' && *p <= '9')
1754 /* Needed for \2e10. */
1755 || *p == 'e' || *p == 'E'))
1756 p++;
1757 confusing = (end == p);
1759 else
1760 confusing = 0;
1762 if (! NILP (Vprint_gensym) && !SYMBOL_INTERNED_P (obj))
1764 PRINTCHAR ('#');
1765 PRINTCHAR (':');
1768 size_byte = SBYTES (name);
1770 for (i = 0, i_byte = 0; i_byte < size_byte;)
1772 /* Here, we must convert each multi-byte form to the
1773 corresponding character code before handing it to PRINTCHAR. */
1774 FETCH_STRING_CHAR_ADVANCE (c, name, i, i_byte);
1775 QUIT;
1777 if (escapeflag)
1779 if (c == '\"' || c == '\\' || c == '\''
1780 || c == ';' || c == '#' || c == '(' || c == ')'
1781 || c == ',' || c =='.' || c == '`'
1782 || c == '[' || c == ']' || c == '?' || c <= 040
1783 || confusing)
1784 PRINTCHAR ('\\'), confusing = 0;
1786 PRINTCHAR (c);
1789 break;
1791 case Lisp_Cons:
1792 /* If deeper than spec'd depth, print placeholder. */
1793 if (INTEGERP (Vprint_level)
1794 && print_depth > XINT (Vprint_level))
1795 strout ("...", -1, -1, printcharfun, 0);
1796 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1797 && (EQ (XCAR (obj), Qquote)))
1799 PRINTCHAR ('\'');
1800 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1802 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1803 && (EQ (XCAR (obj), Qfunction)))
1805 PRINTCHAR ('#');
1806 PRINTCHAR ('\'');
1807 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1809 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1810 && ((EQ (XCAR (obj), Qbackquote))))
1812 print_object (XCAR (obj), printcharfun, 0);
1813 new_backquote_output++;
1814 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1815 new_backquote_output--;
1817 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1818 && new_backquote_output
1819 && ((EQ (XCAR (obj), Qbackquote)
1820 || EQ (XCAR (obj), Qcomma)
1821 || EQ (XCAR (obj), Qcomma_at)
1822 || EQ (XCAR (obj), Qcomma_dot))))
1824 print_object (XCAR (obj), printcharfun, 0);
1825 new_backquote_output--;
1826 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1827 new_backquote_output++;
1829 else
1831 PRINTCHAR ('(');
1833 /* If the first element is a backquote form,
1834 print it old-style so it won't be misunderstood. */
1835 if (print_quoted && CONSP (XCAR (obj))
1836 && CONSP (XCDR (XCAR (obj)))
1837 && NILP (XCDR (XCDR (XCAR (obj))))
1838 && EQ (XCAR (XCAR (obj)), Qbackquote))
1840 Lisp_Object tem;
1841 tem = XCAR (obj);
1842 PRINTCHAR ('(');
1844 print_object (Qbackquote, printcharfun, 0);
1845 PRINTCHAR (' ');
1847 print_object (XCAR (XCDR (tem)), printcharfun, 0);
1848 PRINTCHAR (')');
1850 obj = XCDR (obj);
1854 int print_length, i;
1855 Lisp_Object halftail = obj;
1857 /* Negative values of print-length are invalid in CL.
1858 Treat them like nil, as CMUCL does. */
1859 if (NATNUMP (Vprint_length))
1860 print_length = XFASTINT (Vprint_length);
1861 else
1862 print_length = 0;
1864 i = 0;
1865 while (CONSP (obj))
1867 /* Detect circular list. */
1868 if (NILP (Vprint_circle))
1870 /* Simple but imcomplete way. */
1871 if (i != 0 && EQ (obj, halftail))
1873 sprintf (buf, " . #%d", i / 2);
1874 strout (buf, -1, -1, printcharfun, 0);
1875 goto end_of_list;
1878 else
1880 /* With the print-circle feature. */
1881 if (i != 0)
1883 int i;
1884 for (i = 0; i < print_number_index; i++)
1885 if (EQ (PRINT_NUMBER_OBJECT (Vprint_number_table, i),
1886 obj))
1888 if (NILP (PRINT_NUMBER_STATUS (Vprint_number_table, i)))
1890 strout (" . ", 3, 3, printcharfun, 0);
1891 print_object (obj, printcharfun, escapeflag);
1893 else
1895 sprintf (buf, " . #%d#", i + 1);
1896 strout (buf, -1, -1, printcharfun, 0);
1898 goto end_of_list;
1903 if (i++)
1904 PRINTCHAR (' ');
1906 if (print_length && i > print_length)
1908 strout ("...", 3, 3, printcharfun, 0);
1909 goto end_of_list;
1912 print_object (XCAR (obj), printcharfun, escapeflag);
1914 obj = XCDR (obj);
1915 if (!(i & 1))
1916 halftail = XCDR (halftail);
1920 /* OBJ non-nil here means it's the end of a dotted list. */
1921 if (!NILP (obj))
1923 strout (" . ", 3, 3, printcharfun, 0);
1924 print_object (obj, printcharfun, escapeflag);
1927 end_of_list:
1928 PRINTCHAR (')');
1930 break;
1932 case Lisp_Vectorlike:
1933 if (PROCESSP (obj))
1935 if (escapeflag)
1937 strout ("#<process ", -1, -1, printcharfun, 0);
1938 print_string (XPROCESS (obj)->name, printcharfun);
1939 PRINTCHAR ('>');
1941 else
1942 print_string (XPROCESS (obj)->name, printcharfun);
1944 else if (BOOL_VECTOR_P (obj))
1946 register int i;
1947 register unsigned char c;
1948 struct gcpro gcpro1;
1949 int size_in_chars
1950 = ((XBOOL_VECTOR (obj)->size + BOOL_VECTOR_BITS_PER_CHAR - 1)
1951 / BOOL_VECTOR_BITS_PER_CHAR);
1953 GCPRO1 (obj);
1955 PRINTCHAR ('#');
1956 PRINTCHAR ('&');
1957 sprintf (buf, "%ld", (long) XBOOL_VECTOR (obj)->size);
1958 strout (buf, -1, -1, printcharfun, 0);
1959 PRINTCHAR ('\"');
1961 /* Don't print more characters than the specified maximum.
1962 Negative values of print-length are invalid. Treat them
1963 like a print-length of nil. */
1964 if (NATNUMP (Vprint_length)
1965 && XFASTINT (Vprint_length) < size_in_chars)
1966 size_in_chars = XFASTINT (Vprint_length);
1968 for (i = 0; i < size_in_chars; i++)
1970 QUIT;
1971 c = XBOOL_VECTOR (obj)->data[i];
1972 if (c == '\n' && print_escape_newlines)
1974 PRINTCHAR ('\\');
1975 PRINTCHAR ('n');
1977 else if (c == '\f' && print_escape_newlines)
1979 PRINTCHAR ('\\');
1980 PRINTCHAR ('f');
1982 else if (c > '\177')
1984 /* Use octal escapes to avoid encoding issues. */
1985 PRINTCHAR ('\\');
1986 PRINTCHAR ('0' + ((c >> 6) & 3));
1987 PRINTCHAR ('0' + ((c >> 3) & 7));
1988 PRINTCHAR ('0' + (c & 7));
1990 else
1992 if (c == '\"' || c == '\\')
1993 PRINTCHAR ('\\');
1994 PRINTCHAR (c);
1997 PRINTCHAR ('\"');
1999 UNGCPRO;
2001 else if (SUBRP (obj))
2003 strout ("#<subr ", -1, -1, printcharfun, 0);
2004 strout (XSUBR (obj)->symbol_name, -1, -1, printcharfun, 0);
2005 PRINTCHAR ('>');
2007 else if (WINDOWP (obj))
2009 strout ("#<window ", -1, -1, printcharfun, 0);
2010 sprintf (buf, "%ld", (long) XFASTINT (XWINDOW (obj)->sequence_number));
2011 strout (buf, -1, -1, printcharfun, 0);
2012 if (!NILP (XWINDOW (obj)->buffer))
2014 strout (" on ", -1, -1, printcharfun, 0);
2015 print_string (XBUFFER (XWINDOW (obj)->buffer)->name, printcharfun);
2017 PRINTCHAR ('>');
2019 else if (TERMINALP (obj))
2021 struct terminal *t = XTERMINAL (obj);
2022 strout ("#<terminal ", -1, -1, printcharfun, 0);
2023 sprintf (buf, "%d", t->id);
2024 strout (buf, -1, -1, printcharfun, 0);
2025 if (t->name)
2027 strout (" on ", -1, -1, printcharfun, 0);
2028 strout (t->name, -1, -1, printcharfun, 0);
2030 PRINTCHAR ('>');
2032 else if (HASH_TABLE_P (obj))
2034 struct Lisp_Hash_Table *h = XHASH_TABLE (obj);
2035 int i, real_size, size;
2036 #if 0
2037 strout ("#<hash-table", -1, -1, printcharfun, 0);
2038 if (SYMBOLP (h->test))
2040 PRINTCHAR (' ');
2041 PRINTCHAR ('\'');
2042 strout (SDATA (SYMBOL_NAME (h->test)), -1, -1, printcharfun, 0);
2043 PRINTCHAR (' ');
2044 strout (SDATA (SYMBOL_NAME (h->weak)), -1, -1, printcharfun, 0);
2045 PRINTCHAR (' ');
2046 sprintf (buf, "%ld/%ld", (long) h->count,
2047 (long) XVECTOR (h->next)->size);
2048 strout (buf, -1, -1, printcharfun, 0);
2050 sprintf (buf, " 0x%lx", (unsigned long) h);
2051 strout (buf, -1, -1, printcharfun, 0);
2052 PRINTCHAR ('>');
2053 #endif
2054 /* Implement a readable output, e.g.:
2055 #s(hash-table size 2 test equal data (k1 v1 k2 v2)) */
2056 /* Always print the size. */
2057 sprintf (buf, "#s(hash-table size %ld",
2058 (long) XVECTOR (h->next)->size);
2059 strout (buf, -1, -1, printcharfun, 0);
2061 if (!NILP (h->test))
2063 strout (" test ", -1, -1, printcharfun, 0);
2064 print_object (h->test, printcharfun, 0);
2067 if (!NILP (h->weak))
2069 strout (" weakness ", -1, -1, printcharfun, 0);
2070 print_object (h->weak, printcharfun, 0);
2073 if (!NILP (h->rehash_size))
2075 strout (" rehash-size ", -1, -1, printcharfun, 0);
2076 print_object (h->rehash_size, printcharfun, 0);
2079 if (!NILP (h->rehash_threshold))
2081 strout (" rehash-threshold ", -1, -1, printcharfun, 0);
2082 print_object (h->rehash_threshold, printcharfun, 0);
2085 strout (" data ", -1, -1, printcharfun, 0);
2087 /* Print the data here as a plist. */
2088 real_size = HASH_TABLE_SIZE (h);
2089 size = real_size;
2091 /* Don't print more elements than the specified maximum. */
2092 if (NATNUMP (Vprint_length)
2093 && XFASTINT (Vprint_length) < size)
2094 size = XFASTINT (Vprint_length);
2096 PRINTCHAR ('(');
2097 for (i = 0; i < size; i++)
2098 if (!NILP (HASH_HASH (h, i)))
2100 if (i) PRINTCHAR (' ');
2101 print_object (HASH_KEY (h, i), printcharfun, 1);
2102 PRINTCHAR (' ');
2103 print_object (HASH_VALUE (h, i), printcharfun, 1);
2106 if (size < real_size)
2107 strout (" ...", 4, 4, printcharfun, 0);
2109 PRINTCHAR (')');
2110 PRINTCHAR (')');
2113 else if (BUFFERP (obj))
2115 if (NILP (XBUFFER (obj)->name))
2116 strout ("#<killed buffer>", -1, -1, printcharfun, 0);
2117 else if (escapeflag)
2119 strout ("#<buffer ", -1, -1, printcharfun, 0);
2120 print_string (XBUFFER (obj)->name, printcharfun);
2121 PRINTCHAR ('>');
2123 else
2124 print_string (XBUFFER (obj)->name, printcharfun);
2126 else if (WINDOW_CONFIGURATIONP (obj))
2128 strout ("#<window-configuration>", -1, -1, printcharfun, 0);
2130 else if (FRAMEP (obj))
2132 strout ((FRAME_LIVE_P (XFRAME (obj))
2133 ? "#<frame " : "#<dead frame "),
2134 -1, -1, printcharfun, 0);
2135 print_string (XFRAME (obj)->name, printcharfun);
2136 sprintf (buf, " 0x%lx", (unsigned long) (XFRAME (obj)));
2137 strout (buf, -1, -1, printcharfun, 0);
2138 PRINTCHAR ('>');
2140 else if (FONTP (obj))
2142 EMACS_INT i;
2144 if (! FONT_OBJECT_P (obj))
2146 if (FONT_SPEC_P (obj))
2147 strout ("#<font-spec", -1, -1, printcharfun, 0);
2148 else
2149 strout ("#<font-entity", -1, -1, printcharfun, 0);
2150 for (i = 0; i < FONT_SPEC_MAX; i++)
2152 PRINTCHAR (' ');
2153 if (i < FONT_WEIGHT_INDEX || i > FONT_WIDTH_INDEX)
2154 print_object (AREF (obj, i), printcharfun, escapeflag);
2155 else
2156 print_object (font_style_symbolic (obj, i, 0),
2157 printcharfun, escapeflag);
2160 else
2162 strout ("#<font-object ", -1, -1, printcharfun, 0);
2163 print_object (AREF (obj, FONT_NAME_INDEX), printcharfun,
2164 escapeflag);
2166 PRINTCHAR ('>');
2168 else
2170 EMACS_INT size = XVECTOR (obj)->size;
2171 if (COMPILEDP (obj))
2173 PRINTCHAR ('#');
2174 size &= PSEUDOVECTOR_SIZE_MASK;
2176 if (CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj))
2178 /* We print a char-table as if it were a vector,
2179 lumping the parent and default slots in with the
2180 character slots. But we add #^ as a prefix. */
2182 /* Make each lowest sub_char_table start a new line.
2183 Otherwise we'll make a line extremely long, which
2184 results in slow redisplay. */
2185 if (SUB_CHAR_TABLE_P (obj)
2186 && XINT (XSUB_CHAR_TABLE (obj)->depth) == 3)
2187 PRINTCHAR ('\n');
2188 PRINTCHAR ('#');
2189 PRINTCHAR ('^');
2190 if (SUB_CHAR_TABLE_P (obj))
2191 PRINTCHAR ('^');
2192 size &= PSEUDOVECTOR_SIZE_MASK;
2194 if (size & PSEUDOVECTOR_FLAG)
2195 goto badtype;
2197 PRINTCHAR ('[');
2199 register int i;
2200 register Lisp_Object tem;
2201 int real_size = size;
2203 /* Don't print more elements than the specified maximum. */
2204 if (NATNUMP (Vprint_length)
2205 && XFASTINT (Vprint_length) < size)
2206 size = XFASTINT (Vprint_length);
2208 for (i = 0; i < size; i++)
2210 if (i) PRINTCHAR (' ');
2211 tem = XVECTOR (obj)->contents[i];
2212 print_object (tem, printcharfun, escapeflag);
2214 if (size < real_size)
2215 strout (" ...", 4, 4, printcharfun, 0);
2217 PRINTCHAR (']');
2219 break;
2221 case Lisp_Misc:
2222 switch (XMISCTYPE (obj))
2224 case Lisp_Misc_Marker:
2225 strout ("#<marker ", -1, -1, printcharfun, 0);
2226 /* Do you think this is necessary? */
2227 if (XMARKER (obj)->insertion_type != 0)
2228 strout ("(moves after insertion) ", -1, -1, printcharfun, 0);
2229 if (! XMARKER (obj)->buffer)
2230 strout ("in no buffer", -1, -1, printcharfun, 0);
2231 else
2233 sprintf (buf, "at %d", marker_position (obj));
2234 strout (buf, -1, -1, printcharfun, 0);
2235 strout (" in ", -1, -1, printcharfun, 0);
2236 print_string (XMARKER (obj)->buffer->name, printcharfun);
2238 PRINTCHAR ('>');
2239 break;
2241 case Lisp_Misc_Overlay:
2242 strout ("#<overlay ", -1, -1, printcharfun, 0);
2243 if (! XMARKER (OVERLAY_START (obj))->buffer)
2244 strout ("in no buffer", -1, -1, printcharfun, 0);
2245 else
2247 sprintf (buf, "from %d to %d in ",
2248 marker_position (OVERLAY_START (obj)),
2249 marker_position (OVERLAY_END (obj)));
2250 strout (buf, -1, -1, printcharfun, 0);
2251 print_string (XMARKER (OVERLAY_START (obj))->buffer->name,
2252 printcharfun);
2254 PRINTCHAR ('>');
2255 break;
2257 /* Remaining cases shouldn't happen in normal usage, but let's print
2258 them anyway for the benefit of the debugger. */
2259 case Lisp_Misc_Free:
2260 strout ("#<misc free cell>", -1, -1, printcharfun, 0);
2261 break;
2263 case Lisp_Misc_Intfwd:
2264 sprintf (buf, "#<intfwd to %ld>", (long) *XINTFWD (obj)->intvar);
2265 strout (buf, -1, -1, printcharfun, 0);
2266 break;
2268 case Lisp_Misc_Boolfwd:
2269 sprintf (buf, "#<boolfwd to %s>",
2270 (*XBOOLFWD (obj)->boolvar ? "t" : "nil"));
2271 strout (buf, -1, -1, printcharfun, 0);
2272 break;
2274 case Lisp_Misc_Objfwd:
2275 strout ("#<objfwd to ", -1, -1, printcharfun, 0);
2276 print_object (*XOBJFWD (obj)->objvar, printcharfun, escapeflag);
2277 PRINTCHAR ('>');
2278 break;
2280 case Lisp_Misc_Buffer_Objfwd:
2281 strout ("#<buffer_objfwd to ", -1, -1, printcharfun, 0);
2282 print_object (PER_BUFFER_VALUE (current_buffer,
2283 XBUFFER_OBJFWD (obj)->offset),
2284 printcharfun, escapeflag);
2285 PRINTCHAR ('>');
2286 break;
2288 case Lisp_Misc_Kboard_Objfwd:
2289 strout ("#<kboard_objfwd to ", -1, -1, printcharfun, 0);
2290 print_object (*(Lisp_Object *) ((char *) current_kboard
2291 + XKBOARD_OBJFWD (obj)->offset),
2292 printcharfun, escapeflag);
2293 PRINTCHAR ('>');
2294 break;
2296 case Lisp_Misc_Buffer_Local_Value:
2297 strout ("#<buffer_local_value ", -1, -1, printcharfun, 0);
2298 if (XBUFFER_LOCAL_VALUE (obj)->local_if_set)
2299 strout ("[local-if-set] ", -1, -1, printcharfun, 0);
2300 strout ("[realvalue] ", -1, -1, printcharfun, 0);
2301 print_object (XBUFFER_LOCAL_VALUE (obj)->realvalue,
2302 printcharfun, escapeflag);
2303 if (XBUFFER_LOCAL_VALUE (obj)->found_for_buffer)
2304 strout ("[local in buffer] ", -1, -1, printcharfun, 0);
2305 else
2306 strout ("[buffer] ", -1, -1, printcharfun, 0);
2307 print_object (XBUFFER_LOCAL_VALUE (obj)->buffer,
2308 printcharfun, escapeflag);
2309 if (XBUFFER_LOCAL_VALUE (obj)->check_frame)
2311 if (XBUFFER_LOCAL_VALUE (obj)->found_for_frame)
2312 strout ("[local in frame] ", -1, -1, printcharfun, 0);
2313 else
2314 strout ("[frame] ", -1, -1, printcharfun, 0);
2315 print_object (XBUFFER_LOCAL_VALUE (obj)->frame,
2316 printcharfun, escapeflag);
2318 strout ("[alist-elt] ", -1, -1, printcharfun, 0);
2319 print_object (XCAR (XBUFFER_LOCAL_VALUE (obj)->cdr),
2320 printcharfun, escapeflag);
2321 strout ("[default-value] ", -1, -1, printcharfun, 0);
2322 print_object (XCDR (XBUFFER_LOCAL_VALUE (obj)->cdr),
2323 printcharfun, escapeflag);
2324 PRINTCHAR ('>');
2325 break;
2327 case Lisp_Misc_Save_Value:
2328 strout ("#<save_value ", -1, -1, printcharfun, 0);
2329 sprintf(buf, "ptr=0x%08lx int=%d",
2330 (unsigned long) XSAVE_VALUE (obj)->pointer,
2331 XSAVE_VALUE (obj)->integer);
2332 strout (buf, -1, -1, printcharfun, 0);
2333 PRINTCHAR ('>');
2334 break;
2336 default:
2337 goto badtype;
2339 break;
2341 default:
2342 badtype:
2344 /* We're in trouble if this happens!
2345 Probably should just abort () */
2346 strout ("#<EMACS BUG: INVALID DATATYPE ", -1, -1, printcharfun, 0);
2347 if (MISCP (obj))
2348 sprintf (buf, "(MISC 0x%04x)", (int) XMISCTYPE (obj));
2349 else if (VECTORLIKEP (obj))
2350 sprintf (buf, "(PVEC 0x%08x)", (int) XVECTOR (obj)->size);
2351 else
2352 sprintf (buf, "(0x%02x)", (int) XTYPE (obj));
2353 strout (buf, -1, -1, printcharfun, 0);
2354 strout (" Save your buffers immediately and please report this bug>",
2355 -1, -1, printcharfun, 0);
2359 print_depth--;
2363 /* Print a description of INTERVAL using PRINTCHARFUN.
2364 This is part of printing a string that has text properties. */
2366 void
2367 print_interval (interval, printcharfun)
2368 INTERVAL interval;
2369 Lisp_Object printcharfun;
2371 if (NILP (interval->plist))
2372 return;
2373 PRINTCHAR (' ');
2374 print_object (make_number (interval->position), printcharfun, 1);
2375 PRINTCHAR (' ');
2376 print_object (make_number (interval->position + LENGTH (interval)),
2377 printcharfun, 1);
2378 PRINTCHAR (' ');
2379 print_object (interval->plist, printcharfun, 1);
2383 void
2384 syms_of_print ()
2386 Qtemp_buffer_setup_hook = intern_c_string ("temp-buffer-setup-hook");
2387 staticpro (&Qtemp_buffer_setup_hook);
2389 DEFVAR_LISP ("standard-output", &Vstandard_output,
2390 doc: /* Output stream `print' uses by default for outputting a character.
2391 This may be any function of one argument.
2392 It may also be a buffer (output is inserted before point)
2393 or a marker (output is inserted and the marker is advanced)
2394 or the symbol t (output appears in the echo area). */);
2395 Vstandard_output = Qt;
2396 Qstandard_output = intern_c_string ("standard-output");
2397 staticpro (&Qstandard_output);
2399 DEFVAR_LISP ("float-output-format", &Vfloat_output_format,
2400 doc: /* The format descriptor string used to print floats.
2401 This is a %-spec like those accepted by `printf' in C,
2402 but with some restrictions. It must start with the two characters `%.'.
2403 After that comes an integer precision specification,
2404 and then a letter which controls the format.
2405 The letters allowed are `e', `f' and `g'.
2406 Use `e' for exponential notation \"DIG.DIGITSeEXPT\"
2407 Use `f' for decimal point notation \"DIGITS.DIGITS\".
2408 Use `g' to choose the shorter of those two formats for the number at hand.
2409 The precision in any of these cases is the number of digits following
2410 the decimal point. With `f', a precision of 0 means to omit the
2411 decimal point. 0 is not allowed with `e' or `g'.
2413 A value of nil means to use the shortest notation
2414 that represents the number without losing information. */);
2415 Vfloat_output_format = Qnil;
2416 Qfloat_output_format = intern_c_string ("float-output-format");
2417 staticpro (&Qfloat_output_format);
2419 DEFVAR_LISP ("print-length", &Vprint_length,
2420 doc: /* Maximum length of list to print before abbreviating.
2421 A value of nil means no limit. See also `eval-expression-print-length'. */);
2422 Vprint_length = Qnil;
2424 DEFVAR_LISP ("print-level", &Vprint_level,
2425 doc: /* Maximum depth of list nesting to print before abbreviating.
2426 A value of nil means no limit. See also `eval-expression-print-level'. */);
2427 Vprint_level = Qnil;
2429 DEFVAR_BOOL ("print-escape-newlines", &print_escape_newlines,
2430 doc: /* Non-nil means print newlines in strings as `\\n'.
2431 Also print formfeeds as `\\f'. */);
2432 print_escape_newlines = 0;
2434 DEFVAR_BOOL ("print-escape-nonascii", &print_escape_nonascii,
2435 doc: /* Non-nil means print unibyte non-ASCII chars in strings as \\OOO.
2436 \(OOO is the octal representation of the character code.)
2437 Only single-byte characters are affected, and only in `prin1'.
2438 When the output goes in a multibyte buffer, this feature is
2439 enabled regardless of the value of the variable. */);
2440 print_escape_nonascii = 0;
2442 DEFVAR_BOOL ("print-escape-multibyte", &print_escape_multibyte,
2443 doc: /* Non-nil means print multibyte characters in strings as \\xXXXX.
2444 \(XXXX is the hex representation of the character code.)
2445 This affects only `prin1'. */);
2446 print_escape_multibyte = 0;
2448 DEFVAR_BOOL ("print-quoted", &print_quoted,
2449 doc: /* Non-nil means print quoted forms with reader syntax.
2450 I.e., (quote foo) prints as 'foo, (function foo) as #'foo. */);
2451 print_quoted = 0;
2453 DEFVAR_LISP ("print-gensym", &Vprint_gensym,
2454 doc: /* Non-nil means print uninterned symbols so they will read as uninterned.
2455 I.e., the value of (make-symbol \"foobar\") prints as #:foobar.
2456 When the uninterned symbol appears within a recursive data structure,
2457 and the symbol appears more than once, in addition use the #N# and #N=
2458 constructs as needed, so that multiple references to the same symbol are
2459 shared once again when the text is read back. */);
2460 Vprint_gensym = Qnil;
2462 DEFVAR_LISP ("print-circle", &Vprint_circle,
2463 doc: /* *Non-nil means print recursive structures using #N= and #N# syntax.
2464 If nil, printing proceeds recursively and may lead to
2465 `max-lisp-eval-depth' being exceeded or an error may occur:
2466 \"Apparently circular structure being printed.\" Also see
2467 `print-length' and `print-level'.
2468 If non-nil, shared substructures anywhere in the structure are printed
2469 with `#N=' before the first occurrence (in the order of the print
2470 representation) and `#N#' in place of each subsequent occurrence,
2471 where N is a positive decimal integer. */);
2472 Vprint_circle = Qnil;
2474 DEFVAR_LISP ("print-continuous-numbering", &Vprint_continuous_numbering,
2475 doc: /* *Non-nil means number continuously across print calls.
2476 This affects the numbers printed for #N= labels and #M# references.
2477 See also `print-circle', `print-gensym', and `print-number-table'.
2478 This variable should not be set with `setq'; bind it with a `let' instead. */);
2479 Vprint_continuous_numbering = Qnil;
2481 DEFVAR_LISP ("print-number-table", &Vprint_number_table,
2482 doc: /* A vector used internally to produce `#N=' labels and `#N#' references.
2483 The Lisp printer uses this vector to detect Lisp objects referenced more
2484 than once.
2486 When you bind `print-continuous-numbering' to t, you should probably
2487 also bind `print-number-table' to nil. This ensures that the value of
2488 `print-number-table' can be garbage-collected once the printing is
2489 done. If all elements of `print-number-table' are nil, it means that
2490 the printing done so far has not found any shared structure or objects
2491 that need to be recorded in the table. */);
2492 Vprint_number_table = Qnil;
2494 DEFVAR_LISP ("print-charset-text-property", &Vprint_charset_text_property,
2495 doc: /* A flag to control printing of `charset' text property on printing a string.
2496 The value must be nil, t, or `default'.
2498 If the value is nil, don't print the text property `charset'.
2500 If the value is t, always print the text property `charset'.
2502 If the value is `default', print the text property `charset' only when
2503 the value is different from what is guessed in the current charset
2504 priorities. */);
2505 Vprint_charset_text_property = Qdefault;
2507 /* prin1_to_string_buffer initialized in init_buffer_once in buffer.c */
2508 staticpro (&Vprin1_to_string_buffer);
2510 defsubr (&Sprin1);
2511 defsubr (&Sprin1_to_string);
2512 defsubr (&Serror_message_string);
2513 defsubr (&Sprinc);
2514 defsubr (&Sprint);
2515 defsubr (&Sterpri);
2516 defsubr (&Swrite_char);
2517 defsubr (&Sexternal_debugging_output);
2518 #ifdef WITH_REDIRECT_DEBUGGING_OUTPUT
2519 defsubr (&Sredirect_debugging_output);
2520 #endif
2522 Qexternal_debugging_output = intern_c_string ("external-debugging-output");
2523 staticpro (&Qexternal_debugging_output);
2525 Qprint_escape_newlines = intern_c_string ("print-escape-newlines");
2526 staticpro (&Qprint_escape_newlines);
2528 Qprint_escape_multibyte = intern_c_string ("print-escape-multibyte");
2529 staticpro (&Qprint_escape_multibyte);
2531 Qprint_escape_nonascii = intern_c_string ("print-escape-nonascii");
2532 staticpro (&Qprint_escape_nonascii);
2534 print_prune_charset_plist = Qnil;
2535 staticpro (&print_prune_charset_plist);
2537 defsubr (&Swith_output_to_temp_buffer);
2540 /* arch-tag: bc797170-94ae-41de-86e3-75e20f8f7a39
2541 (do not change this comment) */