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