merge trunk
[bpt/emacs.git] / src / print.c
1 /* Lisp object printing and output streams.
2
3 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2012
4 Free Software Foundation, Inc.
5
6 This file is part of GNU Emacs.
7
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.
12
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.
17
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/>. */
20
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <setjmp.h>
25 #include "lisp.h"
26 #include "character.h"
27 #include "buffer.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"
39
40 Lisp_Object Qstandard_output;
41
42 static Lisp_Object Qtemp_buffer_setup_hook;
43
44 /* These are used to print like we read. */
45
46 static Lisp_Object Qfloat_output_format;
47
48 #include <math.h>
49 #include <float.h>
50 #include <ftoastr.h>
51
52 /* Default to values appropriate for IEEE floating point. */
53 #ifndef DBL_DIG
54 #define DBL_DIG 15
55 #endif
56
57 /* Avoid actual stack overflow in print. */
58 static ptrdiff_t print_depth;
59
60 /* Level of nesting inside outputting backquote in new style. */
61 static ptrdiff_t new_backquote_output;
62
63 /* Detect most circularities to print finite output. */
64 #define PRINT_CIRCLE 200
65 static Lisp_Object being_printed[PRINT_CIRCLE];
66
67 /* When printing into a buffer, first we put the text in this
68 block, then insert it all at once. */
69 static char *print_buffer;
70
71 /* Size allocated in print_buffer. */
72 static ptrdiff_t print_buffer_size;
73 /* Chars stored in print_buffer. */
74 static ptrdiff_t print_buffer_pos;
75 /* Bytes stored in print_buffer. */
76 static ptrdiff_t print_buffer_pos_byte;
77
78 Lisp_Object Qprint_escape_newlines;
79 static Lisp_Object Qprint_escape_multibyte, Qprint_escape_nonascii;
80
81 /* Vprint_number_table is a table, that keeps objects that are going to
82 be printed, to allow use of #n= and #n# to express sharing.
83 For any given object, the table can give the following values:
84 t the object will be printed only once.
85 -N the object will be printed several times and will take number N.
86 N the object has been printed so we can refer to it as #N#.
87 print_number_index holds the largest N already used.
88 N has to be striclty larger than 0 since we need to distinguish -N. */
89 static ptrdiff_t print_number_index;
90 static void print_interval (INTERVAL interval, Lisp_Object printcharfun);
91
92 /* GDB resets this to zero on W32 to disable OutputDebugString calls. */
93 int print_output_debug_flag EXTERNALLY_VISIBLE = 1;
94
95 \f
96 /* Low level output routines for characters and strings. */
97
98 /* Lisp functions to do output using a stream
99 must have the stream in a variable called printcharfun
100 and must start with PRINTPREPARE, end with PRINTFINISH,
101 and use PRINTDECLARE to declare common variables.
102 Use PRINTCHAR to output one character,
103 or call strout to output a block of characters. */
104
105 #define PRINTDECLARE \
106 struct buffer *old = current_buffer; \
107 ptrdiff_t old_point = -1, start_point = -1; \
108 ptrdiff_t old_point_byte = -1, start_point_byte = -1; \
109 ptrdiff_t specpdl_count = SPECPDL_INDEX (); \
110 int free_print_buffer = 0; \
111 int multibyte = !NILP (BVAR (current_buffer, enable_multibyte_characters)); \
112 Lisp_Object original
113
114 #define PRINTPREPARE \
115 original = printcharfun; \
116 if (NILP (printcharfun)) printcharfun = Qt; \
117 if (BUFFERP (printcharfun)) \
118 { \
119 if (XBUFFER (printcharfun) != current_buffer) \
120 Fset_buffer (printcharfun); \
121 printcharfun = Qnil; \
122 } \
123 if (MARKERP (printcharfun)) \
124 { \
125 ptrdiff_t marker_pos; \
126 if (! XMARKER (printcharfun)->buffer) \
127 error ("Marker does not point anywhere"); \
128 if (XMARKER (printcharfun)->buffer != current_buffer) \
129 set_buffer_internal (XMARKER (printcharfun)->buffer); \
130 marker_pos = marker_position (printcharfun); \
131 if (marker_pos < BEGV || marker_pos > ZV) \
132 error ("Marker is outside the accessible part of the buffer"); \
133 old_point = PT; \
134 old_point_byte = PT_BYTE; \
135 SET_PT_BOTH (marker_pos, \
136 marker_byte_position (printcharfun)); \
137 start_point = PT; \
138 start_point_byte = PT_BYTE; \
139 printcharfun = Qnil; \
140 } \
141 if (NILP (printcharfun)) \
142 { \
143 Lisp_Object string; \
144 if (NILP (BVAR (current_buffer, enable_multibyte_characters)) \
145 && ! print_escape_multibyte) \
146 specbind (Qprint_escape_multibyte, Qt); \
147 if (! NILP (BVAR (current_buffer, enable_multibyte_characters)) \
148 && ! print_escape_nonascii) \
149 specbind (Qprint_escape_nonascii, Qt); \
150 if (print_buffer != 0) \
151 { \
152 string = make_string_from_bytes (print_buffer, \
153 print_buffer_pos, \
154 print_buffer_pos_byte); \
155 record_unwind_protect (print_unwind, string); \
156 } \
157 else \
158 { \
159 int new_size = 1000; \
160 print_buffer = xmalloc (new_size); \
161 print_buffer_size = new_size; \
162 free_print_buffer = 1; \
163 } \
164 print_buffer_pos = 0; \
165 print_buffer_pos_byte = 0; \
166 } \
167 if (EQ (printcharfun, Qt) && ! noninteractive) \
168 setup_echo_area_for_printing (multibyte);
169
170 #define PRINTFINISH \
171 if (NILP (printcharfun)) \
172 { \
173 if (print_buffer_pos != print_buffer_pos_byte \
174 && NILP (BVAR (current_buffer, enable_multibyte_characters))) \
175 { \
176 unsigned char *temp = alloca (print_buffer_pos + 1); \
177 copy_text ((unsigned char *) print_buffer, temp, \
178 print_buffer_pos_byte, 1, 0); \
179 insert_1_both ((char *) temp, print_buffer_pos, \
180 print_buffer_pos, 0, 1, 0); \
181 } \
182 else \
183 insert_1_both (print_buffer, print_buffer_pos, \
184 print_buffer_pos_byte, 0, 1, 0); \
185 signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
186 } \
187 if (free_print_buffer) \
188 { \
189 xfree (print_buffer); \
190 print_buffer = 0; \
191 } \
192 unbind_to (specpdl_count, Qnil); \
193 if (MARKERP (original)) \
194 set_marker_both (original, Qnil, PT, PT_BYTE); \
195 if (old_point >= 0) \
196 SET_PT_BOTH (old_point + (old_point >= start_point \
197 ? PT - start_point : 0), \
198 old_point_byte + (old_point_byte >= start_point_byte \
199 ? PT_BYTE - start_point_byte : 0)); \
200 if (old != current_buffer) \
201 set_buffer_internal (old);
202
203 #define PRINTCHAR(ch) printchar (ch, printcharfun)
204
205 /* This is used to restore the saved contents of print_buffer
206 when there is a recursive call to print. */
207
208 static Lisp_Object
209 print_unwind (Lisp_Object saved_text)
210 {
211 memcpy (print_buffer, SDATA (saved_text), SCHARS (saved_text));
212 return Qnil;
213 }
214
215
216 /* Print character CH using method FUN. FUN nil means print to
217 print_buffer. FUN t means print to echo area or stdout if
218 non-interactive. If FUN is neither nil nor t, call FUN with CH as
219 argument. */
220
221 static void
222 printchar (unsigned int ch, Lisp_Object fun)
223 {
224 if (!NILP (fun) && !EQ (fun, Qt))
225 call1 (fun, make_number (ch));
226 else
227 {
228 unsigned char str[MAX_MULTIBYTE_LENGTH];
229 int len = CHAR_STRING (ch, str);
230
231 QUIT;
232
233 if (NILP (fun))
234 {
235 ptrdiff_t incr = len - (print_buffer_size - print_buffer_pos_byte);
236 if (0 < incr)
237 print_buffer =
238 xpalloc (print_buffer, &print_buffer_size, incr, -1, 1);
239 memcpy (print_buffer + print_buffer_pos_byte, str, len);
240 print_buffer_pos += 1;
241 print_buffer_pos_byte += len;
242 }
243 else if (noninteractive)
244 {
245 fwrite (str, 1, len, stdout);
246 noninteractive_need_newline = 1;
247 }
248 else
249 {
250 int multibyte_p
251 = !NILP (BVAR (current_buffer, enable_multibyte_characters));
252
253 setup_echo_area_for_printing (multibyte_p);
254 insert_char (ch);
255 message_dolog ((char *) str, len, 0, multibyte_p);
256 }
257 }
258 }
259
260
261 /* Output SIZE characters, SIZE_BYTE bytes from string PTR using
262 method PRINTCHARFUN. If SIZE < 0, use the string length of PTR for
263 both SIZE and SIZE_BYTE. PRINTCHARFUN nil means output to
264 print_buffer. PRINTCHARFUN t means output to the echo area or to
265 stdout if non-interactive. If neither nil nor t, call Lisp
266 function PRINTCHARFUN for each character printed. MULTIBYTE
267 non-zero means PTR contains multibyte characters.
268
269 In the case where PRINTCHARFUN is nil, it is safe for PTR to point
270 to data in a Lisp string. Otherwise that is not safe. */
271
272 static void
273 strout (const char *ptr, ptrdiff_t size, ptrdiff_t size_byte,
274 Lisp_Object printcharfun)
275 {
276 if (size < 0)
277 size_byte = size = strlen (ptr);
278
279 if (NILP (printcharfun))
280 {
281 ptrdiff_t incr = size_byte - (print_buffer_size - print_buffer_pos_byte);
282 if (0 < incr)
283 print_buffer = xpalloc (print_buffer, &print_buffer_size, incr, -1, 1);
284 memcpy (print_buffer + print_buffer_pos_byte, ptr, size_byte);
285 print_buffer_pos += size;
286 print_buffer_pos_byte += size_byte;
287 }
288 else if (noninteractive && EQ (printcharfun, Qt))
289 {
290 fwrite (ptr, 1, size_byte, stdout);
291 noninteractive_need_newline = 1;
292 }
293 else if (EQ (printcharfun, Qt))
294 {
295 /* Output to echo area. We're trying to avoid a little overhead
296 here, that's the reason we don't call printchar to do the
297 job. */
298 int i;
299 int multibyte_p
300 = !NILP (BVAR (current_buffer, enable_multibyte_characters));
301
302 setup_echo_area_for_printing (multibyte_p);
303 message_dolog (ptr, size_byte, 0, multibyte_p);
304
305 if (size == size_byte)
306 {
307 for (i = 0; i < size; ++i)
308 insert_char ((unsigned char) *ptr++);
309 }
310 else
311 {
312 int len;
313 for (i = 0; i < size_byte; i += len)
314 {
315 int ch = STRING_CHAR_AND_LENGTH ((const unsigned char *) ptr + i,
316 len);
317 insert_char (ch);
318 }
319 }
320 }
321 else
322 {
323 /* PRINTCHARFUN is a Lisp function. */
324 ptrdiff_t i = 0;
325
326 if (size == size_byte)
327 {
328 while (i < size_byte)
329 {
330 int ch = ptr[i++];
331 PRINTCHAR (ch);
332 }
333 }
334 else
335 {
336 while (i < size_byte)
337 {
338 /* Here, we must convert each multi-byte form to the
339 corresponding character code before handing it to
340 PRINTCHAR. */
341 int len;
342 int ch = STRING_CHAR_AND_LENGTH ((const unsigned char *) ptr + i,
343 len);
344 PRINTCHAR (ch);
345 i += len;
346 }
347 }
348 }
349 }
350
351 /* Print the contents of a string STRING using PRINTCHARFUN.
352 It isn't safe to use strout in many cases,
353 because printing one char can relocate. */
354
355 static void
356 print_string (Lisp_Object string, Lisp_Object printcharfun)
357 {
358 if (EQ (printcharfun, Qt) || NILP (printcharfun))
359 {
360 ptrdiff_t chars;
361
362 if (print_escape_nonascii)
363 string = string_escape_byte8 (string);
364
365 if (STRING_MULTIBYTE (string))
366 chars = SCHARS (string);
367 else if (! print_escape_nonascii
368 && (EQ (printcharfun, Qt)
369 ? ! NILP (BVAR (&buffer_defaults, enable_multibyte_characters))
370 : ! NILP (BVAR (current_buffer, enable_multibyte_characters))))
371 {
372 /* If unibyte string STRING contains 8-bit codes, we must
373 convert STRING to a multibyte string containing the same
374 character codes. */
375 Lisp_Object newstr;
376 ptrdiff_t bytes;
377
378 chars = SBYTES (string);
379 bytes = count_size_as_multibyte (SDATA (string), chars);
380 if (chars < bytes)
381 {
382 newstr = make_uninit_multibyte_string (chars, bytes);
383 memcpy (SDATA (newstr), SDATA (string), chars);
384 str_to_multibyte (SDATA (newstr), bytes, chars);
385 string = newstr;
386 }
387 }
388 else
389 chars = SBYTES (string);
390
391 if (EQ (printcharfun, Qt))
392 {
393 /* Output to echo area. */
394 ptrdiff_t nbytes = SBYTES (string);
395
396 /* Copy the string contents so that relocation of STRING by
397 GC does not cause trouble. */
398 USE_SAFE_ALLOCA;
399 char *buffer = SAFE_ALLOCA (nbytes);
400 memcpy (buffer, SDATA (string), nbytes);
401
402 strout (buffer, chars, nbytes, printcharfun);
403
404 SAFE_FREE ();
405 }
406 else
407 /* No need to copy, since output to print_buffer can't GC. */
408 strout (SSDATA (string), chars, SBYTES (string), printcharfun);
409 }
410 else
411 {
412 /* Otherwise, string may be relocated by printing one char.
413 So re-fetch the string address for each character. */
414 ptrdiff_t i;
415 ptrdiff_t size = SCHARS (string);
416 ptrdiff_t size_byte = SBYTES (string);
417 struct gcpro gcpro1;
418 GCPRO1 (string);
419 if (size == size_byte)
420 for (i = 0; i < size; i++)
421 PRINTCHAR (SREF (string, i));
422 else
423 for (i = 0; i < size_byte; )
424 {
425 /* Here, we must convert each multi-byte form to the
426 corresponding character code before handing it to PRINTCHAR. */
427 int len;
428 int ch = STRING_CHAR_AND_LENGTH (SDATA (string) + i, len);
429 PRINTCHAR (ch);
430 i += len;
431 }
432 UNGCPRO;
433 }
434 }
435 \f
436 DEFUN ("write-char", Fwrite_char, Swrite_char, 1, 2, 0,
437 doc: /* Output character CHARACTER to stream PRINTCHARFUN.
438 PRINTCHARFUN defaults to the value of `standard-output' (which see). */)
439 (Lisp_Object character, Lisp_Object printcharfun)
440 {
441 PRINTDECLARE;
442
443 if (NILP (printcharfun))
444 printcharfun = Vstandard_output;
445 CHECK_NUMBER (character);
446 PRINTPREPARE;
447 PRINTCHAR (XINT (character));
448 PRINTFINISH;
449 return character;
450 }
451
452 /* Used from outside of print.c to print a block of SIZE
453 single-byte chars at DATA on the default output stream.
454 Do not use this on the contents of a Lisp string. */
455
456 void
457 write_string (const char *data, int size)
458 {
459 PRINTDECLARE;
460 Lisp_Object printcharfun;
461
462 printcharfun = Vstandard_output;
463
464 PRINTPREPARE;
465 strout (data, size, size, printcharfun);
466 PRINTFINISH;
467 }
468
469 /* Used to print a block of SIZE single-byte chars at DATA on a
470 specified stream PRINTCHARFUN.
471 Do not use this on the contents of a Lisp string. */
472
473 static void
474 write_string_1 (const char *data, int size, Lisp_Object printcharfun)
475 {
476 PRINTDECLARE;
477
478 PRINTPREPARE;
479 strout (data, size, size, printcharfun);
480 PRINTFINISH;
481 }
482
483
484 void
485 temp_output_buffer_setup (const char *bufname)
486 {
487 ptrdiff_t count = SPECPDL_INDEX ();
488 register struct buffer *old = current_buffer;
489 register Lisp_Object buf;
490
491 record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
492
493 Fset_buffer (Fget_buffer_create (build_string (bufname)));
494
495 Fkill_all_local_variables ();
496 delete_all_overlays (current_buffer);
497 bset_directory (current_buffer, BVAR (old, directory));
498 bset_read_only (current_buffer, Qnil);
499 bset_filename (current_buffer, Qnil);
500 bset_undo_list (current_buffer, Qt);
501 eassert (current_buffer->overlays_before == NULL);
502 eassert (current_buffer->overlays_after == NULL);
503 bset_enable_multibyte_characters
504 (current_buffer, BVAR (&buffer_defaults, enable_multibyte_characters));
505 specbind (Qinhibit_read_only, Qt);
506 specbind (Qinhibit_modification_hooks, Qt);
507 Ferase_buffer ();
508 XSETBUFFER (buf, current_buffer);
509
510 Frun_hooks (1, &Qtemp_buffer_setup_hook);
511
512 unbind_to (count, Qnil);
513
514 specbind (Qstandard_output, buf);
515 }
516 \f
517 static void print (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag);
518 static void print_preprocess (Lisp_Object obj);
519 static void print_preprocess_string (INTERVAL interval, Lisp_Object arg);
520 static void print_object (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag);
521
522 DEFUN ("terpri", Fterpri, Sterpri, 0, 1, 0,
523 doc: /* Output a newline to stream PRINTCHARFUN.
524 If PRINTCHARFUN is omitted or nil, the value of `standard-output' is used. */)
525 (Lisp_Object printcharfun)
526 {
527 PRINTDECLARE;
528
529 if (NILP (printcharfun))
530 printcharfun = Vstandard_output;
531 PRINTPREPARE;
532 PRINTCHAR ('\n');
533 PRINTFINISH;
534 return Qt;
535 }
536
537 DEFUN ("prin1", Fprin1, Sprin1, 1, 2, 0,
538 doc: /* Output the printed representation of OBJECT, any Lisp object.
539 Quoting characters are printed when needed to make output that `read'
540 can handle, whenever this is possible. For complex objects, the behavior
541 is controlled by `print-level' and `print-length', which see.
542
543 OBJECT is any of the Lisp data types: a number, a string, a symbol,
544 a list, a buffer, a window, a frame, etc.
545
546 A printed representation of an object is text which describes that object.
547
548 Optional argument PRINTCHARFUN is the output stream, which can be one
549 of these:
550
551 - a buffer, in which case output is inserted into that buffer at point;
552 - a marker, in which case output is inserted at marker's position;
553 - a function, in which case that function is called once for each
554 character of OBJECT's printed representation;
555 - a symbol, in which case that symbol's function definition is called; or
556 - t, in which case the output is displayed in the echo area.
557
558 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
559 is used instead. */)
560 (Lisp_Object object, Lisp_Object printcharfun)
561 {
562 PRINTDECLARE;
563
564 if (NILP (printcharfun))
565 printcharfun = Vstandard_output;
566 PRINTPREPARE;
567 print (object, printcharfun, 1);
568 PRINTFINISH;
569 return object;
570 }
571
572 /* a buffer which is used to hold output being built by prin1-to-string */
573 Lisp_Object Vprin1_to_string_buffer;
574
575 DEFUN ("prin1-to-string", Fprin1_to_string, Sprin1_to_string, 1, 2, 0,
576 doc: /* Return a string containing the printed representation of OBJECT.
577 OBJECT can be any Lisp object. This function outputs quoting characters
578 when necessary to make output that `read' can handle, whenever possible,
579 unless the optional second argument NOESCAPE is non-nil. For complex objects,
580 the behavior is controlled by `print-level' and `print-length', which see.
581
582 OBJECT is any of the Lisp data types: a number, a string, a symbol,
583 a list, a buffer, a window, a frame, etc.
584
585 A printed representation of an object is text which describes that object. */)
586 (Lisp_Object object, Lisp_Object noescape)
587 {
588 Lisp_Object printcharfun;
589 bool prev_abort_on_gc;
590 /* struct gcpro gcpro1, gcpro2; */
591 Lisp_Object save_deactivate_mark;
592 ptrdiff_t count = SPECPDL_INDEX ();
593 struct buffer *previous;
594
595 specbind (Qinhibit_modification_hooks, Qt);
596
597 {
598 PRINTDECLARE;
599
600 /* Save and restore this--we are altering a buffer
601 but we don't want to deactivate the mark just for that.
602 No need for specbind, since errors deactivate the mark. */
603 save_deactivate_mark = Vdeactivate_mark;
604 /* GCPRO2 (object, save_deactivate_mark); */
605 prev_abort_on_gc = abort_on_gc;
606 abort_on_gc = 1;
607
608 printcharfun = Vprin1_to_string_buffer;
609 PRINTPREPARE;
610 print (object, printcharfun, NILP (noescape));
611 /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINISH */
612 PRINTFINISH;
613 }
614
615 previous = current_buffer;
616 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
617 object = Fbuffer_string ();
618 if (SBYTES (object) == SCHARS (object))
619 STRING_SET_UNIBYTE (object);
620
621 /* Note that this won't make prepare_to_modify_buffer call
622 ask-user-about-supersession-threat because this buffer
623 does not visit a file. */
624 Ferase_buffer ();
625 set_buffer_internal (previous);
626
627 Vdeactivate_mark = save_deactivate_mark;
628 /* UNGCPRO; */
629
630 abort_on_gc = prev_abort_on_gc;
631 return unbind_to (count, object);
632 }
633
634 DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
635 doc: /* Output the printed representation of OBJECT, any Lisp object.
636 No quoting characters are used; no delimiters are printed around
637 the contents of strings.
638
639 OBJECT is any of the Lisp data types: a number, a string, a symbol,
640 a list, a buffer, a window, a frame, etc.
641
642 A printed representation of an object is text which describes that object.
643
644 Optional argument PRINTCHARFUN is the output stream, which can be one
645 of these:
646
647 - a buffer, in which case output is inserted into that buffer at point;
648 - a marker, in which case output is inserted at marker's position;
649 - a function, in which case that function is called once for each
650 character of OBJECT's printed representation;
651 - a symbol, in which case that symbol's function definition is called; or
652 - t, in which case the output is displayed in the echo area.
653
654 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
655 is used instead. */)
656 (Lisp_Object object, Lisp_Object printcharfun)
657 {
658 PRINTDECLARE;
659
660 if (NILP (printcharfun))
661 printcharfun = Vstandard_output;
662 PRINTPREPARE;
663 print (object, printcharfun, 0);
664 PRINTFINISH;
665 return object;
666 }
667
668 DEFUN ("print", Fprint, Sprint, 1, 2, 0,
669 doc: /* Output the printed representation of OBJECT, with newlines around it.
670 Quoting characters are printed when needed to make output that `read'
671 can handle, whenever this is possible. For complex objects, the behavior
672 is controlled by `print-level' and `print-length', which see.
673
674 OBJECT is any of the Lisp data types: a number, a string, a symbol,
675 a list, a buffer, a window, a frame, etc.
676
677 A printed representation of an object is text which describes that object.
678
679 Optional argument PRINTCHARFUN is the output stream, which can be one
680 of these:
681
682 - a buffer, in which case output is inserted into that buffer at point;
683 - a marker, in which case output is inserted at marker's position;
684 - a function, in which case that function is called once for each
685 character of OBJECT's printed representation;
686 - a symbol, in which case that symbol's function definition is called; or
687 - t, in which case the output is displayed in the echo area.
688
689 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
690 is used instead. */)
691 (Lisp_Object object, Lisp_Object printcharfun)
692 {
693 PRINTDECLARE;
694 struct gcpro gcpro1;
695
696 if (NILP (printcharfun))
697 printcharfun = Vstandard_output;
698 GCPRO1 (object);
699 PRINTPREPARE;
700 PRINTCHAR ('\n');
701 print (object, printcharfun, 1);
702 PRINTCHAR ('\n');
703 PRINTFINISH;
704 UNGCPRO;
705 return object;
706 }
707
708 /* The subroutine object for external-debugging-output is kept here
709 for the convenience of the debugger. */
710 Lisp_Object Qexternal_debugging_output;
711
712 DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
713 doc: /* Write CHARACTER to stderr.
714 You can call print while debugging emacs, and pass it this function
715 to make it write to the debugging output. */)
716 (Lisp_Object character)
717 {
718 CHECK_NUMBER (character);
719 putc (XINT (character) & 0xFF, stderr);
720
721 #ifdef WINDOWSNT
722 /* Send the output to a debugger (nothing happens if there isn't one). */
723 if (print_output_debug_flag)
724 {
725 char buf[2] = {(char) XINT (character), '\0'};
726 OutputDebugString (buf);
727 }
728 #endif
729
730 return character;
731 }
732
733 /* This function is never called. Its purpose is to prevent
734 print_output_debug_flag from being optimized away. */
735
736 extern void debug_output_compilation_hack (int) EXTERNALLY_VISIBLE;
737 void
738 debug_output_compilation_hack (int x)
739 {
740 print_output_debug_flag = x;
741 }
742
743 #if defined (GNU_LINUX)
744
745 /* This functionality is not vitally important in general, so we rely on
746 non-portable ability to use stderr as lvalue. */
747
748 #define WITH_REDIRECT_DEBUGGING_OUTPUT 1
749
750 static FILE *initial_stderr_stream = NULL;
751
752 DEFUN ("redirect-debugging-output", Fredirect_debugging_output, Sredirect_debugging_output,
753 1, 2,
754 "FDebug output file: \nP",
755 doc: /* Redirect debugging output (stderr stream) to file FILE.
756 If FILE is nil, reset target to the initial stderr stream.
757 Optional arg APPEND non-nil (interactively, with prefix arg) means
758 append to existing target file. */)
759 (Lisp_Object file, Lisp_Object append)
760 {
761 if (initial_stderr_stream != NULL)
762 {
763 BLOCK_INPUT;
764 fclose (stderr);
765 UNBLOCK_INPUT;
766 }
767 stderr = initial_stderr_stream;
768 initial_stderr_stream = NULL;
769
770 if (STRINGP (file))
771 {
772 file = Fexpand_file_name (file, Qnil);
773 initial_stderr_stream = stderr;
774 stderr = fopen (SSDATA (file), NILP (append) ? "w" : "a");
775 if (stderr == NULL)
776 {
777 stderr = initial_stderr_stream;
778 initial_stderr_stream = NULL;
779 report_file_error ("Cannot open debugging output stream",
780 Fcons (file, Qnil));
781 }
782 }
783 return Qnil;
784 }
785 #endif /* GNU_LINUX */
786
787
788 /* This is the interface for debugging printing. */
789
790 void
791 debug_print (Lisp_Object arg)
792 {
793 Fprin1 (arg, Qexternal_debugging_output);
794 fprintf (stderr, "\r\n");
795 }
796
797 void safe_debug_print (Lisp_Object) EXTERNALLY_VISIBLE;
798 void
799 safe_debug_print (Lisp_Object arg)
800 {
801 int valid = valid_lisp_object_p (arg);
802
803 if (valid > 0)
804 debug_print (arg);
805 else
806 fprintf (stderr, "#<%s_LISP_OBJECT 0x%08"pI"x>\r\n",
807 !valid ? "INVALID" : "SOME",
808 XHASH (arg));
809 }
810
811 \f
812 DEFUN ("error-message-string", Ferror_message_string, Serror_message_string,
813 1, 1, 0,
814 doc: /* Convert an error value (ERROR-SYMBOL . DATA) to an error message.
815 See Info anchor `(elisp)Definition of signal' for some details on how this
816 error message is constructed. */)
817 (Lisp_Object obj)
818 {
819 struct buffer *old = current_buffer;
820 Lisp_Object value;
821 struct gcpro gcpro1;
822
823 /* If OBJ is (error STRING), just return STRING.
824 That is not only faster, it also avoids the need to allocate
825 space here when the error is due to memory full. */
826 if (CONSP (obj) && EQ (XCAR (obj), Qerror)
827 && CONSP (XCDR (obj))
828 && STRINGP (XCAR (XCDR (obj)))
829 && NILP (XCDR (XCDR (obj))))
830 return XCAR (XCDR (obj));
831
832 print_error_message (obj, Vprin1_to_string_buffer, 0, Qnil);
833
834 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
835 value = Fbuffer_string ();
836
837 GCPRO1 (value);
838 Ferase_buffer ();
839 set_buffer_internal (old);
840 UNGCPRO;
841
842 return value;
843 }
844
845 /* Print an error message for the error DATA onto Lisp output stream
846 STREAM (suitable for the print functions).
847 CONTEXT is a C string describing the context of the error.
848 CALLER is the Lisp function inside which the error was signaled. */
849
850 void
851 print_error_message (Lisp_Object data, Lisp_Object stream, const char *context,
852 Lisp_Object caller)
853 {
854 Lisp_Object errname, errmsg, file_error, tail;
855 struct gcpro gcpro1;
856
857 if (context != 0)
858 write_string_1 (context, -1, stream);
859
860 /* If we know from where the error was signaled, show it in
861 *Messages*. */
862 if (!NILP (caller) && SYMBOLP (caller))
863 {
864 Lisp_Object cname = SYMBOL_NAME (caller);
865 ptrdiff_t cnamelen = SBYTES (cname);
866 USE_SAFE_ALLOCA;
867 char *name = SAFE_ALLOCA (cnamelen);
868 memcpy (name, SDATA (cname), cnamelen);
869 message_dolog (name, cnamelen, 0, 0);
870 message_dolog (": ", 2, 0, 0);
871 SAFE_FREE ();
872 }
873
874 errname = Fcar (data);
875
876 if (EQ (errname, Qerror))
877 {
878 data = Fcdr (data);
879 if (!CONSP (data))
880 data = Qnil;
881 errmsg = Fcar (data);
882 file_error = Qnil;
883 }
884 else
885 {
886 Lisp_Object error_conditions = Fget (errname, Qerror_conditions);
887 errmsg = Fget (errname, Qerror_message);
888 file_error = Fmemq (Qfile_error, error_conditions);
889 }
890
891 /* Print an error message including the data items. */
892
893 tail = Fcdr_safe (data);
894 GCPRO1 (tail);
895
896 /* For file-error, make error message by concatenating
897 all the data items. They are all strings. */
898 if (!NILP (file_error) && CONSP (tail))
899 errmsg = XCAR (tail), tail = XCDR (tail);
900
901 {
902 const char *sep = ": ";
903
904 if (!STRINGP (errmsg))
905 write_string_1 ("peculiar error", -1, stream);
906 else if (SCHARS (errmsg))
907 Fprinc (errmsg, stream);
908 else
909 sep = NULL;
910
911 for (; CONSP (tail); tail = XCDR (tail), sep = ", ")
912 {
913 Lisp_Object obj;
914
915 if (sep)
916 write_string_1 (sep, 2, stream);
917 obj = XCAR (tail);
918 if (!NILP (file_error)
919 || EQ (errname, Qend_of_file) || EQ (errname, Quser_error))
920 Fprinc (obj, stream);
921 else
922 Fprin1 (obj, stream);
923 }
924 }
925
926 UNGCPRO;
927 }
928
929
930 \f
931 /*
932 * The buffer should be at least as large as the max string size of the
933 * largest float, printed in the biggest notation. This is undoubtedly
934 * 20d float_output_format, with the negative of the C-constant "HUGE"
935 * from <math.h>.
936 *
937 * On the vax the worst case is -1e38 in 20d format which takes 61 bytes.
938 *
939 * I assume that IEEE-754 format numbers can take 329 bytes for the worst
940 * case of -1e307 in 20d float_output_format. What is one to do (short of
941 * re-writing _doprnt to be more sane)?
942 * -wsr
943 * Given the above, the buffer must be least FLOAT_TO_STRING_BUFSIZE bytes.
944 */
945
946 int
947 float_to_string (char *buf, double data)
948 {
949 char *cp;
950 int width;
951 int len;
952
953 /* Check for plus infinity in a way that won't lose
954 if there is no plus infinity. */
955 if (data == data / 2 && data > 1.0)
956 {
957 static char const infinity_string[] = "1.0e+INF";
958 strcpy (buf, infinity_string);
959 return sizeof infinity_string - 1;
960 }
961 /* Likewise for minus infinity. */
962 if (data == data / 2 && data < -1.0)
963 {
964 static char const minus_infinity_string[] = "-1.0e+INF";
965 strcpy (buf, minus_infinity_string);
966 return sizeof minus_infinity_string - 1;
967 }
968 /* Check for NaN in a way that won't fail if there are no NaNs. */
969 if (! (data * 0.0 >= 0.0))
970 {
971 /* Prepend "-" if the NaN's sign bit is negative.
972 The sign bit of a double is the bit that is 1 in -0.0. */
973 static char const NaN_string[] = "0.0e+NaN";
974 int i;
975 union { double d; char c[sizeof (double)]; } u_data, u_minus_zero;
976 int negative = 0;
977 u_data.d = data;
978 u_minus_zero.d = - 0.0;
979 for (i = 0; i < sizeof (double); i++)
980 if (u_data.c[i] & u_minus_zero.c[i])
981 {
982 *buf = '-';
983 negative = 1;
984 break;
985 }
986
987 strcpy (buf + negative, NaN_string);
988 return negative + sizeof NaN_string - 1;
989 }
990
991 if (NILP (Vfloat_output_format)
992 || !STRINGP (Vfloat_output_format))
993 lose:
994 {
995 /* Generate the fewest number of digits that represent the
996 floating point value without losing information. */
997 len = dtoastr (buf, FLOAT_TO_STRING_BUFSIZE - 2, 0, 0, data);
998 /* The decimal point must be printed, or the byte compiler can
999 get confused (Bug#8033). */
1000 width = 1;
1001 }
1002 else /* oink oink */
1003 {
1004 /* Check that the spec we have is fully valid.
1005 This means not only valid for printf,
1006 but meant for floats, and reasonable. */
1007 cp = SSDATA (Vfloat_output_format);
1008
1009 if (cp[0] != '%')
1010 goto lose;
1011 if (cp[1] != '.')
1012 goto lose;
1013
1014 cp += 2;
1015
1016 /* Check the width specification. */
1017 width = -1;
1018 if ('0' <= *cp && *cp <= '9')
1019 {
1020 width = 0;
1021 do
1022 {
1023 width = (width * 10) + (*cp++ - '0');
1024 if (DBL_DIG < width)
1025 goto lose;
1026 }
1027 while (*cp >= '0' && *cp <= '9');
1028
1029 /* A precision of zero is valid only for %f. */
1030 if (width == 0 && *cp != 'f')
1031 goto lose;
1032 }
1033
1034 if (*cp != 'e' && *cp != 'f' && *cp != 'g')
1035 goto lose;
1036
1037 if (cp[1] != 0)
1038 goto lose;
1039
1040 len = sprintf (buf, SSDATA (Vfloat_output_format), data);
1041 }
1042
1043 /* Make sure there is a decimal point with digit after, or an
1044 exponent, so that the value is readable as a float. But don't do
1045 this with "%.0f"; it's valid for that not to produce a decimal
1046 point. Note that width can be 0 only for %.0f. */
1047 if (width != 0)
1048 {
1049 for (cp = buf; *cp; cp++)
1050 if ((*cp < '0' || *cp > '9') && *cp != '-')
1051 break;
1052
1053 if (*cp == '.' && cp[1] == 0)
1054 {
1055 cp[1] = '0';
1056 cp[2] = 0;
1057 len++;
1058 }
1059 else if (*cp == 0)
1060 {
1061 *cp++ = '.';
1062 *cp++ = '0';
1063 *cp++ = 0;
1064 len += 2;
1065 }
1066 }
1067
1068 return len;
1069 }
1070
1071 \f
1072 static void
1073 print (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag)
1074 {
1075 new_backquote_output = 0;
1076
1077 /* Reset print_number_index and Vprint_number_table only when
1078 the variable Vprint_continuous_numbering is nil. Otherwise,
1079 the values of these variables will be kept between several
1080 print functions. */
1081 if (NILP (Vprint_continuous_numbering)
1082 || NILP (Vprint_number_table))
1083 {
1084 print_number_index = 0;
1085 Vprint_number_table = Qnil;
1086 }
1087
1088 /* Construct Vprint_number_table for print-gensym and print-circle. */
1089 if (!NILP (Vprint_gensym) || !NILP (Vprint_circle))
1090 {
1091 /* Construct Vprint_number_table.
1092 This increments print_number_index for the objects added. */
1093 print_depth = 0;
1094 print_preprocess (obj);
1095
1096 if (HASH_TABLE_P (Vprint_number_table))
1097 { /* Remove unnecessary objects, which appear only once in OBJ;
1098 that is, whose status is Qt. */
1099 struct Lisp_Hash_Table *h = XHASH_TABLE (Vprint_number_table);
1100 ptrdiff_t i;
1101
1102 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1103 if (!NILP (HASH_HASH (h, i))
1104 && EQ (HASH_VALUE (h, i), Qt))
1105 Fremhash (HASH_KEY (h, i), Vprint_number_table);
1106 }
1107 }
1108
1109 print_depth = 0;
1110 print_object (obj, printcharfun, escapeflag);
1111 }
1112
1113 #define PRINT_CIRCLE_CANDIDATE_P(obj) \
1114 (STRINGP (obj) || CONSP (obj) \
1115 || (VECTORLIKEP (obj) \
1116 && (VECTORP (obj) || COMPILEDP (obj) \
1117 || CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj) \
1118 || HASH_TABLE_P (obj) || FONTP (obj))) \
1119 || (! NILP (Vprint_gensym) \
1120 && SYMBOLP (obj) \
1121 && !SYMBOL_INTERNED_P (obj)))
1122
1123 /* Construct Vprint_number_table according to the structure of OBJ.
1124 OBJ itself and all its elements will be added to Vprint_number_table
1125 recursively if it is a list, vector, compiled function, char-table,
1126 string (its text properties will be traced), or a symbol that has
1127 no obarray (this is for the print-gensym feature).
1128 The status fields of Vprint_number_table mean whether each object appears
1129 more than once in OBJ: Qnil at the first time, and Qt after that . */
1130 static void
1131 print_preprocess (Lisp_Object obj)
1132 {
1133 int i;
1134 ptrdiff_t size;
1135 int loop_count = 0;
1136 Lisp_Object halftail;
1137
1138 /* Avoid infinite recursion for circular nested structure
1139 in the case where Vprint_circle is nil. */
1140 if (NILP (Vprint_circle))
1141 {
1142 /* Give up if we go so deep that print_object will get an error. */
1143 /* See similar code in print_object. */
1144 if (print_depth >= PRINT_CIRCLE)
1145 error ("Apparently circular structure being printed");
1146
1147 for (i = 0; i < print_depth; i++)
1148 if (EQ (obj, being_printed[i]))
1149 return;
1150 being_printed[print_depth] = obj;
1151 }
1152
1153 print_depth++;
1154 halftail = obj;
1155
1156 loop:
1157 if (PRINT_CIRCLE_CANDIDATE_P (obj))
1158 {
1159 if (!HASH_TABLE_P (Vprint_number_table))
1160 {
1161 Lisp_Object args[2];
1162 args[0] = QCtest;
1163 args[1] = Qeq;
1164 Vprint_number_table = Fmake_hash_table (2, args);
1165 }
1166
1167 /* In case print-circle is nil and print-gensym is t,
1168 add OBJ to Vprint_number_table only when OBJ is a symbol. */
1169 if (! NILP (Vprint_circle) || SYMBOLP (obj))
1170 {
1171 Lisp_Object num = Fgethash (obj, Vprint_number_table, Qnil);
1172 if (!NILP (num)
1173 /* If Vprint_continuous_numbering is non-nil and OBJ is a gensym,
1174 always print the gensym with a number. This is a special for
1175 the lisp function byte-compile-output-docform. */
1176 || (!NILP (Vprint_continuous_numbering)
1177 && SYMBOLP (obj)
1178 && !SYMBOL_INTERNED_P (obj)))
1179 { /* OBJ appears more than once. Let's remember that. */
1180 if (!INTEGERP (num))
1181 {
1182 print_number_index++;
1183 /* Negative number indicates it hasn't been printed yet. */
1184 Fputhash (obj, make_number (- print_number_index),
1185 Vprint_number_table);
1186 }
1187 print_depth--;
1188 return;
1189 }
1190 else
1191 /* OBJ is not yet recorded. Let's add to the table. */
1192 Fputhash (obj, Qt, Vprint_number_table);
1193 }
1194
1195 switch (XTYPE (obj))
1196 {
1197 case Lisp_String:
1198 /* A string may have text properties, which can be circular. */
1199 traverse_intervals_noorder (string_intervals (obj),
1200 print_preprocess_string, Qnil);
1201 break;
1202
1203 case Lisp_Cons:
1204 /* Use HALFTAIL and LOOP_COUNT to detect circular lists,
1205 just as in print_object. */
1206 if (loop_count && EQ (obj, halftail))
1207 break;
1208 print_preprocess (XCAR (obj));
1209 obj = XCDR (obj);
1210 loop_count++;
1211 if (!(loop_count & 1))
1212 halftail = XCDR (halftail);
1213 goto loop;
1214
1215 case Lisp_Vectorlike:
1216 size = ASIZE (obj);
1217 if (size & PSEUDOVECTOR_FLAG)
1218 size &= PSEUDOVECTOR_SIZE_MASK;
1219 for (i = 0; i < size; i++)
1220 print_preprocess (AREF (obj, i));
1221 if (HASH_TABLE_P (obj))
1222 { /* For hash tables, the key_and_value slot is past
1223 `size' because it needs to be marked specially in case
1224 the table is weak. */
1225 struct Lisp_Hash_Table *h = XHASH_TABLE (obj);
1226 print_preprocess (h->key_and_value);
1227 }
1228 break;
1229
1230 default:
1231 break;
1232 }
1233 }
1234 print_depth--;
1235 }
1236
1237 static void
1238 print_preprocess_string (INTERVAL interval, Lisp_Object arg)
1239 {
1240 print_preprocess (interval->plist);
1241 }
1242
1243 static void print_check_string_charset_prop (INTERVAL interval, Lisp_Object string);
1244
1245 #define PRINT_STRING_NON_CHARSET_FOUND 1
1246 #define PRINT_STRING_UNSAFE_CHARSET_FOUND 2
1247
1248 /* Bitwise or of the above macros. */
1249 static int print_check_string_result;
1250
1251 static void
1252 print_check_string_charset_prop (INTERVAL interval, Lisp_Object string)
1253 {
1254 Lisp_Object val;
1255
1256 if (NILP (interval->plist)
1257 || (print_check_string_result == (PRINT_STRING_NON_CHARSET_FOUND
1258 | PRINT_STRING_UNSAFE_CHARSET_FOUND)))
1259 return;
1260 for (val = interval->plist; CONSP (val) && ! EQ (XCAR (val), Qcharset);
1261 val = XCDR (XCDR (val)));
1262 if (! CONSP (val))
1263 {
1264 print_check_string_result |= PRINT_STRING_NON_CHARSET_FOUND;
1265 return;
1266 }
1267 if (! (print_check_string_result & PRINT_STRING_NON_CHARSET_FOUND))
1268 {
1269 if (! EQ (val, interval->plist)
1270 || CONSP (XCDR (XCDR (val))))
1271 print_check_string_result |= PRINT_STRING_NON_CHARSET_FOUND;
1272 }
1273 if (NILP (Vprint_charset_text_property)
1274 || ! (print_check_string_result & PRINT_STRING_UNSAFE_CHARSET_FOUND))
1275 {
1276 int i, c;
1277 ptrdiff_t charpos = interval->position;
1278 ptrdiff_t bytepos = string_char_to_byte (string, charpos);
1279 Lisp_Object charset;
1280
1281 charset = XCAR (XCDR (val));
1282 for (i = 0; i < LENGTH (interval); i++)
1283 {
1284 FETCH_STRING_CHAR_ADVANCE (c, string, charpos, bytepos);
1285 if (! ASCII_CHAR_P (c)
1286 && ! EQ (CHARSET_NAME (CHAR_CHARSET (c)), charset))
1287 {
1288 print_check_string_result |= PRINT_STRING_UNSAFE_CHARSET_FOUND;
1289 break;
1290 }
1291 }
1292 }
1293 }
1294
1295 /* The value is (charset . nil). */
1296 static Lisp_Object print_prune_charset_plist;
1297
1298 static Lisp_Object
1299 print_prune_string_charset (Lisp_Object string)
1300 {
1301 print_check_string_result = 0;
1302 traverse_intervals (string_intervals (string), 0,
1303 print_check_string_charset_prop, string);
1304 if (! (print_check_string_result & PRINT_STRING_UNSAFE_CHARSET_FOUND))
1305 {
1306 string = Fcopy_sequence (string);
1307 if (print_check_string_result & PRINT_STRING_NON_CHARSET_FOUND)
1308 {
1309 if (NILP (print_prune_charset_plist))
1310 print_prune_charset_plist = Fcons (Qcharset, Qnil);
1311 Fremove_text_properties (make_number (0),
1312 make_number (SCHARS (string)),
1313 print_prune_charset_plist, string);
1314 }
1315 else
1316 Fset_text_properties (make_number (0), make_number (SCHARS (string)),
1317 Qnil, string);
1318 }
1319 return string;
1320 }
1321
1322 static void
1323 print_object (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag)
1324 {
1325 char buf[max (sizeof "from..to..in " + 2 * INT_STRLEN_BOUND (EMACS_INT),
1326 max (sizeof " . #" + INT_STRLEN_BOUND (printmax_t),
1327 40))];
1328
1329 QUIT;
1330
1331 /* Detect circularities and truncate them. */
1332 if (NILP (Vprint_circle))
1333 {
1334 /* Simple but incomplete way. */
1335 int i;
1336
1337 /* See similar code in print_preprocess. */
1338 if (print_depth >= PRINT_CIRCLE)
1339 error ("Apparently circular structure being printed");
1340
1341 for (i = 0; i < print_depth; i++)
1342 if (EQ (obj, being_printed[i]))
1343 {
1344 int len = sprintf (buf, "#%d", i);
1345 strout (buf, len, len, printcharfun);
1346 return;
1347 }
1348 being_printed[print_depth] = obj;
1349 }
1350 else if (PRINT_CIRCLE_CANDIDATE_P (obj))
1351 {
1352 /* With the print-circle feature. */
1353 Lisp_Object num = Fgethash (obj, Vprint_number_table, Qnil);
1354 if (INTEGERP (num))
1355 {
1356 EMACS_INT n = XINT (num);
1357 if (n < 0)
1358 { /* Add a prefix #n= if OBJ has not yet been printed;
1359 that is, its status field is nil. */
1360 int len = sprintf (buf, "#%"pI"d=", -n);
1361 strout (buf, len, len, printcharfun);
1362 /* OBJ is going to be printed. Remember that fact. */
1363 Fputhash (obj, make_number (- n), Vprint_number_table);
1364 }
1365 else
1366 {
1367 /* Just print #n# if OBJ has already been printed. */
1368 int len = sprintf (buf, "#%"pI"d#", n);
1369 strout (buf, len, len, printcharfun);
1370 return;
1371 }
1372 }
1373 }
1374
1375 print_depth++;
1376
1377 switch (XTYPE (obj))
1378 {
1379 case_Lisp_Int:
1380 {
1381 int len = sprintf (buf, "%"pI"d", XINT (obj));
1382 strout (buf, len, len, printcharfun);
1383 }
1384 break;
1385
1386 case Lisp_Float:
1387 {
1388 char pigbuf[FLOAT_TO_STRING_BUFSIZE];
1389 int len = float_to_string (pigbuf, XFLOAT_DATA (obj));
1390 strout (pigbuf, len, len, printcharfun);
1391 }
1392 break;
1393
1394 case Lisp_String:
1395 if (!escapeflag)
1396 print_string (obj, printcharfun);
1397 else
1398 {
1399 register ptrdiff_t i_byte;
1400 struct gcpro gcpro1;
1401 unsigned char *str;
1402 ptrdiff_t size_byte;
1403 /* 1 means we must ensure that the next character we output
1404 cannot be taken as part of a hex character escape. */
1405 int need_nonhex = 0;
1406 int multibyte = STRING_MULTIBYTE (obj);
1407
1408 GCPRO1 (obj);
1409
1410 if (! EQ (Vprint_charset_text_property, Qt))
1411 obj = print_prune_string_charset (obj);
1412
1413 if (string_intervals (obj))
1414 {
1415 PRINTCHAR ('#');
1416 PRINTCHAR ('(');
1417 }
1418
1419 PRINTCHAR ('\"');
1420 str = SDATA (obj);
1421 size_byte = SBYTES (obj);
1422
1423 for (i_byte = 0; i_byte < size_byte;)
1424 {
1425 /* Here, we must convert each multi-byte form to the
1426 corresponding character code before handing it to PRINTCHAR. */
1427 int len;
1428 int c;
1429
1430 if (multibyte)
1431 {
1432 c = STRING_CHAR_AND_LENGTH (str + i_byte, len);
1433 i_byte += len;
1434 }
1435 else
1436 c = str[i_byte++];
1437
1438 QUIT;
1439
1440 if (c == '\n' && print_escape_newlines)
1441 {
1442 PRINTCHAR ('\\');
1443 PRINTCHAR ('n');
1444 }
1445 else if (c == '\f' && print_escape_newlines)
1446 {
1447 PRINTCHAR ('\\');
1448 PRINTCHAR ('f');
1449 }
1450 else if (multibyte
1451 && (CHAR_BYTE8_P (c)
1452 || (! ASCII_CHAR_P (c) && print_escape_multibyte)))
1453 {
1454 /* When multibyte is disabled,
1455 print multibyte string chars using hex escapes.
1456 For a char code that could be in a unibyte string,
1457 when found in a multibyte string, always use a hex escape
1458 so it reads back as multibyte. */
1459 char outbuf[50];
1460 int len;
1461
1462 if (CHAR_BYTE8_P (c))
1463 len = sprintf (outbuf, "\\%03o", CHAR_TO_BYTE8 (c));
1464 else
1465 {
1466 len = sprintf (outbuf, "\\x%04x", c);
1467 need_nonhex = 1;
1468 }
1469 strout (outbuf, len, len, printcharfun);
1470 }
1471 else if (! multibyte
1472 && SINGLE_BYTE_CHAR_P (c) && ! ASCII_BYTE_P (c)
1473 && print_escape_nonascii)
1474 {
1475 /* When printing in a multibyte buffer
1476 or when explicitly requested,
1477 print single-byte non-ASCII string chars
1478 using octal escapes. */
1479 char outbuf[5];
1480 int len = sprintf (outbuf, "\\%03o", c);
1481 strout (outbuf, len, len, printcharfun);
1482 }
1483 else
1484 {
1485 /* If we just had a hex escape, and this character
1486 could be taken as part of it,
1487 output `\ ' to prevent that. */
1488 if (need_nonhex)
1489 {
1490 need_nonhex = 0;
1491 if ((c >= 'a' && c <= 'f')
1492 || (c >= 'A' && c <= 'F')
1493 || (c >= '0' && c <= '9'))
1494 strout ("\\ ", -1, -1, printcharfun);
1495 }
1496
1497 if (c == '\"' || c == '\\')
1498 PRINTCHAR ('\\');
1499 PRINTCHAR (c);
1500 }
1501 }
1502 PRINTCHAR ('\"');
1503
1504 if (string_intervals (obj))
1505 {
1506 traverse_intervals (string_intervals (obj),
1507 0, print_interval, printcharfun);
1508 PRINTCHAR (')');
1509 }
1510
1511 UNGCPRO;
1512 }
1513 break;
1514
1515 case Lisp_Symbol:
1516 {
1517 register int confusing;
1518 register unsigned char *p = SDATA (SYMBOL_NAME (obj));
1519 register unsigned char *end = p + SBYTES (SYMBOL_NAME (obj));
1520 register int c;
1521 ptrdiff_t i, i_byte;
1522 ptrdiff_t size_byte;
1523 Lisp_Object name;
1524
1525 name = SYMBOL_NAME (obj);
1526
1527 if (p != end && (*p == '-' || *p == '+')) p++;
1528 if (p == end)
1529 confusing = 0;
1530 /* If symbol name begins with a digit, and ends with a digit,
1531 and contains nothing but digits and `e', it could be treated
1532 as a number. So set CONFUSING.
1533
1534 Symbols that contain periods could also be taken as numbers,
1535 but periods are always escaped, so we don't have to worry
1536 about them here. */
1537 else if (*p >= '0' && *p <= '9'
1538 && end[-1] >= '0' && end[-1] <= '9')
1539 {
1540 while (p != end && ((*p >= '0' && *p <= '9')
1541 /* Needed for \2e10. */
1542 || *p == 'e' || *p == 'E'))
1543 p++;
1544 confusing = (end == p);
1545 }
1546 else
1547 confusing = 0;
1548
1549 size_byte = SBYTES (name);
1550
1551 if (! NILP (Vprint_gensym) && !SYMBOL_INTERNED_P (obj))
1552 {
1553 PRINTCHAR ('#');
1554 PRINTCHAR (':');
1555 }
1556 else if (size_byte == 0)
1557 {
1558 PRINTCHAR ('#');
1559 PRINTCHAR ('#');
1560 break;
1561 }
1562
1563 for (i = 0, i_byte = 0; i_byte < size_byte;)
1564 {
1565 /* Here, we must convert each multi-byte form to the
1566 corresponding character code before handing it to PRINTCHAR. */
1567 FETCH_STRING_CHAR_ADVANCE (c, name, i, i_byte);
1568 QUIT;
1569
1570 if (escapeflag)
1571 {
1572 if (c == '\"' || c == '\\' || c == '\''
1573 || c == ';' || c == '#' || c == '(' || c == ')'
1574 || c == ',' || c == '.' || c == '`'
1575 || c == '[' || c == ']' || c == '?' || c <= 040
1576 || confusing)
1577 PRINTCHAR ('\\'), confusing = 0;
1578 }
1579 PRINTCHAR (c);
1580 }
1581 }
1582 break;
1583
1584 case Lisp_Cons:
1585 /* If deeper than spec'd depth, print placeholder. */
1586 if (INTEGERP (Vprint_level)
1587 && print_depth > XINT (Vprint_level))
1588 strout ("...", -1, -1, printcharfun);
1589 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1590 && (EQ (XCAR (obj), Qquote)))
1591 {
1592 PRINTCHAR ('\'');
1593 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1594 }
1595 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1596 && (EQ (XCAR (obj), Qfunction)))
1597 {
1598 PRINTCHAR ('#');
1599 PRINTCHAR ('\'');
1600 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1601 }
1602 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1603 && ((EQ (XCAR (obj), Qbackquote))))
1604 {
1605 print_object (XCAR (obj), printcharfun, 0);
1606 new_backquote_output++;
1607 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1608 new_backquote_output--;
1609 }
1610 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1611 && new_backquote_output
1612 && ((EQ (XCAR (obj), Qbackquote)
1613 || EQ (XCAR (obj), Qcomma)
1614 || EQ (XCAR (obj), Qcomma_at)
1615 || EQ (XCAR (obj), Qcomma_dot))))
1616 {
1617 print_object (XCAR (obj), printcharfun, 0);
1618 new_backquote_output--;
1619 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1620 new_backquote_output++;
1621 }
1622 else
1623 {
1624 PRINTCHAR ('(');
1625
1626 {
1627 printmax_t i, print_length;
1628 Lisp_Object halftail = obj;
1629
1630 /* Negative values of print-length are invalid in CL.
1631 Treat them like nil, as CMUCL does. */
1632 if (NATNUMP (Vprint_length))
1633 print_length = XFASTINT (Vprint_length);
1634 else
1635 print_length = TYPE_MAXIMUM (printmax_t);
1636
1637 i = 0;
1638 while (CONSP (obj))
1639 {
1640 /* Detect circular list. */
1641 if (NILP (Vprint_circle))
1642 {
1643 /* Simple but incomplete way. */
1644 if (i != 0 && EQ (obj, halftail))
1645 {
1646 int len = sprintf (buf, " . #%"pMd, i / 2);
1647 strout (buf, len, len, printcharfun);
1648 goto end_of_list;
1649 }
1650 }
1651 else
1652 {
1653 /* With the print-circle feature. */
1654 if (i != 0)
1655 {
1656 Lisp_Object num = Fgethash (obj, Vprint_number_table, Qnil);
1657 if (INTEGERP (num))
1658 {
1659 strout (" . ", 3, 3, printcharfun);
1660 print_object (obj, printcharfun, escapeflag);
1661 goto end_of_list;
1662 }
1663 }
1664 }
1665
1666 if (i)
1667 PRINTCHAR (' ');
1668
1669 if (print_length <= i)
1670 {
1671 strout ("...", 3, 3, printcharfun);
1672 goto end_of_list;
1673 }
1674
1675 i++;
1676 print_object (XCAR (obj), printcharfun, escapeflag);
1677
1678 obj = XCDR (obj);
1679 if (!(i & 1))
1680 halftail = XCDR (halftail);
1681 }
1682 }
1683
1684 /* OBJ non-nil here means it's the end of a dotted list. */
1685 if (!NILP (obj))
1686 {
1687 strout (" . ", 3, 3, printcharfun);
1688 print_object (obj, printcharfun, escapeflag);
1689 }
1690
1691 end_of_list:
1692 PRINTCHAR (')');
1693 }
1694 break;
1695
1696 case Lisp_Vectorlike:
1697 if (PROCESSP (obj))
1698 {
1699 if (escapeflag)
1700 {
1701 strout ("#<process ", -1, -1, printcharfun);
1702 print_string (XPROCESS (obj)->name, printcharfun);
1703 PRINTCHAR ('>');
1704 }
1705 else
1706 print_string (XPROCESS (obj)->name, printcharfun);
1707 }
1708 else if (BOOL_VECTOR_P (obj))
1709 {
1710 ptrdiff_t i;
1711 int len;
1712 unsigned char c;
1713 struct gcpro gcpro1;
1714 ptrdiff_t size_in_chars
1715 = ((XBOOL_VECTOR (obj)->size + BOOL_VECTOR_BITS_PER_CHAR - 1)
1716 / BOOL_VECTOR_BITS_PER_CHAR);
1717
1718 GCPRO1 (obj);
1719
1720 PRINTCHAR ('#');
1721 PRINTCHAR ('&');
1722 len = sprintf (buf, "%"pI"d", XBOOL_VECTOR (obj)->size);
1723 strout (buf, len, len, printcharfun);
1724 PRINTCHAR ('\"');
1725
1726 /* Don't print more characters than the specified maximum.
1727 Negative values of print-length are invalid. Treat them
1728 like a print-length of nil. */
1729 if (NATNUMP (Vprint_length)
1730 && XFASTINT (Vprint_length) < size_in_chars)
1731 size_in_chars = XFASTINT (Vprint_length);
1732
1733 for (i = 0; i < size_in_chars; i++)
1734 {
1735 QUIT;
1736 c = XBOOL_VECTOR (obj)->data[i];
1737 if (c == '\n' && print_escape_newlines)
1738 {
1739 PRINTCHAR ('\\');
1740 PRINTCHAR ('n');
1741 }
1742 else if (c == '\f' && print_escape_newlines)
1743 {
1744 PRINTCHAR ('\\');
1745 PRINTCHAR ('f');
1746 }
1747 else if (c > '\177')
1748 {
1749 /* Use octal escapes to avoid encoding issues. */
1750 PRINTCHAR ('\\');
1751 PRINTCHAR ('0' + ((c >> 6) & 3));
1752 PRINTCHAR ('0' + ((c >> 3) & 7));
1753 PRINTCHAR ('0' + (c & 7));
1754 }
1755 else
1756 {
1757 if (c == '\"' || c == '\\')
1758 PRINTCHAR ('\\');
1759 PRINTCHAR (c);
1760 }
1761 }
1762 PRINTCHAR ('\"');
1763
1764 UNGCPRO;
1765 }
1766 else if (SUBRP (obj))
1767 {
1768 strout ("#<subr ", -1, -1, printcharfun);
1769 strout (XSUBR (obj)->symbol_name, -1, -1, printcharfun);
1770 PRINTCHAR ('>');
1771 }
1772 else if (WINDOWP (obj))
1773 {
1774 int len;
1775 strout ("#<window ", -1, -1, printcharfun);
1776 len = sprintf (buf, "%d", XWINDOW (obj)->sequence_number);
1777 strout (buf, len, len, printcharfun);
1778 if (!NILP (XWINDOW (obj)->buffer))
1779 {
1780 strout (" on ", -1, -1, printcharfun);
1781 print_string (BVAR (XBUFFER (XWINDOW (obj)->buffer), name),
1782 printcharfun);
1783 }
1784 PRINTCHAR ('>');
1785 }
1786 else if (TERMINALP (obj))
1787 {
1788 int len;
1789 struct terminal *t = XTERMINAL (obj);
1790 strout ("#<terminal ", -1, -1, printcharfun);
1791 len = sprintf (buf, "%d", t->id);
1792 strout (buf, len, len, printcharfun);
1793 if (t->name)
1794 {
1795 strout (" on ", -1, -1, printcharfun);
1796 strout (t->name, -1, -1, printcharfun);
1797 }
1798 PRINTCHAR ('>');
1799 }
1800 else if (HASH_TABLE_P (obj))
1801 {
1802 struct Lisp_Hash_Table *h = XHASH_TABLE (obj);
1803 ptrdiff_t i;
1804 ptrdiff_t real_size, size;
1805 int len;
1806 #if 0
1807 strout ("#<hash-table", -1, -1, printcharfun);
1808 if (SYMBOLP (h->test))
1809 {
1810 PRINTCHAR (' ');
1811 PRINTCHAR ('\'');
1812 strout (SDATA (SYMBOL_NAME (h->test)), -1, -1, printcharfun);
1813 PRINTCHAR (' ');
1814 strout (SDATA (SYMBOL_NAME (h->weak)), -1, -1, printcharfun);
1815 PRINTCHAR (' ');
1816 len = sprintf (buf, "%"pD"d/%"pD"d", h->count, ASIZE (h->next));
1817 strout (buf, len, len, printcharfun);
1818 }
1819 len = sprintf (buf, " %p", h);
1820 strout (buf, len, len, printcharfun);
1821 PRINTCHAR ('>');
1822 #endif
1823 /* Implement a readable output, e.g.:
1824 #s(hash-table size 2 test equal data (k1 v1 k2 v2)) */
1825 /* Always print the size. */
1826 len = sprintf (buf, "#s(hash-table size %"pD"d", ASIZE (h->next));
1827 strout (buf, len, len, printcharfun);
1828
1829 if (!NILP (h->test))
1830 {
1831 strout (" test ", -1, -1, printcharfun);
1832 print_object (h->test, printcharfun, escapeflag);
1833 }
1834
1835 if (!NILP (h->weak))
1836 {
1837 strout (" weakness ", -1, -1, printcharfun);
1838 print_object (h->weak, printcharfun, escapeflag);
1839 }
1840
1841 if (!NILP (h->rehash_size))
1842 {
1843 strout (" rehash-size ", -1, -1, printcharfun);
1844 print_object (h->rehash_size, printcharfun, escapeflag);
1845 }
1846
1847 if (!NILP (h->rehash_threshold))
1848 {
1849 strout (" rehash-threshold ", -1, -1, printcharfun);
1850 print_object (h->rehash_threshold, printcharfun, escapeflag);
1851 }
1852
1853 strout (" data ", -1, -1, printcharfun);
1854
1855 /* Print the data here as a plist. */
1856 real_size = HASH_TABLE_SIZE (h);
1857 size = real_size;
1858
1859 /* Don't print more elements than the specified maximum. */
1860 if (NATNUMP (Vprint_length)
1861 && XFASTINT (Vprint_length) < size)
1862 size = XFASTINT (Vprint_length);
1863
1864 PRINTCHAR ('(');
1865 for (i = 0; i < size; i++)
1866 if (!NILP (HASH_HASH (h, i)))
1867 {
1868 if (i) PRINTCHAR (' ');
1869 print_object (HASH_KEY (h, i), printcharfun, escapeflag);
1870 PRINTCHAR (' ');
1871 print_object (HASH_VALUE (h, i), printcharfun, escapeflag);
1872 }
1873
1874 if (size < real_size)
1875 strout (" ...", 4, 4, printcharfun);
1876
1877 PRINTCHAR (')');
1878 PRINTCHAR (')');
1879
1880 }
1881 else if (BUFFERP (obj))
1882 {
1883 if (NILP (BVAR (XBUFFER (obj), name)))
1884 strout ("#<killed buffer>", -1, -1, printcharfun);
1885 else if (escapeflag)
1886 {
1887 strout ("#<buffer ", -1, -1, printcharfun);
1888 print_string (BVAR (XBUFFER (obj), name), printcharfun);
1889 PRINTCHAR ('>');
1890 }
1891 else
1892 print_string (BVAR (XBUFFER (obj), name), printcharfun);
1893 }
1894 else if (WINDOW_CONFIGURATIONP (obj))
1895 {
1896 strout ("#<window-configuration>", -1, -1, printcharfun);
1897 }
1898 else if (FRAMEP (obj))
1899 {
1900 int len;
1901 Lisp_Object frame_name = XFRAME (obj)->name;
1902
1903 strout ((FRAME_LIVE_P (XFRAME (obj))
1904 ? "#<frame " : "#<dead frame "),
1905 -1, -1, printcharfun);
1906 if (!STRINGP (frame_name))
1907 {
1908 /* A frame could be too young and have no name yet;
1909 don't crash. */
1910 if (SYMBOLP (frame_name))
1911 frame_name = Fsymbol_name (frame_name);
1912 else /* can't happen: name should be either nil or string */
1913 frame_name = build_string ("*INVALID*FRAME*NAME*");
1914 }
1915 print_string (frame_name, printcharfun);
1916 len = sprintf (buf, " %p", XFRAME (obj));
1917 strout (buf, len, len, printcharfun);
1918 PRINTCHAR ('>');
1919 }
1920 else if (FONTP (obj))
1921 {
1922 int i;
1923
1924 if (! FONT_OBJECT_P (obj))
1925 {
1926 if (FONT_SPEC_P (obj))
1927 strout ("#<font-spec", -1, -1, printcharfun);
1928 else
1929 strout ("#<font-entity", -1, -1, printcharfun);
1930 for (i = 0; i < FONT_SPEC_MAX; i++)
1931 {
1932 PRINTCHAR (' ');
1933 if (i < FONT_WEIGHT_INDEX || i > FONT_WIDTH_INDEX)
1934 print_object (AREF (obj, i), printcharfun, escapeflag);
1935 else
1936 print_object (font_style_symbolic (obj, i, 0),
1937 printcharfun, escapeflag);
1938 }
1939 }
1940 else
1941 {
1942 strout ("#<font-object ", -1, -1, printcharfun);
1943 print_object (AREF (obj, FONT_NAME_INDEX), printcharfun,
1944 escapeflag);
1945 }
1946 PRINTCHAR ('>');
1947 }
1948 else
1949 {
1950 ptrdiff_t size = ASIZE (obj);
1951 if (COMPILEDP (obj))
1952 {
1953 PRINTCHAR ('#');
1954 size &= PSEUDOVECTOR_SIZE_MASK;
1955 }
1956 if (CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj))
1957 {
1958 /* We print a char-table as if it were a vector,
1959 lumping the parent and default slots in with the
1960 character slots. But we add #^ as a prefix. */
1961
1962 /* Make each lowest sub_char_table start a new line.
1963 Otherwise we'll make a line extremely long, which
1964 results in slow redisplay. */
1965 if (SUB_CHAR_TABLE_P (obj)
1966 && XINT (XSUB_CHAR_TABLE (obj)->depth) == 3)
1967 PRINTCHAR ('\n');
1968 PRINTCHAR ('#');
1969 PRINTCHAR ('^');
1970 if (SUB_CHAR_TABLE_P (obj))
1971 PRINTCHAR ('^');
1972 size &= PSEUDOVECTOR_SIZE_MASK;
1973 }
1974 if (size & PSEUDOVECTOR_FLAG)
1975 goto badtype;
1976
1977 PRINTCHAR ('[');
1978 {
1979 register int i;
1980 register Lisp_Object tem;
1981 ptrdiff_t real_size = size;
1982
1983 /* Don't print more elements than the specified maximum. */
1984 if (NATNUMP (Vprint_length)
1985 && XFASTINT (Vprint_length) < size)
1986 size = XFASTINT (Vprint_length);
1987
1988 for (i = 0; i < size; i++)
1989 {
1990 if (i) PRINTCHAR (' ');
1991 tem = AREF (obj, i);
1992 print_object (tem, printcharfun, escapeflag);
1993 }
1994 if (size < real_size)
1995 strout (" ...", 4, 4, printcharfun);
1996 }
1997 PRINTCHAR (']');
1998 }
1999 break;
2000
2001 case Lisp_Misc:
2002 switch (XMISCTYPE (obj))
2003 {
2004 case Lisp_Misc_Marker:
2005 strout ("#<marker ", -1, -1, printcharfun);
2006 /* Do you think this is necessary? */
2007 if (XMARKER (obj)->insertion_type != 0)
2008 strout ("(moves after insertion) ", -1, -1, printcharfun);
2009 if (! XMARKER (obj)->buffer)
2010 strout ("in no buffer", -1, -1, printcharfun);
2011 else
2012 {
2013 int len = sprintf (buf, "at %"pD"d", marker_position (obj));
2014 strout (buf, len, len, printcharfun);
2015 strout (" in ", -1, -1, printcharfun);
2016 print_string (BVAR (XMARKER (obj)->buffer, name), printcharfun);
2017 }
2018 PRINTCHAR ('>');
2019 break;
2020
2021 case Lisp_Misc_Overlay:
2022 strout ("#<overlay ", -1, -1, printcharfun);
2023 if (! XMARKER (OVERLAY_START (obj))->buffer)
2024 strout ("in no buffer", -1, -1, printcharfun);
2025 else
2026 {
2027 int len = sprintf (buf, "from %"pD"d to %"pD"d in ",
2028 marker_position (OVERLAY_START (obj)),
2029 marker_position (OVERLAY_END (obj)));
2030 strout (buf, len, len, printcharfun);
2031 print_string (BVAR (XMARKER (OVERLAY_START (obj))->buffer, name),
2032 printcharfun);
2033 }
2034 PRINTCHAR ('>');
2035 break;
2036
2037 /* Remaining cases shouldn't happen in normal usage, but let's print
2038 them anyway for the benefit of the debugger. */
2039 case Lisp_Misc_Free:
2040 strout ("#<misc free cell>", -1, -1, printcharfun);
2041 break;
2042
2043 case Lisp_Misc_Save_Value:
2044 strout ("#<save_value ", -1, -1, printcharfun);
2045 {
2046 int len = sprintf (buf, "ptr=%p int=%"pD"d",
2047 XSAVE_VALUE (obj)->pointer,
2048 XSAVE_VALUE (obj)->integer);
2049 strout (buf, len, len, printcharfun);
2050 }
2051 PRINTCHAR ('>');
2052 break;
2053
2054 default:
2055 goto badtype;
2056 }
2057 break;
2058
2059 default:
2060 badtype:
2061 {
2062 int len;
2063 /* We're in trouble if this happens!
2064 Probably should just abort () */
2065 strout ("#<EMACS BUG: INVALID DATATYPE ", -1, -1, printcharfun);
2066 if (MISCP (obj))
2067 len = sprintf (buf, "(MISC 0x%04x)", (int) XMISCTYPE (obj));
2068 else if (VECTORLIKEP (obj))
2069 len = sprintf (buf, "(PVEC 0x%08"pD"x)", ASIZE (obj));
2070 else
2071 len = sprintf (buf, "(0x%02x)", (int) XTYPE (obj));
2072 strout (buf, len, len, printcharfun);
2073 strout (" Save your buffers immediately and please report this bug>",
2074 -1, -1, printcharfun);
2075 }
2076 }
2077
2078 print_depth--;
2079 }
2080 \f
2081
2082 /* Print a description of INTERVAL using PRINTCHARFUN.
2083 This is part of printing a string that has text properties. */
2084
2085 void
2086 print_interval (INTERVAL interval, Lisp_Object printcharfun)
2087 {
2088 if (NILP (interval->plist))
2089 return;
2090 PRINTCHAR (' ');
2091 print_object (make_number (interval->position), printcharfun, 1);
2092 PRINTCHAR (' ');
2093 print_object (make_number (interval->position + LENGTH (interval)),
2094 printcharfun, 1);
2095 PRINTCHAR (' ');
2096 print_object (interval->plist, printcharfun, 1);
2097 }
2098
2099 \f
2100 void
2101 syms_of_print (void)
2102 {
2103 DEFSYM (Qtemp_buffer_setup_hook, "temp-buffer-setup-hook");
2104
2105 DEFVAR_LISP ("standard-output", Vstandard_output,
2106 doc: /* Output stream `print' uses by default for outputting a character.
2107 This may be any function of one argument.
2108 It may also be a buffer (output is inserted before point)
2109 or a marker (output is inserted and the marker is advanced)
2110 or the symbol t (output appears in the echo area). */);
2111 Vstandard_output = Qt;
2112 DEFSYM (Qstandard_output, "standard-output");
2113
2114 DEFVAR_LISP ("float-output-format", Vfloat_output_format,
2115 doc: /* The format descriptor string used to print floats.
2116 This is a %-spec like those accepted by `printf' in C,
2117 but with some restrictions. It must start with the two characters `%.'.
2118 After that comes an integer precision specification,
2119 and then a letter which controls the format.
2120 The letters allowed are `e', `f' and `g'.
2121 Use `e' for exponential notation \"DIG.DIGITSeEXPT\"
2122 Use `f' for decimal point notation \"DIGITS.DIGITS\".
2123 Use `g' to choose the shorter of those two formats for the number at hand.
2124 The precision in any of these cases is the number of digits following
2125 the decimal point. With `f', a precision of 0 means to omit the
2126 decimal point. 0 is not allowed with `e' or `g'.
2127
2128 A value of nil means to use the shortest notation
2129 that represents the number without losing information. */);
2130 Vfloat_output_format = Qnil;
2131 DEFSYM (Qfloat_output_format, "float-output-format");
2132
2133 DEFVAR_LISP ("print-length", Vprint_length,
2134 doc: /* Maximum length of list to print before abbreviating.
2135 A value of nil means no limit. See also `eval-expression-print-length'. */);
2136 Vprint_length = Qnil;
2137
2138 DEFVAR_LISP ("print-level", Vprint_level,
2139 doc: /* Maximum depth of list nesting to print before abbreviating.
2140 A value of nil means no limit. See also `eval-expression-print-level'. */);
2141 Vprint_level = Qnil;
2142
2143 DEFVAR_BOOL ("print-escape-newlines", print_escape_newlines,
2144 doc: /* Non-nil means print newlines in strings as `\\n'.
2145 Also print formfeeds as `\\f'. */);
2146 print_escape_newlines = 0;
2147
2148 DEFVAR_BOOL ("print-escape-nonascii", print_escape_nonascii,
2149 doc: /* Non-nil means print unibyte non-ASCII chars in strings as \\OOO.
2150 \(OOO is the octal representation of the character code.)
2151 Only single-byte characters are affected, and only in `prin1'.
2152 When the output goes in a multibyte buffer, this feature is
2153 enabled regardless of the value of the variable. */);
2154 print_escape_nonascii = 0;
2155
2156 DEFVAR_BOOL ("print-escape-multibyte", print_escape_multibyte,
2157 doc: /* Non-nil means print multibyte characters in strings as \\xXXXX.
2158 \(XXXX is the hex representation of the character code.)
2159 This affects only `prin1'. */);
2160 print_escape_multibyte = 0;
2161
2162 DEFVAR_BOOL ("print-quoted", print_quoted,
2163 doc: /* Non-nil means print quoted forms with reader syntax.
2164 I.e., (quote foo) prints as 'foo, (function foo) as #'foo. */);
2165 print_quoted = 0;
2166
2167 DEFVAR_LISP ("print-gensym", Vprint_gensym,
2168 doc: /* Non-nil means print uninterned symbols so they will read as uninterned.
2169 I.e., the value of (make-symbol \"foobar\") prints as #:foobar.
2170 When the uninterned symbol appears within a recursive data structure,
2171 and the symbol appears more than once, in addition use the #N# and #N=
2172 constructs as needed, so that multiple references to the same symbol are
2173 shared once again when the text is read back. */);
2174 Vprint_gensym = Qnil;
2175
2176 DEFVAR_LISP ("print-circle", Vprint_circle,
2177 doc: /* Non-nil means print recursive structures using #N= and #N# syntax.
2178 If nil, printing proceeds recursively and may lead to
2179 `max-lisp-eval-depth' being exceeded or an error may occur:
2180 \"Apparently circular structure being printed.\" Also see
2181 `print-length' and `print-level'.
2182 If non-nil, shared substructures anywhere in the structure are printed
2183 with `#N=' before the first occurrence (in the order of the print
2184 representation) and `#N#' in place of each subsequent occurrence,
2185 where N is a positive decimal integer. */);
2186 Vprint_circle = Qnil;
2187
2188 DEFVAR_LISP ("print-continuous-numbering", Vprint_continuous_numbering,
2189 doc: /* Non-nil means number continuously across print calls.
2190 This affects the numbers printed for #N= labels and #M# references.
2191 See also `print-circle', `print-gensym', and `print-number-table'.
2192 This variable should not be set with `setq'; bind it with a `let' instead. */);
2193 Vprint_continuous_numbering = Qnil;
2194
2195 DEFVAR_LISP ("print-number-table", Vprint_number_table,
2196 doc: /* A vector used internally to produce `#N=' labels and `#N#' references.
2197 The Lisp printer uses this vector to detect Lisp objects referenced more
2198 than once.
2199
2200 When you bind `print-continuous-numbering' to t, you should probably
2201 also bind `print-number-table' to nil. This ensures that the value of
2202 `print-number-table' can be garbage-collected once the printing is
2203 done. If all elements of `print-number-table' are nil, it means that
2204 the printing done so far has not found any shared structure or objects
2205 that need to be recorded in the table. */);
2206 Vprint_number_table = Qnil;
2207
2208 DEFVAR_LISP ("print-charset-text-property", Vprint_charset_text_property,
2209 doc: /* A flag to control printing of `charset' text property on printing a string.
2210 The value must be nil, t, or `default'.
2211
2212 If the value is nil, don't print the text property `charset'.
2213
2214 If the value is t, always print the text property `charset'.
2215
2216 If the value is `default', print the text property `charset' only when
2217 the value is different from what is guessed in the current charset
2218 priorities. */);
2219 Vprint_charset_text_property = Qdefault;
2220
2221 /* prin1_to_string_buffer initialized in init_buffer_once in buffer.c */
2222 staticpro (&Vprin1_to_string_buffer);
2223
2224 defsubr (&Sprin1);
2225 defsubr (&Sprin1_to_string);
2226 defsubr (&Serror_message_string);
2227 defsubr (&Sprinc);
2228 defsubr (&Sprint);
2229 defsubr (&Sterpri);
2230 defsubr (&Swrite_char);
2231 defsubr (&Sexternal_debugging_output);
2232 #ifdef WITH_REDIRECT_DEBUGGING_OUTPUT
2233 defsubr (&Sredirect_debugging_output);
2234 #endif
2235
2236 DEFSYM (Qexternal_debugging_output, "external-debugging-output");
2237 DEFSYM (Qprint_escape_newlines, "print-escape-newlines");
2238 DEFSYM (Qprint_escape_multibyte, "print-escape-multibyte");
2239 DEFSYM (Qprint_escape_nonascii, "print-escape-nonascii");
2240
2241 print_prune_charset_plist = Qnil;
2242 staticpro (&print_prune_charset_plist);
2243 }