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