use dynwind_begin and dynwind_end
[bpt/emacs.git] / src / print.c
1 /* Lisp object printing and output streams.
2
3 Copyright (C) 1985-1986, 1988, 1993-1995, 1997-2014 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 "sysstdio.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 bool 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 dynwind_begin (); \
104 bool 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 signal_error ("Marker is outside the accessible " \
128 "part of the buffer", printcharfun); \
129 old_point = PT; \
130 old_point_byte = PT_BYTE; \
131 SET_PT_BOTH (marker_pos, \
132 marker_byte_position (printcharfun)); \
133 start_point = PT; \
134 start_point_byte = PT_BYTE; \
135 printcharfun = Qnil; \
136 } \
137 if (NILP (printcharfun)) \
138 { \
139 Lisp_Object string; \
140 if (NILP (BVAR (current_buffer, enable_multibyte_characters)) \
141 && ! print_escape_multibyte) \
142 specbind (Qprint_escape_multibyte, Qt); \
143 if (! NILP (BVAR (current_buffer, enable_multibyte_characters)) \
144 && ! print_escape_nonascii) \
145 specbind (Qprint_escape_nonascii, Qt); \
146 if (print_buffer != 0) \
147 { \
148 string = make_string_from_bytes (print_buffer, \
149 print_buffer_pos, \
150 print_buffer_pos_byte); \
151 record_unwind_protect (print_unwind, string); \
152 } \
153 else \
154 { \
155 int new_size = 1000; \
156 print_buffer = xmalloc_atomic (new_size); \
157 print_buffer_size = new_size; \
158 free_print_buffer = 1; \
159 } \
160 print_buffer_pos = 0; \
161 print_buffer_pos_byte = 0; \
162 } \
163 if (EQ (printcharfun, Qt) && ! noninteractive) \
164 setup_echo_area_for_printing (multibyte);
165
166 #define PRINTFINISH \
167 if (NILP (printcharfun)) \
168 { \
169 if (print_buffer_pos != print_buffer_pos_byte \
170 && NILP (BVAR (current_buffer, enable_multibyte_characters)))\
171 { \
172 unsigned char *temp = alloca (print_buffer_pos + 1); \
173 copy_text ((unsigned char *) print_buffer, temp, \
174 print_buffer_pos_byte, 1, 0); \
175 insert_1_both ((char *) temp, print_buffer_pos, \
176 print_buffer_pos, 0, 1, 0); \
177 } \
178 else \
179 insert_1_both (print_buffer, print_buffer_pos, \
180 print_buffer_pos_byte, 0, 1, 0); \
181 signal_after_change (PT - print_buffer_pos, 0, print_buffer_pos);\
182 } \
183 if (free_print_buffer) \
184 { \
185 xfree (print_buffer); \
186 print_buffer = 0; \
187 } \
188 dynwind_end (); \
189 if (MARKERP (original)) \
190 set_marker_both (original, Qnil, PT, PT_BYTE); \
191 if (old_point >= 0) \
192 SET_PT_BOTH (old_point + (old_point >= start_point \
193 ? PT - start_point : 0), \
194 old_point_byte + (old_point_byte >= start_point_byte \
195 ? PT_BYTE - start_point_byte : 0)); \
196 set_buffer_internal (old);
197
198 #define PRINTCHAR(ch) printchar (ch, printcharfun)
199
200 /* This is used to restore the saved contents of print_buffer
201 when there is a recursive call to print. */
202
203 static void
204 print_unwind (Lisp_Object saved_text)
205 {
206 memcpy (print_buffer, SDATA (saved_text), SCHARS (saved_text));
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 (incr > 0)
231 print_buffer = xpalloc (print_buffer, &print_buffer_size,
232 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 bool 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 (incr > 0)
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 bool 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 register struct buffer *old = current_buffer;
482 register Lisp_Object buf;
483
484 dynwind_begin ();
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 dynwind_end ();
507
508 specbind (Qstandard_output, buf);
509 }
510 \f
511 static void print (Lisp_Object, Lisp_Object, bool);
512 static void print_preprocess (Lisp_Object);
513 static void print_preprocess_string (INTERVAL, Lisp_Object);
514 static void print_object (Lisp_Object, Lisp_Object, bool);
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 struct buffer *previous;
587
588 dynwind_begin ();
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
600 printcharfun = Vprin1_to_string_buffer;
601 PRINTPREPARE;
602 print (object, printcharfun, NILP (noescape));
603 /* Make Vprin1_to_string_buffer be the default buffer after PRINTFINISH */
604 PRINTFINISH;
605 }
606
607 previous = current_buffer;
608 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
609 object = Fbuffer_string ();
610 if (SBYTES (object) == SCHARS (object))
611 STRING_SET_UNIBYTE (object);
612
613 /* Note that this won't make prepare_to_modify_buffer call
614 ask-user-about-supersession-threat because this buffer
615 does not visit a file. */
616 Ferase_buffer ();
617 set_buffer_internal (previous);
618
619 Vdeactivate_mark = save_deactivate_mark;
620 /* UNGCPRO; */
621
622 dynwind_end ();
623 return object;
624 }
625
626 DEFUN ("princ", Fprinc, Sprinc, 1, 2, 0,
627 doc: /* Output the printed representation of OBJECT, any Lisp object.
628 No quoting characters are used; no delimiters are printed around
629 the contents of strings.
630
631 OBJECT is any of the Lisp data types: a number, a string, a symbol,
632 a list, a buffer, a window, a frame, etc.
633
634 A printed representation of an object is text which describes that object.
635
636 Optional argument PRINTCHARFUN is the output stream, which can be one
637 of these:
638
639 - a buffer, in which case output is inserted into that buffer at point;
640 - a marker, in which case output is inserted at marker's position;
641 - a function, in which case that function is called once for each
642 character of OBJECT's printed representation;
643 - a symbol, in which case that symbol's function definition is called; or
644 - t, in which case the output is displayed in the echo area.
645
646 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
647 is used instead. */)
648 (Lisp_Object object, Lisp_Object printcharfun)
649 {
650 PRINTDECLARE;
651
652 if (NILP (printcharfun))
653 printcharfun = Vstandard_output;
654 PRINTPREPARE;
655 print (object, printcharfun, 0);
656 PRINTFINISH;
657 return object;
658 }
659
660 DEFUN ("print", Fprint, Sprint, 1, 2, 0,
661 doc: /* Output the printed representation of OBJECT, with newlines around it.
662 Quoting characters are printed when needed to make output that `read'
663 can handle, whenever this is possible. For complex objects, the behavior
664 is controlled by `print-level' and `print-length', which see.
665
666 OBJECT is any of the Lisp data types: a number, a string, a symbol,
667 a list, a buffer, a window, a frame, etc.
668
669 A printed representation of an object is text which describes that object.
670
671 Optional argument PRINTCHARFUN is the output stream, which can be one
672 of these:
673
674 - a buffer, in which case output is inserted into that buffer at point;
675 - a marker, in which case output is inserted at marker's position;
676 - a function, in which case that function is called once for each
677 character of OBJECT's printed representation;
678 - a symbol, in which case that symbol's function definition is called; or
679 - t, in which case the output is displayed in the echo area.
680
681 If PRINTCHARFUN is omitted, the value of `standard-output' (which see)
682 is used instead. */)
683 (Lisp_Object object, Lisp_Object printcharfun)
684 {
685 PRINTDECLARE;
686 struct gcpro gcpro1;
687
688 if (NILP (printcharfun))
689 printcharfun = Vstandard_output;
690 GCPRO1 (object);
691 PRINTPREPARE;
692 PRINTCHAR ('\n');
693 print (object, printcharfun, 1);
694 PRINTCHAR ('\n');
695 PRINTFINISH;
696 UNGCPRO;
697 return object;
698 }
699
700 /* The subroutine object for external-debugging-output is kept here
701 for the convenience of the debugger. */
702 Lisp_Object Qexternal_debugging_output;
703
704 DEFUN ("external-debugging-output", Fexternal_debugging_output, Sexternal_debugging_output, 1, 1, 0,
705 doc: /* Write CHARACTER to stderr.
706 You can call print while debugging emacs, and pass it this function
707 to make it write to the debugging output. */)
708 (Lisp_Object character)
709 {
710 unsigned int ch;
711
712 CHECK_NUMBER (character);
713 ch = XINT (character);
714 if (ASCII_CHAR_P (ch))
715 {
716 putc (ch, stderr);
717 #ifdef WINDOWSNT
718 /* Send the output to a debugger (nothing happens if there isn't
719 one). */
720 if (print_output_debug_flag)
721 {
722 char buf[2] = {(char) XINT (character), '\0'};
723 OutputDebugString (buf);
724 }
725 #endif
726 }
727 else
728 {
729 unsigned char mbstr[MAX_MULTIBYTE_LENGTH];
730 ptrdiff_t len = CHAR_STRING (ch, mbstr);
731 Lisp_Object encoded_ch =
732 ENCODE_SYSTEM (make_multibyte_string ((char *) mbstr, 1, len));
733
734 fwrite (SSDATA (encoded_ch), SBYTES (encoded_ch), 1, stderr);
735 #ifdef WINDOWSNT
736 if (print_output_debug_flag)
737 OutputDebugString (SSDATA (encoded_ch));
738 #endif
739 }
740
741 return character;
742 }
743
744 /* This function is never called. Its purpose is to prevent
745 print_output_debug_flag from being optimized away. */
746
747 extern void debug_output_compilation_hack (bool) EXTERNALLY_VISIBLE;
748 void
749 debug_output_compilation_hack (bool x)
750 {
751 print_output_debug_flag = x;
752 }
753
754 #if defined (GNU_LINUX)
755
756 /* This functionality is not vitally important in general, so we rely on
757 non-portable ability to use stderr as lvalue. */
758
759 #define WITH_REDIRECT_DEBUGGING_OUTPUT 1
760
761 static FILE *initial_stderr_stream = NULL;
762
763 DEFUN ("redirect-debugging-output", Fredirect_debugging_output, Sredirect_debugging_output,
764 1, 2,
765 "FDebug output file: \nP",
766 doc: /* Redirect debugging output (stderr stream) to file FILE.
767 If FILE is nil, reset target to the initial stderr stream.
768 Optional arg APPEND non-nil (interactively, with prefix arg) means
769 append to existing target file. */)
770 (Lisp_Object file, Lisp_Object append)
771 {
772 if (initial_stderr_stream != NULL)
773 {
774 block_input ();
775 fclose (stderr);
776 unblock_input ();
777 }
778 stderr = initial_stderr_stream;
779 initial_stderr_stream = NULL;
780
781 if (STRINGP (file))
782 {
783 file = Fexpand_file_name (file, Qnil);
784 initial_stderr_stream = stderr;
785 stderr = emacs_fopen (SSDATA (file), NILP (append) ? "w" : "a");
786 if (stderr == NULL)
787 {
788 stderr = initial_stderr_stream;
789 initial_stderr_stream = NULL;
790 report_file_error ("Cannot open debugging output stream", file);
791 }
792 }
793 return Qnil;
794 }
795 #endif /* GNU_LINUX */
796
797
798 /* This is the interface for debugging printing. */
799
800 void
801 debug_print (Lisp_Object arg)
802 {
803 Fprin1 (arg, Qexternal_debugging_output);
804 fprintf (stderr, "\r\n");
805 }
806
807 void safe_debug_print (Lisp_Object) EXTERNALLY_VISIBLE;
808 void
809 safe_debug_print (Lisp_Object arg)
810 {
811 int valid = valid_lisp_object_p (arg);
812
813 if (valid > 0)
814 debug_print (arg);
815 else
816 fprintf (stderr, "#<%s_LISP_OBJECT 0x%08"pI"x>\r\n",
817 !valid ? "INVALID" : "SOME",
818 XLI (arg));
819 }
820
821 \f
822 DEFUN ("error-message-string", Ferror_message_string, Serror_message_string,
823 1, 1, 0,
824 doc: /* Convert an error value (ERROR-SYMBOL . DATA) to an error message.
825 See Info anchor `(elisp)Definition of signal' for some details on how this
826 error message is constructed. */)
827 (Lisp_Object obj)
828 {
829 struct buffer *old = current_buffer;
830 Lisp_Object value;
831 struct gcpro gcpro1;
832
833 /* If OBJ is (error STRING), just return STRING.
834 That is not only faster, it also avoids the need to allocate
835 space here when the error is due to memory full. */
836 if (CONSP (obj) && EQ (XCAR (obj), Qerror)
837 && CONSP (XCDR (obj))
838 && STRINGP (XCAR (XCDR (obj)))
839 && NILP (XCDR (XCDR (obj))))
840 return XCAR (XCDR (obj));
841
842 print_error_message (obj, Vprin1_to_string_buffer, 0, Qnil);
843
844 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer));
845 value = Fbuffer_string ();
846
847 GCPRO1 (value);
848 Ferase_buffer ();
849 set_buffer_internal (old);
850 UNGCPRO;
851
852 return value;
853 }
854
855 /* Print an error message for the error DATA onto Lisp output stream
856 STREAM (suitable for the print functions).
857 CONTEXT is a C string describing the context of the error.
858 CALLER is the Lisp function inside which the error was signaled. */
859
860 void
861 print_error_message (Lisp_Object data, Lisp_Object stream, const char *context,
862 Lisp_Object caller)
863 {
864 Lisp_Object errname, errmsg, file_error, tail;
865 struct gcpro gcpro1;
866
867 if (context != 0)
868 write_string_1 (context, -1, stream);
869
870 /* If we know from where the error was signaled, show it in
871 *Messages*. */
872 if (!NILP (caller) && SYMBOLP (caller))
873 {
874 Lisp_Object cname = SYMBOL_NAME (caller);
875 ptrdiff_t cnamelen = SBYTES (cname);
876 USE_SAFE_ALLOCA;
877 char *name = SAFE_ALLOCA (cnamelen);
878 memcpy (name, SDATA (cname), cnamelen);
879 message_dolog (name, cnamelen, 0, 0);
880 message_dolog (": ", 2, 0, 0);
881 SAFE_FREE ();
882 }
883
884 errname = Fcar (data);
885
886 if (EQ (errname, Qerror))
887 {
888 data = Fcdr (data);
889 if (!CONSP (data))
890 data = Qnil;
891 errmsg = Fcar (data);
892 file_error = Qnil;
893 }
894 else
895 {
896 Lisp_Object error_conditions = Fget (errname, Qerror_conditions);
897 errmsg = Fget (errname, Qerror_message);
898 file_error = Fmemq (Qfile_error, error_conditions);
899 }
900
901 /* Print an error message including the data items. */
902
903 tail = Fcdr_safe (data);
904 GCPRO1 (tail);
905
906 /* For file-error, make error message by concatenating
907 all the data items. They are all strings. */
908 if (!NILP (file_error) && CONSP (tail))
909 errmsg = XCAR (tail), tail = XCDR (tail);
910
911 {
912 const char *sep = ": ";
913
914 if (!STRINGP (errmsg))
915 write_string_1 ("peculiar error", -1, stream);
916 else if (SCHARS (errmsg))
917 Fprinc (errmsg, stream);
918 else
919 sep = NULL;
920
921 for (; CONSP (tail); tail = XCDR (tail), sep = ", ")
922 {
923 Lisp_Object obj;
924
925 if (sep)
926 write_string_1 (sep, 2, stream);
927 obj = XCAR (tail);
928 if (!NILP (file_error)
929 || EQ (errname, Qend_of_file) || EQ (errname, Quser_error))
930 Fprinc (obj, stream);
931 else
932 Fprin1 (obj, stream);
933 }
934 }
935
936 UNGCPRO;
937 }
938
939
940 \f
941 /*
942 * The buffer should be at least as large as the max string size of the
943 * largest float, printed in the biggest notation. This is undoubtedly
944 * 20d float_output_format, with the negative of the C-constant "HUGE"
945 * from <math.h>.
946 *
947 * On the vax the worst case is -1e38 in 20d format which takes 61 bytes.
948 *
949 * I assume that IEEE-754 format numbers can take 329 bytes for the worst
950 * case of -1e307 in 20d float_output_format. What is one to do (short of
951 * re-writing _doprnt to be more sane)?
952 * -wsr
953 * Given the above, the buffer must be least FLOAT_TO_STRING_BUFSIZE bytes.
954 */
955
956 int
957 float_to_string (char *buf, double data)
958 {
959 char *cp;
960 int width;
961 int len;
962
963 /* Check for plus infinity in a way that won't lose
964 if there is no plus infinity. */
965 if (data == data / 2 && data > 1.0)
966 {
967 static char const infinity_string[] = "1.0e+INF";
968 strcpy (buf, infinity_string);
969 return sizeof infinity_string - 1;
970 }
971 /* Likewise for minus infinity. */
972 if (data == data / 2 && data < -1.0)
973 {
974 static char const minus_infinity_string[] = "-1.0e+INF";
975 strcpy (buf, minus_infinity_string);
976 return sizeof minus_infinity_string - 1;
977 }
978 /* Check for NaN in a way that won't fail if there are no NaNs. */
979 if (! (data * 0.0 >= 0.0))
980 {
981 /* Prepend "-" if the NaN's sign bit is negative.
982 The sign bit of a double is the bit that is 1 in -0.0. */
983 static char const NaN_string[] = "0.0e+NaN";
984 int i;
985 union { double d; char c[sizeof (double)]; } u_data, u_minus_zero;
986 bool negative = 0;
987 u_data.d = data;
988 u_minus_zero.d = - 0.0;
989 for (i = 0; i < sizeof (double); i++)
990 if (u_data.c[i] & u_minus_zero.c[i])
991 {
992 *buf = '-';
993 negative = 1;
994 break;
995 }
996
997 strcpy (buf + negative, NaN_string);
998 return negative + sizeof NaN_string - 1;
999 }
1000
1001 if (NILP (Vfloat_output_format)
1002 || !STRINGP (Vfloat_output_format))
1003 lose:
1004 {
1005 /* Generate the fewest number of digits that represent the
1006 floating point value without losing information. */
1007 len = dtoastr (buf, FLOAT_TO_STRING_BUFSIZE - 2, 0, 0, data);
1008 /* The decimal point must be printed, or the byte compiler can
1009 get confused (Bug#8033). */
1010 width = 1;
1011 }
1012 else /* oink oink */
1013 {
1014 /* Check that the spec we have is fully valid.
1015 This means not only valid for printf,
1016 but meant for floats, and reasonable. */
1017 cp = SSDATA (Vfloat_output_format);
1018
1019 if (cp[0] != '%')
1020 goto lose;
1021 if (cp[1] != '.')
1022 goto lose;
1023
1024 cp += 2;
1025
1026 /* Check the width specification. */
1027 width = -1;
1028 if ('0' <= *cp && *cp <= '9')
1029 {
1030 width = 0;
1031 do
1032 {
1033 width = (width * 10) + (*cp++ - '0');
1034 if (DBL_DIG < width)
1035 goto lose;
1036 }
1037 while (*cp >= '0' && *cp <= '9');
1038
1039 /* A precision of zero is valid only for %f. */
1040 if (width == 0 && *cp != 'f')
1041 goto lose;
1042 }
1043
1044 if (*cp != 'e' && *cp != 'f' && *cp != 'g')
1045 goto lose;
1046
1047 if (cp[1] != 0)
1048 goto lose;
1049
1050 len = sprintf (buf, SSDATA (Vfloat_output_format), data);
1051 }
1052
1053 /* Make sure there is a decimal point with digit after, or an
1054 exponent, so that the value is readable as a float. But don't do
1055 this with "%.0f"; it's valid for that not to produce a decimal
1056 point. Note that width can be 0 only for %.0f. */
1057 if (width != 0)
1058 {
1059 for (cp = buf; *cp; cp++)
1060 if ((*cp < '0' || *cp > '9') && *cp != '-')
1061 break;
1062
1063 if (*cp == '.' && cp[1] == 0)
1064 {
1065 cp[1] = '0';
1066 cp[2] = 0;
1067 len++;
1068 }
1069 else if (*cp == 0)
1070 {
1071 *cp++ = '.';
1072 *cp++ = '0';
1073 *cp++ = 0;
1074 len += 2;
1075 }
1076 }
1077
1078 return len;
1079 }
1080
1081 \f
1082 static void
1083 print (Lisp_Object obj, Lisp_Object printcharfun, bool escapeflag)
1084 {
1085 new_backquote_output = 0;
1086
1087 /* Reset print_number_index and Vprint_number_table only when
1088 the variable Vprint_continuous_numbering is nil. Otherwise,
1089 the values of these variables will be kept between several
1090 print functions. */
1091 if (NILP (Vprint_continuous_numbering)
1092 || NILP (Vprint_number_table))
1093 {
1094 print_number_index = 0;
1095 Vprint_number_table = Qnil;
1096 }
1097
1098 /* Construct Vprint_number_table for print-gensym and print-circle. */
1099 if (!NILP (Vprint_gensym) || !NILP (Vprint_circle))
1100 {
1101 /* Construct Vprint_number_table.
1102 This increments print_number_index for the objects added. */
1103 print_depth = 0;
1104 print_preprocess (obj);
1105
1106 if (HASH_TABLE_P (Vprint_number_table))
1107 { /* Remove unnecessary objects, which appear only once in OBJ;
1108 that is, whose status is Qt. */
1109 struct Lisp_Hash_Table *h = XHASH_TABLE (Vprint_number_table);
1110 ptrdiff_t i;
1111
1112 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1113 if (!NILP (HASH_HASH (h, i))
1114 && EQ (HASH_VALUE (h, i), Qt))
1115 Fremhash (HASH_KEY (h, i), Vprint_number_table);
1116 }
1117 }
1118
1119 print_depth = 0;
1120 print_object (obj, printcharfun, escapeflag);
1121 }
1122
1123 #define PRINT_CIRCLE_CANDIDATE_P(obj) \
1124 (STRINGP (obj) || CONSP (obj) \
1125 || (VECTORLIKEP (obj) \
1126 && (VECTORP (obj) || COMPILEDP (obj) \
1127 || CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj) \
1128 || HASH_TABLE_P (obj) || FONTP (obj))) \
1129 || (! NILP (Vprint_gensym) \
1130 && SYMBOLP (obj) \
1131 && !SYMBOL_INTERNED_P (obj)))
1132
1133 /* Construct Vprint_number_table according to the structure of OBJ.
1134 OBJ itself and all its elements will be added to Vprint_number_table
1135 recursively if it is a list, vector, compiled function, char-table,
1136 string (its text properties will be traced), or a symbol that has
1137 no obarray (this is for the print-gensym feature).
1138 The status fields of Vprint_number_table mean whether each object appears
1139 more than once in OBJ: Qnil at the first time, and Qt after that. */
1140 static void
1141 print_preprocess (Lisp_Object obj)
1142 {
1143 int i;
1144 ptrdiff_t size;
1145 int loop_count = 0;
1146 Lisp_Object halftail;
1147
1148 /* Avoid infinite recursion for circular nested structure
1149 in the case where Vprint_circle is nil. */
1150 if (NILP (Vprint_circle))
1151 {
1152 /* Give up if we go so deep that print_object will get an error. */
1153 /* See similar code in print_object. */
1154 if (print_depth >= PRINT_CIRCLE)
1155 error ("Apparently circular structure being printed");
1156
1157 for (i = 0; i < print_depth; i++)
1158 if (EQ (obj, being_printed[i]))
1159 return;
1160 being_printed[print_depth] = obj;
1161 }
1162
1163 print_depth++;
1164 halftail = obj;
1165
1166 loop:
1167 if (PRINT_CIRCLE_CANDIDATE_P (obj))
1168 {
1169 if (!HASH_TABLE_P (Vprint_number_table))
1170 {
1171 Lisp_Object args[2];
1172 args[0] = QCtest;
1173 args[1] = Qeq;
1174 Vprint_number_table = Fmake_hash_table (2, args);
1175 }
1176
1177 /* In case print-circle is nil and print-gensym is t,
1178 add OBJ to Vprint_number_table only when OBJ is a symbol. */
1179 if (! NILP (Vprint_circle) || SYMBOLP (obj))
1180 {
1181 Lisp_Object num = Fgethash (obj, Vprint_number_table, Qnil);
1182 if (!NILP (num)
1183 /* If Vprint_continuous_numbering is non-nil and OBJ is a gensym,
1184 always print the gensym with a number. This is a special for
1185 the lisp function byte-compile-output-docform. */
1186 || (!NILP (Vprint_continuous_numbering)
1187 && SYMBOLP (obj)
1188 && !SYMBOL_INTERNED_P (obj)))
1189 { /* OBJ appears more than once. Let's remember that. */
1190 if (!INTEGERP (num))
1191 {
1192 print_number_index++;
1193 /* Negative number indicates it hasn't been printed yet. */
1194 Fputhash (obj, make_number (- print_number_index),
1195 Vprint_number_table);
1196 }
1197 print_depth--;
1198 return;
1199 }
1200 else
1201 /* OBJ is not yet recorded. Let's add to the table. */
1202 Fputhash (obj, Qt, Vprint_number_table);
1203 }
1204
1205 switch (XTYPE (obj))
1206 {
1207 case Lisp_String:
1208 /* A string may have text properties, which can be circular. */
1209 traverse_intervals_noorder (string_intervals (obj),
1210 print_preprocess_string, Qnil);
1211 break;
1212
1213 case Lisp_Cons:
1214 /* Use HALFTAIL and LOOP_COUNT to detect circular lists,
1215 just as in print_object. */
1216 if (loop_count && EQ (obj, halftail))
1217 break;
1218 print_preprocess (XCAR (obj));
1219 obj = XCDR (obj);
1220 loop_count++;
1221 if (!(loop_count & 1))
1222 halftail = XCDR (halftail);
1223 goto loop;
1224
1225 case Lisp_Vectorlike:
1226 size = ASIZE (obj);
1227 if (size & PSEUDOVECTOR_FLAG)
1228 size &= PSEUDOVECTOR_SIZE_MASK;
1229 for (i = 0; i < size; i++)
1230 print_preprocess (AREF (obj, i));
1231 if (HASH_TABLE_P (obj))
1232 { /* For hash tables, the key_and_value slot is past
1233 `size' because it needs to be marked specially in case
1234 the table is weak. */
1235 struct Lisp_Hash_Table *h = XHASH_TABLE (obj);
1236 print_preprocess (h->key_and_value);
1237 }
1238 break;
1239
1240 default:
1241 break;
1242 }
1243 }
1244 print_depth--;
1245 }
1246
1247 static void
1248 print_preprocess_string (INTERVAL interval, Lisp_Object arg)
1249 {
1250 print_preprocess (interval->plist);
1251 }
1252
1253 static void print_check_string_charset_prop (INTERVAL interval, Lisp_Object string);
1254
1255 #define PRINT_STRING_NON_CHARSET_FOUND 1
1256 #define PRINT_STRING_UNSAFE_CHARSET_FOUND 2
1257
1258 /* Bitwise or of the above macros. */
1259 static int print_check_string_result;
1260
1261 static void
1262 print_check_string_charset_prop (INTERVAL interval, Lisp_Object string)
1263 {
1264 Lisp_Object val;
1265
1266 if (NILP (interval->plist)
1267 || (print_check_string_result == (PRINT_STRING_NON_CHARSET_FOUND
1268 | PRINT_STRING_UNSAFE_CHARSET_FOUND)))
1269 return;
1270 for (val = interval->plist; CONSP (val) && ! EQ (XCAR (val), Qcharset);
1271 val = XCDR (XCDR (val)));
1272 if (! CONSP (val))
1273 {
1274 print_check_string_result |= PRINT_STRING_NON_CHARSET_FOUND;
1275 return;
1276 }
1277 if (! (print_check_string_result & PRINT_STRING_NON_CHARSET_FOUND))
1278 {
1279 if (! EQ (val, interval->plist)
1280 || CONSP (XCDR (XCDR (val))))
1281 print_check_string_result |= PRINT_STRING_NON_CHARSET_FOUND;
1282 }
1283 if (NILP (Vprint_charset_text_property)
1284 || ! (print_check_string_result & PRINT_STRING_UNSAFE_CHARSET_FOUND))
1285 {
1286 int i, c;
1287 ptrdiff_t charpos = interval->position;
1288 ptrdiff_t bytepos = string_char_to_byte (string, charpos);
1289 Lisp_Object charset;
1290
1291 charset = XCAR (XCDR (val));
1292 for (i = 0; i < LENGTH (interval); i++)
1293 {
1294 FETCH_STRING_CHAR_ADVANCE (c, string, charpos, bytepos);
1295 if (! ASCII_CHAR_P (c)
1296 && ! EQ (CHARSET_NAME (CHAR_CHARSET (c)), charset))
1297 {
1298 print_check_string_result |= PRINT_STRING_UNSAFE_CHARSET_FOUND;
1299 break;
1300 }
1301 }
1302 }
1303 }
1304
1305 /* The value is (charset . nil). */
1306 static Lisp_Object print_prune_charset_plist;
1307
1308 static Lisp_Object
1309 print_prune_string_charset (Lisp_Object string)
1310 {
1311 print_check_string_result = 0;
1312 traverse_intervals (string_intervals (string), 0,
1313 print_check_string_charset_prop, string);
1314 if (! (print_check_string_result & PRINT_STRING_UNSAFE_CHARSET_FOUND))
1315 {
1316 string = Fcopy_sequence (string);
1317 if (print_check_string_result & PRINT_STRING_NON_CHARSET_FOUND)
1318 {
1319 if (NILP (print_prune_charset_plist))
1320 print_prune_charset_plist = list1 (Qcharset);
1321 Fremove_text_properties (make_number (0),
1322 make_number (SCHARS (string)),
1323 print_prune_charset_plist, string);
1324 }
1325 else
1326 Fset_text_properties (make_number (0), make_number (SCHARS (string)),
1327 Qnil, string);
1328 }
1329 return string;
1330 }
1331
1332 static void
1333 print_object (Lisp_Object obj, Lisp_Object printcharfun, bool escapeflag)
1334 {
1335 char buf[max (sizeof "from..to..in " + 2 * INT_STRLEN_BOUND (EMACS_INT),
1336 max (sizeof " . #" + INT_STRLEN_BOUND (printmax_t),
1337 40))];
1338
1339 QUIT;
1340
1341 /* Detect circularities and truncate them. */
1342 if (NILP (Vprint_circle))
1343 {
1344 /* Simple but incomplete way. */
1345 int i;
1346
1347 /* See similar code in print_preprocess. */
1348 if (print_depth >= PRINT_CIRCLE)
1349 error ("Apparently circular structure being printed");
1350
1351 for (i = 0; i < print_depth; i++)
1352 if (EQ (obj, being_printed[i]))
1353 {
1354 int len = sprintf (buf, "#%d", i);
1355 strout (buf, len, len, printcharfun);
1356 return;
1357 }
1358 being_printed[print_depth] = obj;
1359 }
1360 else if (PRINT_CIRCLE_CANDIDATE_P (obj))
1361 {
1362 /* With the print-circle feature. */
1363 Lisp_Object num = Fgethash (obj, Vprint_number_table, Qnil);
1364 if (INTEGERP (num))
1365 {
1366 EMACS_INT n = XINT (num);
1367 if (n < 0)
1368 { /* Add a prefix #n= if OBJ has not yet been printed;
1369 that is, its status field is nil. */
1370 int len = sprintf (buf, "#%"pI"d=", -n);
1371 strout (buf, len, len, printcharfun);
1372 /* OBJ is going to be printed. Remember that fact. */
1373 Fputhash (obj, make_number (- n), Vprint_number_table);
1374 }
1375 else
1376 {
1377 /* Just print #n# if OBJ has already been printed. */
1378 int len = sprintf (buf, "#%"pI"d#", n);
1379 strout (buf, len, len, printcharfun);
1380 return;
1381 }
1382 }
1383 }
1384
1385 print_depth++;
1386
1387 switch (XTYPE (obj))
1388 {
1389 case_Lisp_Int:
1390 {
1391 int len = sprintf (buf, "%"pI"d", XINT (obj));
1392 strout (buf, len, len, printcharfun);
1393 }
1394 break;
1395
1396 case Lisp_Float:
1397 {
1398 char pigbuf[FLOAT_TO_STRING_BUFSIZE];
1399 int len = float_to_string (pigbuf, XFLOAT_DATA (obj));
1400 strout (pigbuf, len, len, printcharfun);
1401 }
1402 break;
1403
1404 case Lisp_String:
1405 if (!escapeflag)
1406 print_string (obj, printcharfun);
1407 else
1408 {
1409 register ptrdiff_t i, i_byte;
1410 struct gcpro gcpro1;
1411 ptrdiff_t size_byte;
1412 /* 1 means we must ensure that the next character we output
1413 cannot be taken as part of a hex character escape. */
1414 bool need_nonhex = 0;
1415 bool multibyte = STRING_MULTIBYTE (obj);
1416
1417 GCPRO1 (obj);
1418
1419 if (! EQ (Vprint_charset_text_property, Qt))
1420 obj = print_prune_string_charset (obj);
1421
1422 if (string_intervals (obj))
1423 {
1424 PRINTCHAR ('#');
1425 PRINTCHAR ('(');
1426 }
1427
1428 PRINTCHAR ('\"');
1429 size_byte = SBYTES (obj);
1430
1431 for (i = 0, i_byte = 0; i_byte < size_byte;)
1432 {
1433 /* Here, we must convert each multi-byte form to the
1434 corresponding character code before handing it to PRINTCHAR. */
1435 int c;
1436
1437 FETCH_STRING_CHAR_ADVANCE (c, obj, i, i_byte);
1438
1439 QUIT;
1440
1441 if (c == '\n' && print_escape_newlines)
1442 {
1443 PRINTCHAR ('\\');
1444 PRINTCHAR ('n');
1445 }
1446 else if (c == '\f' && print_escape_newlines)
1447 {
1448 PRINTCHAR ('\\');
1449 PRINTCHAR ('f');
1450 }
1451 else if (multibyte
1452 && (CHAR_BYTE8_P (c)
1453 || (! ASCII_CHAR_P (c) && print_escape_multibyte)))
1454 {
1455 /* When multibyte is disabled,
1456 print multibyte string chars using hex escapes.
1457 For a char code that could be in a unibyte string,
1458 when found in a multibyte string, always use a hex escape
1459 so it reads back as multibyte. */
1460 char outbuf[50];
1461 int len;
1462
1463 if (CHAR_BYTE8_P (c))
1464 len = sprintf (outbuf, "\\%03o", CHAR_TO_BYTE8 (c));
1465 else
1466 {
1467 len = sprintf (outbuf, "\\x%04x", c);
1468 need_nonhex = 1;
1469 }
1470 strout (outbuf, len, len, printcharfun);
1471 }
1472 else if (! multibyte
1473 && SINGLE_BYTE_CHAR_P (c) && ! ASCII_CHAR_P (c)
1474 && print_escape_nonascii)
1475 {
1476 /* When printing in a multibyte buffer
1477 or when explicitly requested,
1478 print single-byte non-ASCII string chars
1479 using octal escapes. */
1480 char outbuf[5];
1481 int len = sprintf (outbuf, "\\%03o", c);
1482 strout (outbuf, len, len, printcharfun);
1483 }
1484 else
1485 {
1486 /* If we just had a hex escape, and this character
1487 could be taken as part of it,
1488 output `\ ' to prevent that. */
1489 if (need_nonhex)
1490 {
1491 need_nonhex = 0;
1492 if ((c >= 'a' && c <= 'f')
1493 || (c >= 'A' && c <= 'F')
1494 || (c >= '0' && c <= '9'))
1495 strout ("\\ ", -1, -1, printcharfun);
1496 }
1497
1498 if (c == '\"' || c == '\\')
1499 PRINTCHAR ('\\');
1500 PRINTCHAR (c);
1501 }
1502 }
1503 PRINTCHAR ('\"');
1504
1505 if (string_intervals (obj))
1506 {
1507 traverse_intervals (string_intervals (obj),
1508 0, print_interval, printcharfun);
1509 PRINTCHAR (')');
1510 }
1511
1512 UNGCPRO;
1513 }
1514 break;
1515
1516 case Lisp_Symbol:
1517 {
1518 bool confusing;
1519 unsigned char *p = SDATA (SYMBOL_NAME (obj));
1520 unsigned char *end = p + SBYTES (SYMBOL_NAME (obj));
1521 int c;
1522 ptrdiff_t i, i_byte;
1523 ptrdiff_t size_byte;
1524 Lisp_Object name;
1525
1526 name = SYMBOL_NAME (obj);
1527
1528 if (p != end && (*p == '-' || *p == '+')) p++;
1529 if (p == end)
1530 confusing = 0;
1531 /* If symbol name begins with a digit, and ends with a digit,
1532 and contains nothing but digits and `e', it could be treated
1533 as a number. So set CONFUSING.
1534
1535 Symbols that contain periods could also be taken as numbers,
1536 but periods are always escaped, so we don't have to worry
1537 about them here. */
1538 else if (*p >= '0' && *p <= '9'
1539 && end[-1] >= '0' && end[-1] <= '9')
1540 {
1541 while (p != end && ((*p >= '0' && *p <= '9')
1542 /* Needed for \2e10. */
1543 || *p == 'e' || *p == 'E'))
1544 p++;
1545 confusing = (end == p);
1546 }
1547 else
1548 confusing = 0;
1549
1550 size_byte = SBYTES (name);
1551
1552 if (! NILP (Vprint_gensym) && !SYMBOL_INTERNED_P (obj))
1553 {
1554 PRINTCHAR ('#');
1555 PRINTCHAR (':');
1556 }
1557 else if (size_byte == 0)
1558 {
1559 PRINTCHAR ('#');
1560 PRINTCHAR ('#');
1561 break;
1562 }
1563
1564 for (i = 0, i_byte = 0; i_byte < size_byte;)
1565 {
1566 /* Here, we must convert each multi-byte form to the
1567 corresponding character code before handing it to PRINTCHAR. */
1568 FETCH_STRING_CHAR_ADVANCE (c, name, i, i_byte);
1569 QUIT;
1570
1571 if (escapeflag)
1572 {
1573 if (c == '\"' || c == '\\' || c == '\''
1574 || c == ';' || c == '#' || c == '(' || c == ')'
1575 || c == ',' || c == '.' || c == '`'
1576 || c == '[' || c == ']' || c == '?' || c <= 040
1577 || confusing)
1578 PRINTCHAR ('\\'), confusing = 0;
1579 }
1580 PRINTCHAR (c);
1581 }
1582 }
1583 break;
1584
1585 case Lisp_Cons:
1586 /* If deeper than spec'd depth, print placeholder. */
1587 if (INTEGERP (Vprint_level)
1588 && print_depth > XINT (Vprint_level))
1589 strout ("...", -1, -1, printcharfun);
1590 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1591 && (EQ (XCAR (obj), Qquote)))
1592 {
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), Qfunction)))
1598 {
1599 PRINTCHAR ('#');
1600 PRINTCHAR ('\'');
1601 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1602 }
1603 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1604 && ((EQ (XCAR (obj), Qbackquote))))
1605 {
1606 print_object (XCAR (obj), printcharfun, 0);
1607 new_backquote_output++;
1608 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1609 new_backquote_output--;
1610 }
1611 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1612 && new_backquote_output
1613 && ((EQ (XCAR (obj), Qbackquote)
1614 || EQ (XCAR (obj), Qcomma)
1615 || EQ (XCAR (obj), Qcomma_at)
1616 || EQ (XCAR (obj), Qcomma_dot))))
1617 {
1618 print_object (XCAR (obj), printcharfun, 0);
1619 new_backquote_output--;
1620 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1621 new_backquote_output++;
1622 }
1623 else
1624 {
1625 PRINTCHAR ('(');
1626
1627 {
1628 printmax_t i, print_length;
1629 Lisp_Object halftail = obj;
1630
1631 /* Negative values of print-length are invalid in CL.
1632 Treat them like nil, as CMUCL does. */
1633 if (NATNUMP (Vprint_length))
1634 print_length = XFASTINT (Vprint_length);
1635 else
1636 print_length = TYPE_MAXIMUM (printmax_t);
1637
1638 i = 0;
1639 while (CONSP (obj))
1640 {
1641 /* Detect circular list. */
1642 if (NILP (Vprint_circle))
1643 {
1644 /* Simple but incomplete way. */
1645 if (i != 0 && EQ (obj, halftail))
1646 {
1647 int len = sprintf (buf, " . #%"pMd, i / 2);
1648 strout (buf, len, len, printcharfun);
1649 goto end_of_list;
1650 }
1651 }
1652 else
1653 {
1654 /* With the print-circle feature. */
1655 if (i != 0)
1656 {
1657 Lisp_Object num = Fgethash (obj, Vprint_number_table, Qnil);
1658 if (INTEGERP (num))
1659 {
1660 strout (" . ", 3, 3, printcharfun);
1661 print_object (obj, printcharfun, escapeflag);
1662 goto end_of_list;
1663 }
1664 }
1665 }
1666
1667 if (i)
1668 PRINTCHAR (' ');
1669
1670 if (print_length <= i)
1671 {
1672 strout ("...", 3, 3, printcharfun);
1673 goto end_of_list;
1674 }
1675
1676 i++;
1677 print_object (XCAR (obj), printcharfun, escapeflag);
1678
1679 obj = XCDR (obj);
1680 if (!(i & 1))
1681 halftail = XCDR (halftail);
1682 }
1683 }
1684
1685 /* OBJ non-nil here means it's the end of a dotted list. */
1686 if (!NILP (obj))
1687 {
1688 strout (" . ", 3, 3, printcharfun);
1689 print_object (obj, printcharfun, escapeflag);
1690 }
1691
1692 end_of_list:
1693 PRINTCHAR (')');
1694 }
1695 break;
1696
1697 case Lisp_Vectorlike:
1698 if (PROCESSP (obj))
1699 {
1700 if (escapeflag)
1701 {
1702 strout ("#<process ", -1, -1, printcharfun);
1703 print_string (XPROCESS (obj)->name, printcharfun);
1704 PRINTCHAR ('>');
1705 }
1706 else
1707 print_string (XPROCESS (obj)->name, printcharfun);
1708 }
1709 else if (BOOL_VECTOR_P (obj))
1710 {
1711 ptrdiff_t i;
1712 int len;
1713 unsigned char c;
1714 struct gcpro gcpro1;
1715 EMACS_INT size = bool_vector_size (obj);
1716 ptrdiff_t size_in_chars = bool_vector_bytes (size);
1717 ptrdiff_t real_size_in_chars = size_in_chars;
1718 GCPRO1 (obj);
1719
1720 PRINTCHAR ('#');
1721 PRINTCHAR ('&');
1722 len = sprintf (buf, "%"pI"d", 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 = bool_vector_uchar_data (obj)[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
1763 if (size_in_chars < real_size_in_chars)
1764 strout (" ...", 4, 4, printcharfun);
1765 PRINTCHAR ('\"');
1766
1767 UNGCPRO;
1768 }
1769 else if (SUBRP (obj))
1770 {
1771 strout ("#<subr ", -1, -1, printcharfun);
1772 strout (XSUBR (obj)->symbol_name, -1, -1, printcharfun);
1773 PRINTCHAR ('>');
1774 }
1775 else if (WINDOWP (obj))
1776 {
1777 int len;
1778 strout ("#<window ", -1, -1, printcharfun);
1779 len = sprintf (buf, "%d", XWINDOW (obj)->sequence_number);
1780 strout (buf, len, len, printcharfun);
1781 if (BUFFERP (XWINDOW (obj)->contents))
1782 {
1783 strout (" on ", -1, -1, printcharfun);
1784 print_string (BVAR (XBUFFER (XWINDOW (obj)->contents), name),
1785 printcharfun);
1786 }
1787 PRINTCHAR ('>');
1788 }
1789 else if (TERMINALP (obj))
1790 {
1791 int len;
1792 struct terminal *t = XTERMINAL (obj);
1793 strout ("#<terminal ", -1, -1, printcharfun);
1794 len = sprintf (buf, "%d", t->id);
1795 strout (buf, len, len, printcharfun);
1796 if (t->name)
1797 {
1798 strout (" on ", -1, -1, printcharfun);
1799 strout (t->name, -1, -1, printcharfun);
1800 }
1801 PRINTCHAR ('>');
1802 }
1803 else if (HASH_TABLE_P (obj))
1804 {
1805 struct Lisp_Hash_Table *h = XHASH_TABLE (obj);
1806 ptrdiff_t i;
1807 ptrdiff_t real_size, size;
1808 int len;
1809 #if 0
1810 void *ptr = h;
1811 strout ("#<hash-table", -1, -1, printcharfun);
1812 if (SYMBOLP (h->test))
1813 {
1814 PRINTCHAR (' ');
1815 PRINTCHAR ('\'');
1816 strout (SDATA (SYMBOL_NAME (h->test)), -1, -1, printcharfun);
1817 PRINTCHAR (' ');
1818 strout (SDATA (SYMBOL_NAME (h->weak)), -1, -1, printcharfun);
1819 PRINTCHAR (' ');
1820 len = sprintf (buf, "%"pD"d/%"pD"d", h->count, ASIZE (h->next));
1821 strout (buf, len, len, printcharfun);
1822 }
1823 len = sprintf (buf, " %p>", ptr);
1824 strout (buf, len, len, printcharfun);
1825 #endif
1826 /* Implement a readable output, e.g.:
1827 #s(hash-table size 2 test equal data (k1 v1 k2 v2)) */
1828 /* Always print the size. */
1829 len = sprintf (buf, "#s(hash-table size %"pD"d", ASIZE (h->next));
1830 strout (buf, len, len, printcharfun);
1831
1832 if (!NILP (h->test.name))
1833 {
1834 strout (" test ", -1, -1, printcharfun);
1835 print_object (h->test.name, printcharfun, escapeflag);
1836 }
1837
1838 if (!NILP (h->weak))
1839 {
1840 strout (" weakness ", -1, -1, printcharfun);
1841 print_object (h->weak, printcharfun, escapeflag);
1842 }
1843
1844 if (!NILP (h->rehash_size))
1845 {
1846 strout (" rehash-size ", -1, -1, printcharfun);
1847 print_object (h->rehash_size, printcharfun, escapeflag);
1848 }
1849
1850 if (!NILP (h->rehash_threshold))
1851 {
1852 strout (" rehash-threshold ", -1, -1, printcharfun);
1853 print_object (h->rehash_threshold, printcharfun, escapeflag);
1854 }
1855
1856 strout (" data ", -1, -1, printcharfun);
1857
1858 /* Print the data here as a plist. */
1859 real_size = HASH_TABLE_SIZE (h);
1860 size = real_size;
1861
1862 /* Don't print more elements than the specified maximum. */
1863 if (NATNUMP (Vprint_length)
1864 && XFASTINT (Vprint_length) < size)
1865 size = XFASTINT (Vprint_length);
1866
1867 PRINTCHAR ('(');
1868 for (i = 0; i < size; i++)
1869 if (!NILP (HASH_HASH (h, i)))
1870 {
1871 if (i) PRINTCHAR (' ');
1872 print_object (HASH_KEY (h, i), printcharfun, escapeflag);
1873 PRINTCHAR (' ');
1874 print_object (HASH_VALUE (h, i), printcharfun, escapeflag);
1875 }
1876
1877 if (size < real_size)
1878 strout (" ...", 4, 4, printcharfun);
1879
1880 PRINTCHAR (')');
1881 PRINTCHAR (')');
1882
1883 }
1884 else if (BUFFERP (obj))
1885 {
1886 if (!BUFFER_LIVE_P (XBUFFER (obj)))
1887 strout ("#<killed buffer>", -1, -1, printcharfun);
1888 else if (escapeflag)
1889 {
1890 strout ("#<buffer ", -1, -1, printcharfun);
1891 print_string (BVAR (XBUFFER (obj), name), printcharfun);
1892 PRINTCHAR ('>');
1893 }
1894 else
1895 print_string (BVAR (XBUFFER (obj), name), printcharfun);
1896 }
1897 else if (WINDOW_CONFIGURATIONP (obj))
1898 {
1899 strout ("#<window-configuration>", -1, -1, printcharfun);
1900 }
1901 else if (FRAMEP (obj))
1902 {
1903 int len;
1904 void *ptr = XFRAME (obj);
1905 Lisp_Object frame_name = XFRAME (obj)->name;
1906
1907 strout ((FRAME_LIVE_P (XFRAME (obj))
1908 ? "#<frame " : "#<dead frame "),
1909 -1, -1, printcharfun);
1910 if (!STRINGP (frame_name))
1911 {
1912 /* A frame could be too young and have no name yet;
1913 don't crash. */
1914 if (SYMBOLP (frame_name))
1915 frame_name = Fsymbol_name (frame_name);
1916 else /* can't happen: name should be either nil or string */
1917 frame_name = build_string ("*INVALID*FRAME*NAME*");
1918 }
1919 print_string (frame_name, printcharfun);
1920 len = sprintf (buf, " %p>", ptr);
1921 strout (buf, len, len, printcharfun);
1922 }
1923 else if (FONTP (obj))
1924 {
1925 int i;
1926
1927 if (! FONT_OBJECT_P (obj))
1928 {
1929 if (FONT_SPEC_P (obj))
1930 strout ("#<font-spec", -1, -1, printcharfun);
1931 else
1932 strout ("#<font-entity", -1, -1, printcharfun);
1933 for (i = 0; i < FONT_SPEC_MAX; i++)
1934 {
1935 PRINTCHAR (' ');
1936 if (i < FONT_WEIGHT_INDEX || i > FONT_WIDTH_INDEX)
1937 print_object (AREF (obj, i), printcharfun, escapeflag);
1938 else
1939 print_object (font_style_symbolic (obj, i, 0),
1940 printcharfun, escapeflag);
1941 }
1942 }
1943 else
1944 {
1945 strout ("#<font-object ", -1, -1, printcharfun);
1946 print_object (AREF (obj, FONT_NAME_INDEX), printcharfun,
1947 escapeflag);
1948 }
1949 PRINTCHAR ('>');
1950 }
1951 else
1952 {
1953 ptrdiff_t size = ASIZE (obj);
1954 if (COMPILEDP (obj))
1955 {
1956 PRINTCHAR ('#');
1957 size &= PSEUDOVECTOR_SIZE_MASK;
1958 }
1959 if (CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj))
1960 {
1961 /* We print a char-table as if it were a vector,
1962 lumping the parent and default slots in with the
1963 character slots. But we add #^ as a prefix. */
1964
1965 /* Make each lowest sub_char_table start a new line.
1966 Otherwise we'll make a line extremely long, which
1967 results in slow redisplay. */
1968 if (SUB_CHAR_TABLE_P (obj)
1969 && XINT (XSUB_CHAR_TABLE (obj)->depth) == 3)
1970 PRINTCHAR ('\n');
1971 PRINTCHAR ('#');
1972 PRINTCHAR ('^');
1973 if (SUB_CHAR_TABLE_P (obj))
1974 PRINTCHAR ('^');
1975 size &= PSEUDOVECTOR_SIZE_MASK;
1976 }
1977 if (size & PSEUDOVECTOR_FLAG)
1978 goto badtype;
1979
1980 PRINTCHAR ('[');
1981 {
1982 register int i;
1983 register Lisp_Object tem;
1984 ptrdiff_t real_size = size;
1985
1986 /* Don't print more elements than the specified maximum. */
1987 if (NATNUMP (Vprint_length)
1988 && XFASTINT (Vprint_length) < size)
1989 size = XFASTINT (Vprint_length);
1990
1991 for (i = 0; i < size; i++)
1992 {
1993 if (i) PRINTCHAR (' ');
1994 tem = AREF (obj, i);
1995 print_object (tem, printcharfun, escapeflag);
1996 }
1997 if (size < real_size)
1998 strout (" ...", 4, 4, printcharfun);
1999 }
2000 PRINTCHAR (']');
2001 }
2002 break;
2003
2004 case Lisp_Misc:
2005 switch (XMISCTYPE (obj))
2006 {
2007 case Lisp_Misc_Marker:
2008 strout ("#<marker ", -1, -1, printcharfun);
2009 /* Do you think this is necessary? */
2010 if (XMARKER (obj)->insertion_type != 0)
2011 strout ("(moves after insertion) ", -1, -1, printcharfun);
2012 if (! XMARKER (obj)->buffer)
2013 strout ("in no buffer", -1, -1, printcharfun);
2014 else
2015 {
2016 int len = sprintf (buf, "at %"pD"d", marker_position (obj));
2017 strout (buf, len, len, printcharfun);
2018 strout (" in ", -1, -1, printcharfun);
2019 print_string (BVAR (XMARKER (obj)->buffer, name), printcharfun);
2020 }
2021 PRINTCHAR ('>');
2022 break;
2023
2024 case Lisp_Misc_Overlay:
2025 strout ("#<overlay ", -1, -1, printcharfun);
2026 if (! XMARKER (OVERLAY_START (obj))->buffer)
2027 strout ("in no buffer", -1, -1, printcharfun);
2028 else
2029 {
2030 int len = sprintf (buf, "from %"pD"d to %"pD"d in ",
2031 marker_position (OVERLAY_START (obj)),
2032 marker_position (OVERLAY_END (obj)));
2033 strout (buf, len, len, printcharfun);
2034 print_string (BVAR (XMARKER (OVERLAY_START (obj))->buffer, name),
2035 printcharfun);
2036 }
2037 PRINTCHAR ('>');
2038 break;
2039
2040 /* Remaining cases shouldn't happen in normal usage, but let's
2041 print them anyway for the benefit of the debugger. */
2042
2043 case Lisp_Misc_Free:
2044 strout ("#<misc free cell>", -1, -1, printcharfun);
2045 break;
2046
2047 case Lisp_Misc_Save_Value:
2048 {
2049 int i;
2050 struct Lisp_Save_Value *v = XSAVE_VALUE (obj);
2051
2052 strout ("#<save-value ", -1, -1, printcharfun);
2053
2054 if (v->save_type == SAVE_TYPE_MEMORY)
2055 {
2056 ptrdiff_t amount = v->data[1].integer;
2057
2058 #if GC_MARK_STACK
2059
2060 /* valid_lisp_object_p is reliable, so try to print up
2061 to 8 saved objects. This code is rarely used, so
2062 it's OK that valid_lisp_object_p is slow. */
2063
2064 int limit = min (amount, 8);
2065 Lisp_Object *area = v->data[0].pointer;
2066
2067 i = sprintf (buf, "with %"pD"d objects", amount);
2068 strout (buf, i, i, printcharfun);
2069
2070 for (i = 0; i < limit; i++)
2071 {
2072 Lisp_Object maybe = area[i];
2073
2074 if (valid_lisp_object_p (maybe) > 0)
2075 {
2076 PRINTCHAR (' ');
2077 print_object (maybe, printcharfun, escapeflag);
2078 }
2079 else
2080 strout (" <invalid>", -1, -1, printcharfun);
2081 }
2082 if (i == limit && i < amount)
2083 strout (" ...", 4, 4, printcharfun);
2084
2085 #else /* not GC_MARK_STACK */
2086
2087 /* There is no reliable way to determine whether the objects
2088 are initialized, so do not try to print them. */
2089
2090 i = sprintf (buf, "with %"pD"d objects", amount);
2091 strout (buf, i, i, printcharfun);
2092
2093 #endif /* GC_MARK_STACK */
2094 }
2095 else
2096 {
2097 /* Print each slot according to its type. */
2098 int index;
2099 for (index = 0; index < SAVE_VALUE_SLOTS; index++)
2100 {
2101 if (index)
2102 PRINTCHAR (' ');
2103
2104 switch (save_type (v, index))
2105 {
2106 case SAVE_UNUSED:
2107 i = sprintf (buf, "<unused>");
2108 break;
2109
2110 case SAVE_POINTER:
2111 i = sprintf (buf, "<pointer %p>",
2112 v->data[index].pointer);
2113 break;
2114
2115 case SAVE_FUNCPOINTER:
2116 i = sprintf (buf, "<funcpointer %p>",
2117 ((void *) (intptr_t)
2118 v->data[index].funcpointer));
2119 break;
2120
2121 case SAVE_INTEGER:
2122 i = sprintf (buf, "<integer %"pD"d>",
2123 v->data[index].integer);
2124 break;
2125
2126 case SAVE_OBJECT:
2127 print_object (v->data[index].object, printcharfun,
2128 escapeflag);
2129 continue;
2130
2131 default:
2132 emacs_abort ();
2133 }
2134
2135 strout (buf, i, i, printcharfun);
2136 }
2137 }
2138 PRINTCHAR ('>');
2139 }
2140 break;
2141
2142 default:
2143 goto badtype;
2144 }
2145 break;
2146
2147 default:
2148 badtype:
2149 {
2150 int len;
2151 /* We're in trouble if this happens!
2152 Probably should just emacs_abort (). */
2153 strout ("#<EMACS BUG: INVALID DATATYPE ", -1, -1, printcharfun);
2154 if (MISCP (obj))
2155 len = sprintf (buf, "(MISC 0x%04x)", (int) XMISCTYPE (obj));
2156 else if (VECTORLIKEP (obj))
2157 len = sprintf (buf, "(PVEC 0x%08"pD"x)", ASIZE (obj));
2158 else
2159 len = sprintf (buf, "(0x%02x)", (int) XTYPE (obj));
2160 strout (buf, len, len, printcharfun);
2161 strout (" Save your buffers immediately and please report this bug>",
2162 -1, -1, printcharfun);
2163 }
2164 }
2165
2166 print_depth--;
2167 }
2168 \f
2169
2170 /* Print a description of INTERVAL using PRINTCHARFUN.
2171 This is part of printing a string that has text properties. */
2172
2173 static void
2174 print_interval (INTERVAL interval, Lisp_Object printcharfun)
2175 {
2176 if (NILP (interval->plist))
2177 return;
2178 PRINTCHAR (' ');
2179 print_object (make_number (interval->position), printcharfun, 1);
2180 PRINTCHAR (' ');
2181 print_object (make_number (interval->position + LENGTH (interval)),
2182 printcharfun, 1);
2183 PRINTCHAR (' ');
2184 print_object (interval->plist, printcharfun, 1);
2185 }
2186
2187 /* Initialize debug_print stuff early to have it working from the very
2188 beginning. */
2189
2190 void
2191 init_print_once (void)
2192 {
2193 DEFSYM (Qexternal_debugging_output, "external-debugging-output");
2194 defsubr (&Sexternal_debugging_output);
2195 }
2196
2197 void
2198 syms_of_print (void)
2199 {
2200 #include "print.x"
2201
2202 DEFSYM (Qtemp_buffer_setup_hook, "temp-buffer-setup-hook");
2203
2204 DEFVAR_LISP ("standard-output", Vstandard_output,
2205 doc: /* Output stream `print' uses by default for outputting a character.
2206 This may be any function of one argument.
2207 It may also be a buffer (output is inserted before point)
2208 or a marker (output is inserted and the marker is advanced)
2209 or the symbol t (output appears in the echo area). */);
2210 Vstandard_output = Qt;
2211 DEFSYM (Qstandard_output, "standard-output");
2212
2213 DEFVAR_LISP ("float-output-format", Vfloat_output_format,
2214 doc: /* The format descriptor string used to print floats.
2215 This is a %-spec like those accepted by `printf' in C,
2216 but with some restrictions. It must start with the two characters `%.'.
2217 After that comes an integer precision specification,
2218 and then a letter which controls the format.
2219 The letters allowed are `e', `f' and `g'.
2220 Use `e' for exponential notation \"DIG.DIGITSeEXPT\"
2221 Use `f' for decimal point notation \"DIGITS.DIGITS\".
2222 Use `g' to choose the shorter of those two formats for the number at hand.
2223 The precision in any of these cases is the number of digits following
2224 the decimal point. With `f', a precision of 0 means to omit the
2225 decimal point. 0 is not allowed with `e' or `g'.
2226
2227 A value of nil means to use the shortest notation
2228 that represents the number without losing information. */);
2229 Vfloat_output_format = Qnil;
2230 DEFSYM (Qfloat_output_format, "float-output-format");
2231
2232 DEFVAR_LISP ("print-length", Vprint_length,
2233 doc: /* Maximum length of list to print before abbreviating.
2234 A value of nil means no limit. See also `eval-expression-print-length'. */);
2235 Vprint_length = Qnil;
2236
2237 DEFVAR_LISP ("print-level", Vprint_level,
2238 doc: /* Maximum depth of list nesting to print before abbreviating.
2239 A value of nil means no limit. See also `eval-expression-print-level'. */);
2240 Vprint_level = Qnil;
2241
2242 DEFVAR_BOOL ("print-escape-newlines", print_escape_newlines,
2243 doc: /* Non-nil means print newlines in strings as `\\n'.
2244 Also print formfeeds as `\\f'. */);
2245 print_escape_newlines = 0;
2246
2247 DEFVAR_BOOL ("print-escape-nonascii", print_escape_nonascii,
2248 doc: /* Non-nil means print unibyte non-ASCII chars in strings as \\OOO.
2249 \(OOO is the octal representation of the character code.)
2250 Only single-byte characters are affected, and only in `prin1'.
2251 When the output goes in a multibyte buffer, this feature is
2252 enabled regardless of the value of the variable. */);
2253 print_escape_nonascii = 0;
2254
2255 DEFVAR_BOOL ("print-escape-multibyte", print_escape_multibyte,
2256 doc: /* Non-nil means print multibyte characters in strings as \\xXXXX.
2257 \(XXXX is the hex representation of the character code.)
2258 This affects only `prin1'. */);
2259 print_escape_multibyte = 0;
2260
2261 DEFVAR_BOOL ("print-quoted", print_quoted,
2262 doc: /* Non-nil means print quoted forms with reader syntax.
2263 I.e., (quote foo) prints as 'foo, (function foo) as #'foo. */);
2264 print_quoted = 0;
2265
2266 DEFVAR_LISP ("print-gensym", Vprint_gensym,
2267 doc: /* Non-nil means print uninterned symbols so they will read as uninterned.
2268 I.e., the value of (make-symbol \"foobar\") prints as #:foobar.
2269 When the uninterned symbol appears within a recursive data structure,
2270 and the symbol appears more than once, in addition use the #N# and #N=
2271 constructs as needed, so that multiple references to the same symbol are
2272 shared once again when the text is read back. */);
2273 Vprint_gensym = Qnil;
2274
2275 DEFVAR_LISP ("print-circle", Vprint_circle,
2276 doc: /* Non-nil means print recursive structures using #N= and #N# syntax.
2277 If nil, printing proceeds recursively and may lead to
2278 `max-lisp-eval-depth' being exceeded or an error may occur:
2279 \"Apparently circular structure being printed.\" Also see
2280 `print-length' and `print-level'.
2281 If non-nil, shared substructures anywhere in the structure are printed
2282 with `#N=' before the first occurrence (in the order of the print
2283 representation) and `#N#' in place of each subsequent occurrence,
2284 where N is a positive decimal integer. */);
2285 Vprint_circle = Qnil;
2286
2287 DEFVAR_LISP ("print-continuous-numbering", Vprint_continuous_numbering,
2288 doc: /* Non-nil means number continuously across print calls.
2289 This affects the numbers printed for #N= labels and #M# references.
2290 See also `print-circle', `print-gensym', and `print-number-table'.
2291 This variable should not be set with `setq'; bind it with a `let' instead. */);
2292 Vprint_continuous_numbering = Qnil;
2293
2294 DEFVAR_LISP ("print-number-table", Vprint_number_table,
2295 doc: /* A vector used internally to produce `#N=' labels and `#N#' references.
2296 The Lisp printer uses this vector to detect Lisp objects referenced more
2297 than once.
2298
2299 When you bind `print-continuous-numbering' to t, you should probably
2300 also bind `print-number-table' to nil. This ensures that the value of
2301 `print-number-table' can be garbage-collected once the printing is
2302 done. If all elements of `print-number-table' are nil, it means that
2303 the printing done so far has not found any shared structure or objects
2304 that need to be recorded in the table. */);
2305 Vprint_number_table = Qnil;
2306
2307 DEFVAR_LISP ("print-charset-text-property", Vprint_charset_text_property,
2308 doc: /* A flag to control printing of `charset' text property on printing a string.
2309 The value must be nil, t, or `default'.
2310
2311 If the value is nil, don't print the text property `charset'.
2312
2313 If the value is t, always print the text property `charset'.
2314
2315 If the value is `default', print the text property `charset' only when
2316 the value is different from what is guessed in the current charset
2317 priorities. */);
2318 Vprint_charset_text_property = Qdefault;
2319
2320 /* prin1_to_string_buffer initialized in init_buffer_once in buffer.c */
2321 staticpro (&Vprin1_to_string_buffer);
2322
2323 DEFSYM (Qprint_escape_newlines, "print-escape-newlines");
2324 DEFSYM (Qprint_escape_multibyte, "print-escape-multibyte");
2325 DEFSYM (Qprint_escape_nonascii, "print-escape-nonascii");
2326
2327 print_prune_charset_plist = Qnil;
2328 staticpro (&print_prune_charset_plist);
2329 }