1 /* Copyright (C) 1995,1996 Free Software Foundation, Inc.
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2, or (at your option)
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this software; see the file COPYING. If not, write to
15 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
17 * As a special exception, the Free Software Foundation gives permission
18 * for additional uses of the text contained in its release of GUILE.
20 * The exception is that, if you link the GUILE library with other files
21 * to produce an executable, this does not by itself cause the
22 * resulting executable to be covered by the GNU General Public License.
23 * Your use of that executable is in no way restricted on account of
24 * linking the GUILE library code into it.
26 * This exception does not however invalidate any other reasons why
27 * the executable file might be covered by the GNU General Public License.
29 * This exception applies only to the code released by the
30 * Free Software Foundation under the name GUILE. If you copy
31 * code from other Free Software Foundation releases into a copy of
32 * GUILE, as the General Public License permits, the exception does
33 * not apply to the code that you add in this way. To avoid misleading
34 * anyone as to the status of such modified files, you must delete
35 * this exception notice from them.
37 * If you write modifications of your own for GUILE, it is your choice
38 * whether to permit this exception to apply to your modifications.
39 * If you do not wish that, delete this exception notice.
47 #include "mbstrings.h"
60 /* {Names of immediate symbols}
62 * This table must agree with the declarations in scm.h: {Immediate Symbols}.
65 char *scm_isymnames
[] =
67 /* This table must agree with the declarations */
83 "#@literal-variable-ref",
84 "#@literal-variable-set!",
87 "#@call-with-current-continuation",
89 /* user visible ISYMS */
101 scm_option scm_print_opts
[] = {
102 { SCM_OPTION_SCM
, "closure-hook", SCM_BOOL_F
,
103 "Hook for printing closures." },
104 { SCM_OPTION_BOOLEAN
, "source", 0,
105 "Print closures with source." }
108 SCM_PROC (s_print_options
, "print-options-interface", 0, 1, 0, scm_print_options
);
111 scm_print_options (setting
)
114 SCM ans
= scm_options (setting
,
122 /* {Printing of Scheme Objects}
125 /* Detection of circular references.
127 * Due to other constraints in the implementation, this code has bad
128 * time complexity (O (depth * N)), The printer code will be
129 * completely rewritten before next release of Guile. The new code
132 #define PUSH_REF(pstate, obj) \
134 pstate->ref_stack[pstate->top++] = (obj); \
135 if (pstate->top == pstate->ceiling) \
136 grow_ref_stack (pstate); \
139 #define ENTER_NESTED_DATA(pstate, obj, label) \
142 for (i = 0; i < pstate->top; ++i) \
143 if (pstate->ref_stack[i] == (obj)) \
145 if (pstate->fancyp) \
147 if (pstate->top - pstate->list_offset >= pstate->level) \
149 scm_gen_putc ('#', port); \
153 PUSH_REF(pstate, obj); \
156 #define EXIT_NESTED_DATA(pstate) { --pstate->top; }
158 static SCM print_state_pool
;
160 #if 1 /* Used for debugging purposes */
161 SCM_PROC(s_current_pstate
, "current-pstate", 0, 0, 0, scm_current_pstate
);
164 scm_current_pstate ()
166 return SCM_CADR (print_state_pool
);
170 #define PSTATE_SIZE 50L
172 static SCM make_print_state
SCM_P ((void));
177 SCM print_state
= scm_make_struct (SCM_CAR (print_state_pool
), /* pstate type */
178 SCM_MAKINUM (PSTATE_SIZE
),
180 SCM_PRINT_STATE (print_state
)->ceiling
= PSTATE_SIZE
;
185 scm_make_print_state ()
189 /* First try to allocate a print state from the pool */
191 if (SCM_NNULLP (SCM_CDR (print_state_pool
)))
193 answer
= SCM_CADR (print_state_pool
);
194 SCM_SETCDR (print_state_pool
, SCM_CDDR (print_state_pool
));
198 return answer
? answer
: make_print_state ();
202 scm_free_print_state (print_state
)
206 scm_print_state
*pstate
= SCM_PRINT_STATE (print_state
);
207 /* Cleanup before returning print state to pool.
208 * It is better to do it here. Doing it in scm_prin1
209 * would cost more since that function is called much more
213 SCM_NEWCELL (handle
);
215 SCM_SETCAR (handle
, print_state
);
216 SCM_SETCDR (handle
, SCM_CDR (print_state_pool
));
217 SCM_SETCDR (print_state_pool
, handle
);
221 static void grow_ref_stack
SCM_P ((scm_print_state
*pstate
));
224 grow_ref_stack (pstate
)
225 scm_print_state
*pstate
;
227 int i
, size
= pstate
->ceiling
;
232 handle
= pstate
->handle
;
233 data
= (SCM
*) pstate
- scm_struct_n_extra_words
;
234 total_size
= ((SCM
*) pstate
)[scm_struct_i_n_words
];
235 data
= (SCM
*) scm_must_realloc ((char *) data
,
239 pstate
= (scm_print_state
*) (data
+ scm_struct_n_extra_words
);
240 ((SCM
*) pstate
)[scm_struct_i_n_words
] = total_size
+ size
;
241 pstate
->ceiling
+= size
;
242 for (i
= size
; i
< pstate
->ceiling
; ++i
)
243 pstate
->ref_stack
[i
] = SCM_BOOL_F
;
244 SCM_SETCDR (handle
, pstate
);
249 static void print_circref
SCM_P ((SCM port
, scm_print_state
*pstate
, SCM ref
));
252 print_circref (port
, pstate
, ref
)
254 scm_print_state
*pstate
;
258 int self
= pstate
->top
- 1;
260 if (SCM_CONSP (pstate
->ref_stack
[i
]))
264 if (SCM_NCONSP (pstate
->ref_stack
[i
- 1])
265 || SCM_CDR (pstate
->ref_stack
[i
- 1]) != pstate
->ref_stack
[i
])
271 for (i
= pstate
->top
- 1; 1; --i
)
272 if (pstate
->ref_stack
[i
] == ref
)
274 scm_gen_putc ('#', port
);
275 scm_intprint (i
- self
, 10, port
);
276 scm_gen_putc ('#', port
);
279 /* Print generally. Handles both write and display according to PSTATE.
284 scm_iprin1 (exp
, port
, pstate
)
287 scm_print_state
*pstate
;
291 switch (7 & (int) exp
)
295 scm_intprint (SCM_INUM (exp
), 10, port
);
301 scm_put_wchar (i
, port
, SCM_WRITINGP (pstate
));
304 else if (SCM_IFLAGP (exp
)
305 && (SCM_ISYMNUM (exp
) < (sizeof scm_isymnames
/ sizeof (char *))))
306 scm_gen_puts (scm_regular_string
, SCM_ISYMCHARS (exp
), port
);
307 else if (SCM_ILOCP (exp
))
309 scm_gen_puts (scm_regular_string
, "#@", port
);
310 scm_intprint ((long) SCM_IFRAME (exp
), 10, port
);
311 scm_gen_putc (SCM_ICDRP (exp
) ? '-' : '+', port
);
312 scm_intprint ((long) SCM_IDIST (exp
), 10, port
);
319 scm_gen_puts (scm_regular_string
, "#@", port
);
320 exp
= SCM_CAR (exp
- 1);
324 scm_ipruk ("immediate", exp
, port
);
327 switch (SCM_TYP7 (exp
))
329 case scm_tcs_cons_gloc
:
331 if (SCM_CDR (SCM_CAR (exp
) - 1L) == 0)
333 scm_gen_write (scm_regular_string
, "#<struct ", sizeof ("#<struct ") - 1, port
);
334 scm_intprint(exp
, 16, port
);
335 scm_gen_putc ('>', port
);
339 case scm_tcs_cons_imcar
:
340 case scm_tcs_cons_nimcar
:
341 ENTER_NESTED_DATA (pstate
, exp
, circref
);
342 scm_iprlist ("(", exp
, ')', port
, pstate
);
343 EXIT_NESTED_DATA (pstate
);
346 print_circref (port
, pstate
, exp
);
348 case scm_tcs_closures
:
349 if (SCM_NFALSEP (scm_procedure_p (SCM_PRINT_CLOSURE
)))
351 SCM ans
= scm_cons2 (exp
, port
,
352 scm_cons (SCM_WRITINGP (pstate
)
356 ans
= scm_apply (SCM_PRINT_CLOSURE
, ans
, SCM_EOL
);
361 name
= scm_procedure_property (exp
, scm_i_name
);
362 code
= SCM_CODE (exp
);
363 scm_gen_puts (scm_regular_string
, "#<procedure ", port
);
364 if (SCM_NIMP (name
) && SCM_ROSTRINGP (name
))
366 scm_gen_puts (scm_regular_string
, SCM_ROCHARS (name
), port
);
367 scm_gen_putc (' ', port
);
369 scm_iprin1 (SCM_CAR (code
), port
, pstate
);
370 if (SCM_PRINT_SOURCE_P
)
372 code
= scm_unmemocopy (SCM_CDR (code
),
373 SCM_EXTEND_ENV (SCM_CAR (code
),
376 ENTER_NESTED_DATA (pstate
, exp
, circref
);
377 scm_iprlist (" ", code
, '>', port
, pstate
);
378 EXIT_NESTED_DATA (pstate
);
381 scm_gen_putc ('>', port
);
384 case scm_tc7_mb_string
:
385 case scm_tc7_mb_substring
:
386 scm_print_mb_string (exp
, port
, SCM_WRITINGP (pstate
));
388 case scm_tc7_substring
:
390 if (SCM_WRITINGP (pstate
))
392 scm_gen_putc ('"', port
);
393 for (i
= 0; i
< SCM_ROLENGTH (exp
); ++i
)
394 switch (SCM_ROCHARS (exp
)[i
])
398 scm_gen_putc ('\\', port
);
400 scm_gen_putc (SCM_ROCHARS (exp
)[i
], port
);
402 scm_gen_putc ('"', port
);
406 scm_gen_write (scm_regular_string
, SCM_ROCHARS (exp
),
407 (scm_sizet
) SCM_ROLENGTH (exp
),
410 case scm_tcs_symbols
:
411 if (SCM_MB_STRINGP (exp
))
413 scm_print_mb_symbol (exp
, port
);
426 len
= SCM_LENGTH (exp
);
427 str
= SCM_CHARS (exp
);
434 scm_gen_write (scm_regular_string
, "#{}#", 4, port
);
436 for (end
= pos
; end
< len
; ++end
)
439 #ifdef BRACKETS_AS_PARENS
447 case SCM_WHITE_SPACES
:
448 case SCM_LINE_INCREMENTORS
:
457 scm_gen_write (scm_regular_string
, "#{", 2, port
);
462 scm_gen_write (scm_regular_string
, str
+ pos
, end
- pos
, port
);
468 scm_gen_write (scm_regular_string
, buf
, 2, port
);
490 scm_gen_write (scm_regular_string
, str
+ pos
, end
- pos
, port
);
492 scm_gen_write (scm_regular_string
, "}#", 2, port
);
496 ENTER_NESTED_DATA (pstate
, exp
, circref
);
497 if (SCM_IS_WHVEC (exp
))
498 scm_gen_puts (scm_regular_string
, "#wh(", port
);
500 scm_gen_puts (scm_regular_string
, "#w(", port
);
501 goto common_vector_printer
;
504 ENTER_NESTED_DATA (pstate
, exp
, circref
);
505 scm_gen_puts (scm_regular_string
, "#(", port
);
506 common_vector_printer
:
507 for (i
= 0; i
+ 1 < SCM_LENGTH (exp
); ++i
)
510 scm_iprin1 (SCM_VELTS (exp
)[i
], port
, pstate
);
511 scm_gen_putc (' ', port
);
513 if (i
< SCM_LENGTH (exp
))
516 scm_iprin1 (SCM_VELTS (exp
)[i
], port
, pstate
);
518 scm_gen_putc (')', port
);
519 EXIT_NESTED_DATA (pstate
);
532 scm_raprin1 (exp
, port
, pstate
);
535 scm_gen_puts (scm_regular_string
, "#<primitive-procedure ", port
);
536 scm_gen_puts ((SCM_MB_STRINGP (SCM_SNAME(exp
))
538 : scm_regular_string
),
539 SCM_CHARS (SCM_SNAME (exp
)), port
);
540 scm_gen_putc ('>', port
);
544 scm_gen_puts (scm_regular_string
, "#<compiled-closure ", port
);
545 scm_iprin1 (SCM_CCLO_SUBR (exp
), port
, pstate
);
546 scm_gen_putc ('>', port
);
550 scm_gen_puts (scm_regular_string
, "#<continuation ", port
);
551 scm_intprint (SCM_LENGTH (exp
), 10, port
);
552 scm_gen_puts (scm_regular_string
, " @ ", port
);
553 scm_intprint ((long) SCM_CHARS (exp
), 16, port
);
554 scm_gen_putc ('>', port
);
557 i
= SCM_PTOBNUM (exp
);
559 && scm_ptobs
[i
].print
560 && (scm_ptobs
[i
].print
) (exp
, port
, pstate
))
564 ENTER_NESTED_DATA (pstate
, exp
, circref
);
565 i
= SCM_SMOBNUM (exp
);
566 if (i
< scm_numsmob
&& scm_smobs
[i
].print
567 && (scm_smobs
[i
].print
) (exp
, port
, pstate
))
569 EXIT_NESTED_DATA (pstate
);
572 EXIT_NESTED_DATA (pstate
);
575 scm_ipruk ("type", exp
, port
);
580 /* Print states are necessary for circular reference safe printing.
581 * They are also expensive to allocate. Therefore print states are
582 * kept in a pool so that they can be reused.
586 scm_prin1 (exp
, port
, writingp
)
591 SCM handle
= 0; /* Will GC protect the handle whilst unlinked */
592 scm_print_state
*pstate
;
594 /* First try to allocate a print state from the pool */
596 if (SCM_NNULLP (SCM_CDR (print_state_pool
)))
598 handle
= SCM_CDR (print_state_pool
);
599 SCM_SETCDR (print_state_pool
, SCM_CDDR (print_state_pool
));
604 handle
= scm_cons (make_print_state (), SCM_EOL
);
606 pstate
= SCM_PRINT_STATE (SCM_CAR (handle
));
607 pstate
->writingp
= writingp
;
608 scm_iprin1 (exp
, port
, pstate
);
610 /* Return print state to pool */
612 SCM_SETCDR (handle
, SCM_CDR (print_state_pool
));
613 SCM_SETCDR (print_state_pool
, handle
);
622 scm_intprint (n
, radix
, port
)
627 char num_buf
[SCM_INTBUFLEN
];
628 scm_gen_write (scm_regular_string
, num_buf
, scm_iint2str (n
, radix
, num_buf
), port
);
631 /* Print an object of unrecognized type.
635 scm_ipruk (hdr
, ptr
, port
)
640 scm_gen_puts (scm_regular_string
, "#<unknown-", port
);
641 scm_gen_puts (scm_regular_string
, hdr
, port
);
644 scm_gen_puts (scm_regular_string
, " (0x", port
);
645 scm_intprint (SCM_CAR (ptr
), 16, port
);
646 scm_gen_puts (scm_regular_string
, " . 0x", port
);
647 scm_intprint (SCM_CDR (ptr
), 16, port
);
648 scm_gen_puts (scm_regular_string
, ") @", port
);
650 scm_gen_puts (scm_regular_string
, " 0x", port
);
651 scm_intprint (ptr
, 16, port
);
652 scm_gen_putc ('>', port
);
660 scm_iprlist (hdr
, exp
, tlr
, port
, pstate
)
665 scm_print_state
*pstate
;
668 register SCM hare
, tortoise
;
669 int floor
= pstate
->top
- 2;
670 scm_gen_puts (scm_regular_string
, hdr
, port
);
675 /* Run a hare and tortoise so that total time complexity will be
676 O(depth * N) instead of O(N^2). */
677 hare
= SCM_CDR (exp
);
679 while (SCM_NIMP (hare
) && SCM_ECONSP (hare
))
681 if (hare
== tortoise
)
683 hare
= SCM_CDR (hare
);
684 if (SCM_IMP (hare
) || SCM_NECONSP (hare
))
686 hare
= SCM_CDR (hare
);
687 tortoise
= SCM_CDR (tortoise
);
690 /* No cdr cycles intrinsic to this list */
691 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
693 for (; SCM_NIMP (exp
); exp
= SCM_CDR (exp
))
695 if (SCM_NECONSP (exp
))
697 for (i
= floor
; i
>= 0; --i
)
698 if (pstate
->ref_stack
[i
] == exp
)
700 PUSH_REF (pstate
, exp
);
701 scm_gen_putc (' ', port
);
703 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
705 if (SCM_NNULLP (exp
))
707 scm_gen_puts (scm_regular_string
, " . ", port
);
708 scm_iprin1 (exp
, port
, pstate
);
712 scm_gen_putc (tlr
, port
);
713 pstate
->top
= floor
+ 2;
718 int n
= pstate
->length
;
720 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
721 exp
= SCM_CDR (exp
); --n
;
722 for (; SCM_NIMP (exp
); exp
= SCM_CDR (exp
))
724 if (SCM_NECONSP (exp
))
726 for (i
= 0; i
< pstate
->top
; ++i
)
727 if (pstate
->ref_stack
[i
] == exp
)
733 scm_gen_puts (scm_regular_string
, " ...", port
);
739 PUSH_REF(pstate
, exp
);
740 ++pstate
->list_offset
;
741 scm_gen_putc (' ', port
);
743 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
746 if (SCM_NNULLP (exp
))
748 scm_gen_puts (scm_regular_string
, " . ", port
);
749 scm_iprin1 (exp
, port
, pstate
);
752 pstate
->list_offset
-= pstate
->top
- floor
- 2;
756 pstate
->list_offset
-= pstate
->top
- floor
- 2;
759 scm_gen_puts (scm_regular_string
, " . ", port
);
760 print_circref (port
, pstate
, exp
);
766 SCM_PROC(s_write
, "write", 1, 1, 0, scm_write
);
769 scm_write (obj
, port
)
773 if (SCM_UNBNDP (port
))
776 SCM_ASSERT (SCM_NIMP (port
) && SCM_OPOUTPORTP (port
), port
, SCM_ARG2
, s_write
);
777 scm_prin1 (obj
, port
, 1);
781 scm_close_port (port
);
784 return SCM_UNSPECIFIED
;
788 SCM_PROC(s_display
, "display", 1, 1, 0, scm_display
);
791 scm_display (obj
, port
)
795 if (SCM_UNBNDP (port
))
798 SCM_ASSERT (SCM_NIMP (port
) && SCM_OPOUTPORTP (port
), port
, SCM_ARG2
, s_display
);
799 scm_prin1 (obj
, port
, 0);
803 scm_close_port (port
);
806 return SCM_UNSPECIFIED
;
809 SCM_PROC(s_newline
, "newline", 0, 1, 0, scm_newline
);
815 if (SCM_UNBNDP (port
))
818 SCM_ASSERT (SCM_NIMP (port
) && SCM_OPOUTPORTP (port
), port
, SCM_ARG1
, s_newline
);
819 scm_gen_putc ('\n', port
);
823 scm_close_port (port
);
827 if (port
== scm_cur_outp
)
829 return SCM_UNSPECIFIED
;
832 SCM_PROC(s_write_char
, "write-char", 1, 1, 0, scm_write_char
);
835 scm_write_char (chr
, port
)
839 if (SCM_UNBNDP (port
))
842 SCM_ASSERT (SCM_NIMP (port
) && SCM_OPOUTPORTP (port
), port
, SCM_ARG2
, s_write_char
);
843 SCM_ASSERT (SCM_ICHRP (chr
), chr
, SCM_ARG1
, s_write_char
);
844 scm_gen_putc ((int) SCM_ICHR (chr
), port
);
848 scm_close_port (port
);
851 return SCM_UNSPECIFIED
;
862 scm_init_opts (scm_print_options
, scm_print_opts
, SCM_N_PRINT_OPTIONS
);
863 vtable
= scm_make_vtable_vtable (scm_make_struct_layout (scm_makfrom0str ("")), SCM_INUM0
, SCM_EOL
);
864 type
= scm_make_struct (vtable
,
866 scm_cons (scm_make_struct_layout (scm_makfrom0str (SCM_PRINT_STATE_LAYOUT
)),
868 print_state_pool
= scm_permanent_object (scm_cons (type
, SCM_EOL
));