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