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