Use offsets relative to top rather than bottom for stack refs
[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 /* 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, 0, 0, data);
1013 }
1014 else /* oink oink */
1015 {
1016 /* Check that the spec we have is fully valid.
1017 This means not only valid for printf,
1018 but meant for floats, and reasonable. */
1019 cp = SSDATA (Vfloat_output_format);
1020
1021 if (cp[0] != '%')
1022 goto lose;
1023 if (cp[1] != '.')
1024 goto lose;
1025
1026 cp += 2;
1027
1028 /* Check the width specification. */
1029 width = -1;
1030 if ('0' <= *cp && *cp <= '9')
1031 {
1032 width = 0;
1033 do
1034 width = (width * 10) + (*cp++ - '0');
1035 while (*cp >= '0' && *cp <= '9');
1036
1037 /* A precision of zero is valid only for %f. */
1038 if (width > DBL_DIG
1039 || (width == 0 && *cp != 'f'))
1040 goto lose;
1041 }
1042
1043 if (*cp != 'e' && *cp != 'f' && *cp != 'g')
1044 goto lose;
1045
1046 if (cp[1] != 0)
1047 goto lose;
1048
1049 sprintf (buf, SSDATA (Vfloat_output_format), data);
1050 }
1051
1052 /* Make sure there is a decimal point with digit after, or an
1053 exponent, so that the value is readable as a float. But don't do
1054 this with "%.0f"; it's valid for that not to produce a decimal
1055 point. Note that width can be 0 only for %.0f. */
1056 if (width != 0)
1057 {
1058 for (cp = buf; *cp; cp++)
1059 if ((*cp < '0' || *cp > '9') && *cp != '-')
1060 break;
1061
1062 if (*cp == '.' && cp[1] == 0)
1063 {
1064 cp[1] = '0';
1065 cp[2] = 0;
1066 }
1067
1068 if (*cp == 0)
1069 {
1070 *cp++ = '.';
1071 *cp++ = '0';
1072 *cp++ = 0;
1073 }
1074 }
1075 }
1076
1077 \f
1078 static void
1079 print (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag)
1080 {
1081 new_backquote_output = 0;
1082
1083 /* Reset print_number_index and Vprint_number_table only when
1084 the variable Vprint_continuous_numbering is nil. Otherwise,
1085 the values of these variables will be kept between several
1086 print functions. */
1087 if (NILP (Vprint_continuous_numbering)
1088 || NILP (Vprint_number_table))
1089 {
1090 print_number_index = 0;
1091 Vprint_number_table = Qnil;
1092 }
1093
1094 /* Construct Vprint_number_table for print-gensym and print-circle. */
1095 if (!NILP (Vprint_gensym) || !NILP (Vprint_circle))
1096 {
1097 /* Construct Vprint_number_table.
1098 This increments print_number_index for the objects added. */
1099 print_depth = 0;
1100 print_preprocess (obj);
1101
1102 if (HASH_TABLE_P (Vprint_number_table))
1103 { /* Remove unnecessary objects, which appear only once in OBJ;
1104 that is, whose status is Qt.
1105 Maybe a better way to do that is to copy elements to
1106 a new hash table. */
1107 struct Lisp_Hash_Table *h = XHASH_TABLE (Vprint_number_table);
1108 int i;
1109
1110 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1111 if (!NILP (HASH_HASH (h, i))
1112 && EQ (HASH_VALUE (h, i), Qt))
1113 Fremhash (HASH_KEY (h, i), Vprint_number_table);
1114 }
1115 }
1116
1117 print_depth = 0;
1118 print_object (obj, printcharfun, escapeflag);
1119 }
1120
1121 /* Construct Vprint_number_table according to the structure of OBJ.
1122 OBJ itself and all its elements will be added to Vprint_number_table
1123 recursively if it is a list, vector, compiled function, char-table,
1124 string (its text properties will be traced), or a symbol that has
1125 no obarray (this is for the print-gensym feature).
1126 The status fields of Vprint_number_table mean whether each object appears
1127 more than once in OBJ: Qnil at the first time, and Qt after that . */
1128 static void
1129 print_preprocess (Lisp_Object obj)
1130 {
1131 int i;
1132 EMACS_INT size;
1133 int loop_count = 0;
1134 Lisp_Object halftail;
1135
1136 /* Give up if we go so deep that print_object will get an error. */
1137 /* See similar code in print_object. */
1138 if (print_depth >= PRINT_CIRCLE)
1139 error ("Apparently circular structure being printed");
1140
1141 /* Avoid infinite recursion for circular nested structure
1142 in the case where Vprint_circle is nil. */
1143 if (NILP (Vprint_circle))
1144 {
1145 for (i = 0; i < print_depth; i++)
1146 if (EQ (obj, being_printed[i]))
1147 return;
1148 being_printed[print_depth] = obj;
1149 }
1150
1151 print_depth++;
1152 halftail = obj;
1153
1154 loop:
1155 if (STRINGP (obj) || CONSP (obj) || VECTORP (obj)
1156 || FUNVECP (obj) || CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj)
1157 || HASH_TABLE_P (obj)
1158 || (! NILP (Vprint_gensym)
1159 && SYMBOLP (obj)
1160 && !SYMBOL_INTERNED_P (obj)))
1161 {
1162 if (!HASH_TABLE_P (Vprint_number_table))
1163 {
1164 Lisp_Object args[2];
1165 args[0] = QCtest;
1166 args[1] = Qeq;
1167 Vprint_number_table = Fmake_hash_table (2, args);
1168 }
1169
1170 /* In case print-circle is nil and print-gensym is t,
1171 add OBJ to Vprint_number_table only when OBJ is a symbol. */
1172 if (! NILP (Vprint_circle) || SYMBOLP (obj))
1173 {
1174 Lisp_Object num = Fgethash (obj, Vprint_number_table, Qnil);
1175 if (!NILP (num)
1176 /* If Vprint_continuous_numbering is non-nil and OBJ is a gensym,
1177 always print the gensym with a number. This is a special for
1178 the lisp function byte-compile-output-docform. */
1179 || (!NILP (Vprint_continuous_numbering)
1180 && SYMBOLP (obj)
1181 && !SYMBOL_INTERNED_P (obj)))
1182 { /* OBJ appears more than once. Let's remember that. */
1183 if (!INTEGERP (num))
1184 {
1185 print_number_index++;
1186 /* Negative number indicates it hasn't been printed yet. */
1187 Fputhash (obj, make_number (- print_number_index),
1188 Vprint_number_table);
1189 }
1190 print_depth--;
1191 return;
1192 }
1193 else
1194 /* OBJ is not yet recorded. Let's add to the table. */
1195 Fputhash (obj, Qt, Vprint_number_table);
1196 }
1197
1198 switch (XTYPE (obj))
1199 {
1200 case Lisp_String:
1201 /* A string may have text properties, which can be circular. */
1202 traverse_intervals_noorder (STRING_INTERVALS (obj),
1203 print_preprocess_string, Qnil);
1204 break;
1205
1206 case Lisp_Cons:
1207 /* Use HALFTAIL and LOOP_COUNT to detect circular lists,
1208 just as in print_object. */
1209 if (loop_count && EQ (obj, halftail))
1210 break;
1211 print_preprocess (XCAR (obj));
1212 obj = XCDR (obj);
1213 loop_count++;
1214 if (!(loop_count & 1))
1215 halftail = XCDR (halftail);
1216 goto loop;
1217
1218 case Lisp_Vectorlike:
1219 size = XVECTOR (obj)->size;
1220 if (size & PSEUDOVECTOR_FLAG)
1221 size &= PSEUDOVECTOR_SIZE_MASK;
1222 for (i = 0; i < size; i++)
1223 print_preprocess (XVECTOR (obj)->contents[i]);
1224 if (HASH_TABLE_P (obj))
1225 { /* For hash tables, the key_and_value slot is past
1226 `size' because it needs to be marked specially in case
1227 the table is weak. */
1228 struct Lisp_Hash_Table *h = XHASH_TABLE (obj);
1229 print_preprocess (h->key_and_value);
1230 }
1231 break;
1232
1233 default:
1234 break;
1235 }
1236 }
1237 print_depth--;
1238 }
1239
1240 static void
1241 print_preprocess_string (INTERVAL interval, Lisp_Object arg)
1242 {
1243 print_preprocess (interval->plist);
1244 }
1245
1246 static void print_check_string_charset_prop (INTERVAL interval, Lisp_Object string);
1247
1248 #define PRINT_STRING_NON_CHARSET_FOUND 1
1249 #define PRINT_STRING_UNSAFE_CHARSET_FOUND 2
1250
1251 /* Bitwise or of the above macros. */
1252 static int print_check_string_result;
1253
1254 static void
1255 print_check_string_charset_prop (INTERVAL interval, Lisp_Object string)
1256 {
1257 Lisp_Object val;
1258
1259 if (NILP (interval->plist)
1260 || (print_check_string_result == (PRINT_STRING_NON_CHARSET_FOUND
1261 | PRINT_STRING_UNSAFE_CHARSET_FOUND)))
1262 return;
1263 for (val = interval->plist; CONSP (val) && ! EQ (XCAR (val), Qcharset);
1264 val = XCDR (XCDR (val)));
1265 if (! CONSP (val))
1266 {
1267 print_check_string_result |= PRINT_STRING_NON_CHARSET_FOUND;
1268 return;
1269 }
1270 if (! (print_check_string_result & PRINT_STRING_NON_CHARSET_FOUND))
1271 {
1272 if (! EQ (val, interval->plist)
1273 || CONSP (XCDR (XCDR (val))))
1274 print_check_string_result |= PRINT_STRING_NON_CHARSET_FOUND;
1275 }
1276 if (NILP (Vprint_charset_text_property)
1277 || ! (print_check_string_result & PRINT_STRING_UNSAFE_CHARSET_FOUND))
1278 {
1279 int i, c;
1280 EMACS_INT charpos = interval->position;
1281 EMACS_INT bytepos = string_char_to_byte (string, charpos);
1282 Lisp_Object charset;
1283
1284 charset = XCAR (XCDR (val));
1285 for (i = 0; i < LENGTH (interval); i++)
1286 {
1287 FETCH_STRING_CHAR_ADVANCE (c, string, charpos, bytepos);
1288 if (! ASCII_CHAR_P (c)
1289 && ! EQ (CHARSET_NAME (CHAR_CHARSET (c)), charset))
1290 {
1291 print_check_string_result |= PRINT_STRING_UNSAFE_CHARSET_FOUND;
1292 break;
1293 }
1294 }
1295 }
1296 }
1297
1298 /* The value is (charset . nil). */
1299 static Lisp_Object print_prune_charset_plist;
1300
1301 static Lisp_Object
1302 print_prune_string_charset (Lisp_Object string)
1303 {
1304 print_check_string_result = 0;
1305 traverse_intervals (STRING_INTERVALS (string), 0,
1306 print_check_string_charset_prop, string);
1307 if (! (print_check_string_result & PRINT_STRING_UNSAFE_CHARSET_FOUND))
1308 {
1309 string = Fcopy_sequence (string);
1310 if (print_check_string_result & PRINT_STRING_NON_CHARSET_FOUND)
1311 {
1312 if (NILP (print_prune_charset_plist))
1313 print_prune_charset_plist = Fcons (Qcharset, Qnil);
1314 Fremove_text_properties (make_number (0),
1315 make_number (SCHARS (string)),
1316 print_prune_charset_plist, string);
1317 }
1318 else
1319 Fset_text_properties (make_number (0), make_number (SCHARS (string)),
1320 Qnil, string);
1321 }
1322 return string;
1323 }
1324
1325 static void
1326 print_object (Lisp_Object obj, register Lisp_Object printcharfun, int escapeflag)
1327 {
1328 char buf[40];
1329
1330 QUIT;
1331
1332 /* See similar code in print_preprocess. */
1333 if (print_depth >= PRINT_CIRCLE)
1334 error ("Apparently circular structure being printed");
1335
1336 /* Detect circularities and truncate them. */
1337 if (STRINGP (obj) || CONSP (obj) || VECTORP (obj)
1338 || FUNVECP (obj) || CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj)
1339 || HASH_TABLE_P (obj)
1340 || (! NILP (Vprint_gensym)
1341 && SYMBOLP (obj)
1342 && !SYMBOL_INTERNED_P (obj)))
1343 {
1344 if (NILP (Vprint_circle) && NILP (Vprint_gensym))
1345 {
1346 /* Simple but incomplete way. */
1347 int i;
1348 for (i = 0; i < print_depth; i++)
1349 if (EQ (obj, being_printed[i]))
1350 {
1351 sprintf (buf, "#%d", i);
1352 strout (buf, -1, -1, printcharfun, 0);
1353 return;
1354 }
1355 being_printed[print_depth] = obj;
1356 }
1357 else
1358 {
1359 /* With the print-circle feature. */
1360 Lisp_Object num = Fgethash (obj, Vprint_number_table, Qnil);
1361 if (INTEGERP (num))
1362 {
1363 int n = XINT (num);
1364 if (n < 0)
1365 { /* Add a prefix #n= if OBJ has not yet been printed;
1366 that is, its status field is nil. */
1367 sprintf (buf, "#%d=", -n);
1368 strout (buf, -1, -1, printcharfun, 0);
1369 /* OBJ is going to be printed. Remember that fact. */
1370 Fputhash (obj, make_number (- n), Vprint_number_table);
1371 }
1372 else
1373 {
1374 /* Just print #n# if OBJ has already been printed. */
1375 sprintf (buf, "#%d#", n);
1376 strout (buf, -1, -1, printcharfun, 0);
1377 return;
1378 }
1379 }
1380 }
1381 }
1382
1383 print_depth++;
1384
1385 switch (XTYPE (obj))
1386 {
1387 case_Lisp_Int:
1388 if (sizeof (int) == sizeof (EMACS_INT))
1389 sprintf (buf, "%d", (int) XINT (obj));
1390 else if (sizeof (long) == sizeof (EMACS_INT))
1391 sprintf (buf, "%ld", (long) XINT (obj));
1392 else
1393 abort ();
1394 strout (buf, -1, -1, printcharfun, 0);
1395 break;
1396
1397 case Lisp_Float:
1398 {
1399 char pigbuf[FLOAT_TO_STRING_BUFSIZE];
1400
1401 float_to_string (pigbuf, XFLOAT_DATA (obj));
1402 strout (pigbuf, -1, -1, printcharfun, 0);
1403 }
1404 break;
1405
1406 case Lisp_String:
1407 if (!escapeflag)
1408 print_string (obj, printcharfun);
1409 else
1410 {
1411 register EMACS_INT i, i_byte;
1412 struct gcpro gcpro1;
1413 unsigned char *str;
1414 EMACS_INT size_byte;
1415 /* 1 means we must ensure that the next character we output
1416 cannot be taken as part of a hex character escape. */
1417 int need_nonhex = 0;
1418 int multibyte = STRING_MULTIBYTE (obj);
1419
1420 GCPRO1 (obj);
1421
1422 if (! EQ (Vprint_charset_text_property, Qt))
1423 obj = print_prune_string_charset (obj);
1424
1425 if (!NULL_INTERVAL_P (STRING_INTERVALS (obj)))
1426 {
1427 PRINTCHAR ('#');
1428 PRINTCHAR ('(');
1429 }
1430
1431 PRINTCHAR ('\"');
1432 str = SDATA (obj);
1433 size_byte = SBYTES (obj);
1434
1435 for (i = 0, i_byte = 0; i_byte < size_byte;)
1436 {
1437 /* Here, we must convert each multi-byte form to the
1438 corresponding character code before handing it to PRINTCHAR. */
1439 int len;
1440 int c;
1441
1442 if (multibyte)
1443 {
1444 c = STRING_CHAR_AND_LENGTH (str + i_byte, len);
1445 i_byte += len;
1446 }
1447 else
1448 c = str[i_byte++];
1449
1450 QUIT;
1451
1452 if (c == '\n' && print_escape_newlines)
1453 {
1454 PRINTCHAR ('\\');
1455 PRINTCHAR ('n');
1456 }
1457 else if (c == '\f' && print_escape_newlines)
1458 {
1459 PRINTCHAR ('\\');
1460 PRINTCHAR ('f');
1461 }
1462 else if (multibyte
1463 && (CHAR_BYTE8_P (c)
1464 || (! ASCII_CHAR_P (c) && print_escape_multibyte)))
1465 {
1466 /* When multibyte is disabled,
1467 print multibyte string chars using hex escapes.
1468 For a char code that could be in a unibyte string,
1469 when found in a multibyte string, always use a hex escape
1470 so it reads back as multibyte. */
1471 char outbuf[50];
1472
1473 if (CHAR_BYTE8_P (c))
1474 sprintf (outbuf, "\\%03o", CHAR_TO_BYTE8 (c));
1475 else
1476 {
1477 sprintf (outbuf, "\\x%04x", c);
1478 need_nonhex = 1;
1479 }
1480 strout (outbuf, -1, -1, printcharfun, 0);
1481 }
1482 else if (! multibyte
1483 && SINGLE_BYTE_CHAR_P (c) && ! ASCII_BYTE_P (c)
1484 && print_escape_nonascii)
1485 {
1486 /* When printing in a multibyte buffer
1487 or when explicitly requested,
1488 print single-byte non-ASCII string chars
1489 using octal escapes. */
1490 char outbuf[5];
1491 sprintf (outbuf, "\\%03o", c);
1492 strout (outbuf, -1, -1, printcharfun, 0);
1493 }
1494 else
1495 {
1496 /* If we just had a hex escape, and this character
1497 could be taken as part of it,
1498 output `\ ' to prevent that. */
1499 if (need_nonhex)
1500 {
1501 need_nonhex = 0;
1502 if ((c >= 'a' && c <= 'f')
1503 || (c >= 'A' && c <= 'F')
1504 || (c >= '0' && c <= '9'))
1505 strout ("\\ ", -1, -1, printcharfun, 0);
1506 }
1507
1508 if (c == '\"' || c == '\\')
1509 PRINTCHAR ('\\');
1510 PRINTCHAR (c);
1511 }
1512 }
1513 PRINTCHAR ('\"');
1514
1515 if (!NULL_INTERVAL_P (STRING_INTERVALS (obj)))
1516 {
1517 traverse_intervals (STRING_INTERVALS (obj),
1518 0, print_interval, printcharfun);
1519 PRINTCHAR (')');
1520 }
1521
1522 UNGCPRO;
1523 }
1524 break;
1525
1526 case Lisp_Symbol:
1527 {
1528 register int confusing;
1529 register unsigned char *p = SDATA (SYMBOL_NAME (obj));
1530 register unsigned char *end = p + SBYTES (SYMBOL_NAME (obj));
1531 register int c;
1532 int i, i_byte;
1533 EMACS_INT size_byte;
1534 Lisp_Object name;
1535
1536 name = SYMBOL_NAME (obj);
1537
1538 if (p != end && (*p == '-' || *p == '+')) p++;
1539 if (p == end)
1540 confusing = 0;
1541 /* If symbol name begins with a digit, and ends with a digit,
1542 and contains nothing but digits and `e', it could be treated
1543 as a number. So set CONFUSING.
1544
1545 Symbols that contain periods could also be taken as numbers,
1546 but periods are always escaped, so we don't have to worry
1547 about them here. */
1548 else if (*p >= '0' && *p <= '9'
1549 && end[-1] >= '0' && end[-1] <= '9')
1550 {
1551 while (p != end && ((*p >= '0' && *p <= '9')
1552 /* Needed for \2e10. */
1553 || *p == 'e' || *p == 'E'))
1554 p++;
1555 confusing = (end == p);
1556 }
1557 else
1558 confusing = 0;
1559
1560 if (! NILP (Vprint_gensym) && !SYMBOL_INTERNED_P (obj))
1561 {
1562 PRINTCHAR ('#');
1563 PRINTCHAR (':');
1564 }
1565
1566 size_byte = SBYTES (name);
1567
1568 for (i = 0, i_byte = 0; i_byte < size_byte;)
1569 {
1570 /* Here, we must convert each multi-byte form to the
1571 corresponding character code before handing it to PRINTCHAR. */
1572 FETCH_STRING_CHAR_ADVANCE (c, name, i, i_byte);
1573 QUIT;
1574
1575 if (escapeflag)
1576 {
1577 if (c == '\"' || c == '\\' || c == '\''
1578 || c == ';' || c == '#' || c == '(' || c == ')'
1579 || c == ',' || c =='.' || c == '`'
1580 || c == '[' || c == ']' || c == '?' || c <= 040
1581 || confusing)
1582 PRINTCHAR ('\\'), confusing = 0;
1583 }
1584 PRINTCHAR (c);
1585 }
1586 }
1587 break;
1588
1589 case Lisp_Cons:
1590 /* If deeper than spec'd depth, print placeholder. */
1591 if (INTEGERP (Vprint_level)
1592 && print_depth > XINT (Vprint_level))
1593 strout ("...", -1, -1, printcharfun, 0);
1594 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1595 && (EQ (XCAR (obj), Qquote)))
1596 {
1597 PRINTCHAR ('\'');
1598 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1599 }
1600 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1601 && (EQ (XCAR (obj), Qfunction)))
1602 {
1603 PRINTCHAR ('#');
1604 PRINTCHAR ('\'');
1605 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1606 }
1607 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1608 && ((EQ (XCAR (obj), Qbackquote))))
1609 {
1610 print_object (XCAR (obj), printcharfun, 0);
1611 new_backquote_output++;
1612 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1613 new_backquote_output--;
1614 }
1615 else if (print_quoted && CONSP (XCDR (obj)) && NILP (XCDR (XCDR (obj)))
1616 && new_backquote_output
1617 && ((EQ (XCAR (obj), Qbackquote)
1618 || EQ (XCAR (obj), Qcomma)
1619 || EQ (XCAR (obj), Qcomma_at)
1620 || EQ (XCAR (obj), Qcomma_dot))))
1621 {
1622 print_object (XCAR (obj), printcharfun, 0);
1623 new_backquote_output--;
1624 print_object (XCAR (XCDR (obj)), printcharfun, escapeflag);
1625 new_backquote_output++;
1626 }
1627 else
1628 {
1629 PRINTCHAR ('(');
1630
1631 /* If the first element is a backquote form,
1632 print it old-style so it won't be misunderstood. */
1633 if (print_quoted && CONSP (XCAR (obj))
1634 && CONSP (XCDR (XCAR (obj)))
1635 && NILP (XCDR (XCDR (XCAR (obj))))
1636 && EQ (XCAR (XCAR (obj)), Qbackquote))
1637 {
1638 Lisp_Object tem;
1639 tem = XCAR (obj);
1640 PRINTCHAR ('(');
1641
1642 print_object (Qbackquote, printcharfun, 0);
1643 PRINTCHAR (' ');
1644
1645 print_object (XCAR (XCDR (tem)), printcharfun, 0);
1646 PRINTCHAR (')');
1647
1648 obj = XCDR (obj);
1649 }
1650
1651 {
1652 EMACS_INT print_length;
1653 int i;
1654 Lisp_Object halftail = obj;
1655
1656 /* Negative values of print-length are invalid in CL.
1657 Treat them like nil, as CMUCL does. */
1658 if (NATNUMP (Vprint_length))
1659 print_length = XFASTINT (Vprint_length);
1660 else
1661 print_length = 0;
1662
1663 i = 0;
1664 while (CONSP (obj))
1665 {
1666 /* Detect circular list. */
1667 if (NILP (Vprint_circle))
1668 {
1669 /* Simple but imcomplete way. */
1670 if (i != 0 && EQ (obj, halftail))
1671 {
1672 sprintf (buf, " . #%d", i / 2);
1673 strout (buf, -1, -1, printcharfun, 0);
1674 goto end_of_list;
1675 }
1676 }
1677 else
1678 {
1679 /* With the print-circle feature. */
1680 if (i != 0)
1681 {
1682 Lisp_Object num = Fgethash (obj, Vprint_number_table, Qnil);
1683 if (INTEGERP (num))
1684 {
1685 strout (" . ", 3, 3, printcharfun, 0);
1686 print_object (obj, printcharfun, escapeflag);
1687 goto end_of_list;
1688 }
1689 }
1690 }
1691
1692 if (i++)
1693 PRINTCHAR (' ');
1694
1695 if (print_length && i > print_length)
1696 {
1697 strout ("...", 3, 3, printcharfun, 0);
1698 goto end_of_list;
1699 }
1700
1701 print_object (XCAR (obj), printcharfun, escapeflag);
1702
1703 obj = XCDR (obj);
1704 if (!(i & 1))
1705 halftail = XCDR (halftail);
1706 }
1707 }
1708
1709 /* OBJ non-nil here means it's the end of a dotted list. */
1710 if (!NILP (obj))
1711 {
1712 strout (" . ", 3, 3, printcharfun, 0);
1713 print_object (obj, printcharfun, escapeflag);
1714 }
1715
1716 end_of_list:
1717 PRINTCHAR (')');
1718 }
1719 break;
1720
1721 case Lisp_Vectorlike:
1722 if (PROCESSP (obj))
1723 {
1724 if (escapeflag)
1725 {
1726 strout ("#<process ", -1, -1, printcharfun, 0);
1727 print_string (XPROCESS (obj)->name, printcharfun);
1728 PRINTCHAR ('>');
1729 }
1730 else
1731 print_string (XPROCESS (obj)->name, printcharfun);
1732 }
1733 else if (BOOL_VECTOR_P (obj))
1734 {
1735 register int i;
1736 register unsigned char c;
1737 struct gcpro gcpro1;
1738 EMACS_INT size_in_chars
1739 = ((XBOOL_VECTOR (obj)->size + BOOL_VECTOR_BITS_PER_CHAR - 1)
1740 / BOOL_VECTOR_BITS_PER_CHAR);
1741
1742 GCPRO1 (obj);
1743
1744 PRINTCHAR ('#');
1745 PRINTCHAR ('&');
1746 sprintf (buf, "%ld", (long) XBOOL_VECTOR (obj)->size);
1747 strout (buf, -1, -1, printcharfun, 0);
1748 PRINTCHAR ('\"');
1749
1750 /* Don't print more characters than the specified maximum.
1751 Negative values of print-length are invalid. Treat them
1752 like a print-length of nil. */
1753 if (NATNUMP (Vprint_length)
1754 && XFASTINT (Vprint_length) < size_in_chars)
1755 size_in_chars = XFASTINT (Vprint_length);
1756
1757 for (i = 0; i < size_in_chars; i++)
1758 {
1759 QUIT;
1760 c = XBOOL_VECTOR (obj)->data[i];
1761 if (c == '\n' && print_escape_newlines)
1762 {
1763 PRINTCHAR ('\\');
1764 PRINTCHAR ('n');
1765 }
1766 else if (c == '\f' && print_escape_newlines)
1767 {
1768 PRINTCHAR ('\\');
1769 PRINTCHAR ('f');
1770 }
1771 else if (c > '\177')
1772 {
1773 /* Use octal escapes to avoid encoding issues. */
1774 PRINTCHAR ('\\');
1775 PRINTCHAR ('0' + ((c >> 6) & 3));
1776 PRINTCHAR ('0' + ((c >> 3) & 7));
1777 PRINTCHAR ('0' + (c & 7));
1778 }
1779 else
1780 {
1781 if (c == '\"' || c == '\\')
1782 PRINTCHAR ('\\');
1783 PRINTCHAR (c);
1784 }
1785 }
1786 PRINTCHAR ('\"');
1787
1788 UNGCPRO;
1789 }
1790 else if (SUBRP (obj))
1791 {
1792 strout ("#<subr ", -1, -1, printcharfun, 0);
1793 strout (XSUBR (obj)->symbol_name, -1, -1, printcharfun, 0);
1794 PRINTCHAR ('>');
1795 }
1796 else if (WINDOWP (obj))
1797 {
1798 strout ("#<window ", -1, -1, printcharfun, 0);
1799 sprintf (buf, "%ld", (long) XFASTINT (XWINDOW (obj)->sequence_number));
1800 strout (buf, -1, -1, printcharfun, 0);
1801 if (!NILP (XWINDOW (obj)->buffer))
1802 {
1803 strout (" on ", -1, -1, printcharfun, 0);
1804 print_string (XBUFFER (XWINDOW (obj)->buffer)->name, printcharfun);
1805 }
1806 PRINTCHAR ('>');
1807 }
1808 else if (TERMINALP (obj))
1809 {
1810 struct terminal *t = XTERMINAL (obj);
1811 strout ("#<terminal ", -1, -1, printcharfun, 0);
1812 sprintf (buf, "%d", t->id);
1813 strout (buf, -1, -1, printcharfun, 0);
1814 if (t->name)
1815 {
1816 strout (" on ", -1, -1, printcharfun, 0);
1817 strout (t->name, -1, -1, printcharfun, 0);
1818 }
1819 PRINTCHAR ('>');
1820 }
1821 else if (HASH_TABLE_P (obj))
1822 {
1823 struct Lisp_Hash_Table *h = XHASH_TABLE (obj);
1824 int i;
1825 EMACS_INT real_size, size;
1826 #if 0
1827 strout ("#<hash-table", -1, -1, printcharfun, 0);
1828 if (SYMBOLP (h->test))
1829 {
1830 PRINTCHAR (' ');
1831 PRINTCHAR ('\'');
1832 strout (SDATA (SYMBOL_NAME (h->test)), -1, -1, printcharfun, 0);
1833 PRINTCHAR (' ');
1834 strout (SDATA (SYMBOL_NAME (h->weak)), -1, -1, printcharfun, 0);
1835 PRINTCHAR (' ');
1836 sprintf (buf, "%ld/%ld", (long) h->count,
1837 (long) XVECTOR (h->next)->size);
1838 strout (buf, -1, -1, printcharfun, 0);
1839 }
1840 sprintf (buf, " 0x%lx", (unsigned long) h);
1841 strout (buf, -1, -1, printcharfun, 0);
1842 PRINTCHAR ('>');
1843 #endif
1844 /* Implement a readable output, e.g.:
1845 #s(hash-table size 2 test equal data (k1 v1 k2 v2)) */
1846 /* Always print the size. */
1847 sprintf (buf, "#s(hash-table size %ld",
1848 (long) XVECTOR (h->next)->size);
1849 strout (buf, -1, -1, printcharfun, 0);
1850
1851 if (!NILP (h->test))
1852 {
1853 strout (" test ", -1, -1, printcharfun, 0);
1854 print_object (h->test, printcharfun, 0);
1855 }
1856
1857 if (!NILP (h->weak))
1858 {
1859 strout (" weakness ", -1, -1, printcharfun, 0);
1860 print_object (h->weak, printcharfun, 0);
1861 }
1862
1863 if (!NILP (h->rehash_size))
1864 {
1865 strout (" rehash-size ", -1, -1, printcharfun, 0);
1866 print_object (h->rehash_size, printcharfun, 0);
1867 }
1868
1869 if (!NILP (h->rehash_threshold))
1870 {
1871 strout (" rehash-threshold ", -1, -1, printcharfun, 0);
1872 print_object (h->rehash_threshold, printcharfun, 0);
1873 }
1874
1875 strout (" data ", -1, -1, printcharfun, 0);
1876
1877 /* Print the data here as a plist. */
1878 real_size = HASH_TABLE_SIZE (h);
1879 size = real_size;
1880
1881 /* Don't print more elements than the specified maximum. */
1882 if (NATNUMP (Vprint_length)
1883 && XFASTINT (Vprint_length) < size)
1884 size = XFASTINT (Vprint_length);
1885
1886 PRINTCHAR ('(');
1887 for (i = 0; i < size; i++)
1888 if (!NILP (HASH_HASH (h, i)))
1889 {
1890 if (i) PRINTCHAR (' ');
1891 print_object (HASH_KEY (h, i), printcharfun, 1);
1892 PRINTCHAR (' ');
1893 print_object (HASH_VALUE (h, i), printcharfun, 1);
1894 }
1895
1896 if (size < real_size)
1897 strout (" ...", 4, 4, printcharfun, 0);
1898
1899 PRINTCHAR (')');
1900 PRINTCHAR (')');
1901
1902 }
1903 else if (BUFFERP (obj))
1904 {
1905 if (NILP (XBUFFER (obj)->name))
1906 strout ("#<killed buffer>", -1, -1, printcharfun, 0);
1907 else if (escapeflag)
1908 {
1909 strout ("#<buffer ", -1, -1, printcharfun, 0);
1910 print_string (XBUFFER (obj)->name, printcharfun);
1911 PRINTCHAR ('>');
1912 }
1913 else
1914 print_string (XBUFFER (obj)->name, printcharfun);
1915 }
1916 else if (WINDOW_CONFIGURATIONP (obj))
1917 {
1918 strout ("#<window-configuration>", -1, -1, printcharfun, 0);
1919 }
1920 else if (FRAMEP (obj))
1921 {
1922 strout ((FRAME_LIVE_P (XFRAME (obj))
1923 ? "#<frame " : "#<dead frame "),
1924 -1, -1, printcharfun, 0);
1925 print_string (XFRAME (obj)->name, printcharfun);
1926 sprintf (buf, " 0x%lx", (unsigned long) (XFRAME (obj)));
1927 strout (buf, -1, -1, printcharfun, 0);
1928 PRINTCHAR ('>');
1929 }
1930 else if (FONTP (obj))
1931 {
1932 EMACS_INT i;
1933
1934 if (! FONT_OBJECT_P (obj))
1935 {
1936 if (FONT_SPEC_P (obj))
1937 strout ("#<font-spec", -1, -1, printcharfun, 0);
1938 else
1939 strout ("#<font-entity", -1, -1, printcharfun, 0);
1940 for (i = 0; i < FONT_SPEC_MAX; i++)
1941 {
1942 PRINTCHAR (' ');
1943 if (i < FONT_WEIGHT_INDEX || i > FONT_WIDTH_INDEX)
1944 print_object (AREF (obj, i), printcharfun, escapeflag);
1945 else
1946 print_object (font_style_symbolic (obj, i, 0),
1947 printcharfun, escapeflag);
1948 }
1949 }
1950 else
1951 {
1952 strout ("#<font-object ", -1, -1, printcharfun, 0);
1953 print_object (AREF (obj, FONT_NAME_INDEX), printcharfun,
1954 escapeflag);
1955 }
1956 PRINTCHAR ('>');
1957 }
1958 else
1959 {
1960 EMACS_INT size = XVECTOR (obj)->size;
1961 if (FUNVECP (obj))
1962 {
1963 PRINTCHAR ('#');
1964 size &= PSEUDOVECTOR_SIZE_MASK;
1965 }
1966 if (CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj))
1967 {
1968 /* We print a char-table as if it were a vector,
1969 lumping the parent and default slots in with the
1970 character slots. But we add #^ as a prefix. */
1971
1972 /* Make each lowest sub_char_table start a new line.
1973 Otherwise we'll make a line extremely long, which
1974 results in slow redisplay. */
1975 if (SUB_CHAR_TABLE_P (obj)
1976 && XINT (XSUB_CHAR_TABLE (obj)->depth) == 3)
1977 PRINTCHAR ('\n');
1978 PRINTCHAR ('#');
1979 PRINTCHAR ('^');
1980 if (SUB_CHAR_TABLE_P (obj))
1981 PRINTCHAR ('^');
1982 size &= PSEUDOVECTOR_SIZE_MASK;
1983 }
1984 if (size & PSEUDOVECTOR_FLAG)
1985 goto badtype;
1986
1987 PRINTCHAR ('[');
1988 {
1989 register int i;
1990 register Lisp_Object tem;
1991 EMACS_INT real_size = size;
1992
1993 /* Don't print more elements than the specified maximum. */
1994 if (NATNUMP (Vprint_length)
1995 && XFASTINT (Vprint_length) < size)
1996 size = XFASTINT (Vprint_length);
1997
1998 for (i = 0; i < size; i++)
1999 {
2000 if (i) PRINTCHAR (' ');
2001 tem = XVECTOR (obj)->contents[i];
2002 print_object (tem, printcharfun, escapeflag);
2003 }
2004 if (size < real_size)
2005 strout (" ...", 4, 4, printcharfun, 0);
2006 }
2007 PRINTCHAR (']');
2008 }
2009 break;
2010
2011 case Lisp_Misc:
2012 switch (XMISCTYPE (obj))
2013 {
2014 case Lisp_Misc_Marker:
2015 strout ("#<marker ", -1, -1, printcharfun, 0);
2016 /* Do you think this is necessary? */
2017 if (XMARKER (obj)->insertion_type != 0)
2018 strout ("(moves after insertion) ", -1, -1, printcharfun, 0);
2019 if (! XMARKER (obj)->buffer)
2020 strout ("in no buffer", -1, -1, printcharfun, 0);
2021 else
2022 {
2023 sprintf (buf, "at %ld", (long)marker_position (obj));
2024 strout (buf, -1, -1, printcharfun, 0);
2025 strout (" in ", -1, -1, printcharfun, 0);
2026 print_string (XMARKER (obj)->buffer->name, printcharfun);
2027 }
2028 PRINTCHAR ('>');
2029 break;
2030
2031 case Lisp_Misc_Overlay:
2032 strout ("#<overlay ", -1, -1, printcharfun, 0);
2033 if (! XMARKER (OVERLAY_START (obj))->buffer)
2034 strout ("in no buffer", -1, -1, printcharfun, 0);
2035 else
2036 {
2037 sprintf (buf, "from %ld to %ld in ",
2038 (long)marker_position (OVERLAY_START (obj)),
2039 (long)marker_position (OVERLAY_END (obj)));
2040 strout (buf, -1, -1, printcharfun, 0);
2041 print_string (XMARKER (OVERLAY_START (obj))->buffer->name,
2042 printcharfun);
2043 }
2044 PRINTCHAR ('>');
2045 break;
2046
2047 /* Remaining cases shouldn't happen in normal usage, but let's print
2048 them anyway for the benefit of the debugger. */
2049 case Lisp_Misc_Free:
2050 strout ("#<misc free cell>", -1, -1, printcharfun, 0);
2051 break;
2052
2053 case Lisp_Misc_Save_Value:
2054 strout ("#<save_value ", -1, -1, printcharfun, 0);
2055 sprintf(buf, "ptr=0x%08lx int=%d",
2056 (unsigned long) XSAVE_VALUE (obj)->pointer,
2057 XSAVE_VALUE (obj)->integer);
2058 strout (buf, -1, -1, printcharfun, 0);
2059 PRINTCHAR ('>');
2060 break;
2061
2062 default:
2063 goto badtype;
2064 }
2065 break;
2066
2067 default:
2068 badtype:
2069 {
2070 /* We're in trouble if this happens!
2071 Probably should just abort () */
2072 strout ("#<EMACS BUG: INVALID DATATYPE ", -1, -1, printcharfun, 0);
2073 if (MISCP (obj))
2074 sprintf (buf, "(MISC 0x%04x)", (int) XMISCTYPE (obj));
2075 else if (VECTORLIKEP (obj))
2076 sprintf (buf, "(PVEC 0x%08x)", (int) XVECTOR (obj)->size);
2077 else
2078 sprintf (buf, "(0x%02x)", (int) XTYPE (obj));
2079 strout (buf, -1, -1, printcharfun, 0);
2080 strout (" Save your buffers immediately and please report this bug>",
2081 -1, -1, printcharfun, 0);
2082 }
2083 }
2084
2085 print_depth--;
2086 }
2087 \f
2088
2089 /* Print a description of INTERVAL using PRINTCHARFUN.
2090 This is part of printing a string that has text properties. */
2091
2092 void
2093 print_interval (INTERVAL interval, Lisp_Object printcharfun)
2094 {
2095 if (NILP (interval->plist))
2096 return;
2097 PRINTCHAR (' ');
2098 print_object (make_number (interval->position), printcharfun, 1);
2099 PRINTCHAR (' ');
2100 print_object (make_number (interval->position + LENGTH (interval)),
2101 printcharfun, 1);
2102 PRINTCHAR (' ');
2103 print_object (interval->plist, printcharfun, 1);
2104 }
2105
2106 \f
2107 void
2108 syms_of_print (void)
2109 {
2110 Qtemp_buffer_setup_hook = intern_c_string ("temp-buffer-setup-hook");
2111 staticpro (&Qtemp_buffer_setup_hook);
2112
2113 DEFVAR_LISP ("standard-output", Vstandard_output,
2114 doc: /* Output stream `print' uses by default for outputting a character.
2115 This may be any function of one argument.
2116 It may also be a buffer (output is inserted before point)
2117 or a marker (output is inserted and the marker is advanced)
2118 or the symbol t (output appears in the echo area). */);
2119 Vstandard_output = Qt;
2120 Qstandard_output = intern_c_string ("standard-output");
2121 staticpro (&Qstandard_output);
2122
2123 DEFVAR_LISP ("float-output-format", Vfloat_output_format,
2124 doc: /* The format descriptor string used to print floats.
2125 This is a %-spec like those accepted by `printf' in C,
2126 but with some restrictions. It must start with the two characters `%.'.
2127 After that comes an integer precision specification,
2128 and then a letter which controls the format.
2129 The letters allowed are `e', `f' and `g'.
2130 Use `e' for exponential notation \"DIG.DIGITSeEXPT\"
2131 Use `f' for decimal point notation \"DIGITS.DIGITS\".
2132 Use `g' to choose the shorter of those two formats for the number at hand.
2133 The precision in any of these cases is the number of digits following
2134 the decimal point. With `f', a precision of 0 means to omit the
2135 decimal point. 0 is not allowed with `e' or `g'.
2136
2137 A value of nil means to use the shortest notation
2138 that represents the number without losing information. */);
2139 Vfloat_output_format = Qnil;
2140 Qfloat_output_format = intern_c_string ("float-output-format");
2141 staticpro (&Qfloat_output_format);
2142
2143 DEFVAR_LISP ("print-length", Vprint_length,
2144 doc: /* Maximum length of list to print before abbreviating.
2145 A value of nil means no limit. See also `eval-expression-print-length'. */);
2146 Vprint_length = Qnil;
2147
2148 DEFVAR_LISP ("print-level", Vprint_level,
2149 doc: /* Maximum depth of list nesting to print before abbreviating.
2150 A value of nil means no limit. See also `eval-expression-print-level'. */);
2151 Vprint_level = Qnil;
2152
2153 DEFVAR_BOOL ("print-escape-newlines", print_escape_newlines,
2154 doc: /* Non-nil means print newlines in strings as `\\n'.
2155 Also print formfeeds as `\\f'. */);
2156 print_escape_newlines = 0;
2157
2158 DEFVAR_BOOL ("print-escape-nonascii", print_escape_nonascii,
2159 doc: /* Non-nil means print unibyte non-ASCII chars in strings as \\OOO.
2160 \(OOO is the octal representation of the character code.)
2161 Only single-byte characters are affected, and only in `prin1'.
2162 When the output goes in a multibyte buffer, this feature is
2163 enabled regardless of the value of the variable. */);
2164 print_escape_nonascii = 0;
2165
2166 DEFVAR_BOOL ("print-escape-multibyte", print_escape_multibyte,
2167 doc: /* Non-nil means print multibyte characters in strings as \\xXXXX.
2168 \(XXXX is the hex representation of the character code.)
2169 This affects only `prin1'. */);
2170 print_escape_multibyte = 0;
2171
2172 DEFVAR_BOOL ("print-quoted", print_quoted,
2173 doc: /* Non-nil means print quoted forms with reader syntax.
2174 I.e., (quote foo) prints as 'foo, (function foo) as #'foo. */);
2175 print_quoted = 0;
2176
2177 DEFVAR_LISP ("print-gensym", Vprint_gensym,
2178 doc: /* Non-nil means print uninterned symbols so they will read as uninterned.
2179 I.e., the value of (make-symbol \"foobar\") prints as #:foobar.
2180 When the uninterned symbol appears within a recursive data structure,
2181 and the symbol appears more than once, in addition use the #N# and #N=
2182 constructs as needed, so that multiple references to the same symbol are
2183 shared once again when the text is read back. */);
2184 Vprint_gensym = Qnil;
2185
2186 DEFVAR_LISP ("print-circle", Vprint_circle,
2187 doc: /* *Non-nil means print recursive structures using #N= and #N# syntax.
2188 If nil, printing proceeds recursively and may lead to
2189 `max-lisp-eval-depth' being exceeded or an error may occur:
2190 \"Apparently circular structure being printed.\" Also see
2191 `print-length' and `print-level'.
2192 If non-nil, shared substructures anywhere in the structure are printed
2193 with `#N=' before the first occurrence (in the order of the print
2194 representation) and `#N#' in place of each subsequent occurrence,
2195 where N is a positive decimal integer. */);
2196 Vprint_circle = Qnil;
2197
2198 DEFVAR_LISP ("print-continuous-numbering", Vprint_continuous_numbering,
2199 doc: /* *Non-nil means number continuously across print calls.
2200 This affects the numbers printed for #N= labels and #M# references.
2201 See also `print-circle', `print-gensym', and `print-number-table'.
2202 This variable should not be set with `setq'; bind it with a `let' instead. */);
2203 Vprint_continuous_numbering = Qnil;
2204
2205 DEFVAR_LISP ("print-number-table", Vprint_number_table,
2206 doc: /* A vector used internally to produce `#N=' labels and `#N#' references.
2207 The Lisp printer uses this vector to detect Lisp objects referenced more
2208 than once.
2209
2210 When you bind `print-continuous-numbering' to t, you should probably
2211 also bind `print-number-table' to nil. This ensures that the value of
2212 `print-number-table' can be garbage-collected once the printing is
2213 done. If all elements of `print-number-table' are nil, it means that
2214 the printing done so far has not found any shared structure or objects
2215 that need to be recorded in the table. */);
2216 Vprint_number_table = Qnil;
2217
2218 DEFVAR_LISP ("print-charset-text-property", Vprint_charset_text_property,
2219 doc: /* A flag to control printing of `charset' text property on printing a string.
2220 The value must be nil, t, or `default'.
2221
2222 If the value is nil, don't print the text property `charset'.
2223
2224 If the value is t, always print the text property `charset'.
2225
2226 If the value is `default', print the text property `charset' only when
2227 the value is different from what is guessed in the current charset
2228 priorities. */);
2229 Vprint_charset_text_property = Qdefault;
2230
2231 /* prin1_to_string_buffer initialized in init_buffer_once in buffer.c */
2232 staticpro (&Vprin1_to_string_buffer);
2233
2234 defsubr (&Sprin1);
2235 defsubr (&Sprin1_to_string);
2236 defsubr (&Serror_message_string);
2237 defsubr (&Sprinc);
2238 defsubr (&Sprint);
2239 defsubr (&Sterpri);
2240 defsubr (&Swrite_char);
2241 defsubr (&Sexternal_debugging_output);
2242 #ifdef WITH_REDIRECT_DEBUGGING_OUTPUT
2243 defsubr (&Sredirect_debugging_output);
2244 #endif
2245
2246 Qexternal_debugging_output = intern_c_string ("external-debugging-output");
2247 staticpro (&Qexternal_debugging_output);
2248
2249 Qprint_escape_newlines = intern_c_string ("print-escape-newlines");
2250 staticpro (&Qprint_escape_newlines);
2251
2252 Qprint_escape_multibyte = intern_c_string ("print-escape-multibyte");
2253 staticpro (&Qprint_escape_multibyte);
2254
2255 Qprint_escape_nonascii = intern_c_string ("print-escape-nonascii");
2256 staticpro (&Qprint_escape_nonascii);
2257
2258 print_prune_charset_plist = Qnil;
2259 staticpro (&print_prune_charset_plist);
2260 }