1 /* Copyright (C) 1995-1999,2000,2001, 2002, 2003, 2004, 2006, 2008, 2009 Free Software Foundation, Inc.
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public License
5 * as published by the Free Software Foundation; either version 3 of
6 * the License, or (at your option) any later version.
8 * This library is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
29 #include "libguile/_scm.h"
30 #include "libguile/chars.h"
31 #include "libguile/continuations.h"
32 #include "libguile/smob.h"
33 #include "libguile/eval.h"
34 #include "libguile/macros.h"
35 #include "libguile/procprop.h"
36 #include "libguile/read.h"
37 #include "libguile/weaks.h"
38 #include "libguile/programs.h"
39 #include "libguile/alist.h"
40 #include "libguile/struct.h"
41 #include "libguile/ports.h"
42 #include "libguile/root.h"
43 #include "libguile/strings.h"
44 #include "libguile/strports.h"
45 #include "libguile/vectors.h"
46 #include "libguile/lang.h"
47 #include "libguile/numbers.h"
49 #include "libguile/validate.h"
50 #include "libguile/print.h"
52 #include "libguile/private-options.h"
56 /* {Names of immediate symbols}
58 * This table must agree with the declarations in scm.h: {Immediate Symbols}.
61 /* This table must agree with the list of flags in tags.h. */
62 static const char *iflagnames
[] =
65 "#nil", /* Elisp nil value. Should print from elisp as symbol `nil'. */
66 "#<XXX UNUSED LISP FALSE -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
69 "#<XXX UNUSED BOOLEAN -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
74 /* Unbound slot marker for GOOPS. For internal use in GOOPS only. */
78 SCM_SYMBOL (sym_reader
, "reader");
80 scm_t_option scm_print_opts
[] = {
81 { SCM_OPTION_SCM
, "closure-hook", (unsigned long) SCM_BOOL_F
,
82 "Hook for printing closures (should handle macros as well)." },
83 { SCM_OPTION_BOOLEAN
, "source", 0,
84 "Print closures with source." },
85 { SCM_OPTION_SCM
, "highlight-prefix", (unsigned long)SCM_BOOL_F
,
86 "The string to print before highlighted values." },
87 { SCM_OPTION_SCM
, "highlight-suffix", (unsigned long)SCM_BOOL_F
,
88 "The string to print after highlighted values." },
89 { SCM_OPTION_SCM
, "quote-keywordish-symbols", (unsigned long)SCM_BOOL_F
,
90 "How to print symbols that have a colon as their first or last character. "
91 "The value '#f' does not quote the colons; '#t' quotes them; "
92 "'reader' quotes them when the reader option 'keywords' is not '#f'."
97 SCM_DEFINE (scm_print_options
, "print-options-interface", 0, 1, 0,
99 "Option interface for the print options. Instead of using\n"
100 "this procedure directly, use the procedures\n"
101 "@code{print-enable}, @code{print-disable}, @code{print-set!}\n"
102 "and @code{print-options}.")
103 #define FUNC_NAME s_scm_print_options
105 SCM ans
= scm_options (setting
,
113 /* {Printing of Scheme Objects}
116 /* Detection of circular references.
118 * Due to other constraints in the implementation, this code has bad
119 * time complexity (O (depth * N)), The printer code can be
120 * rewritten to be O(N).
122 #define PUSH_REF(pstate, obj) \
125 PSTATE_STACK_SET (pstate, pstate->top, obj); \
127 if (pstate->top == pstate->ceiling) \
128 grow_ref_stack (pstate); \
131 #define ENTER_NESTED_DATA(pstate, obj, label) \
134 register unsigned long i; \
135 for (i = 0; i < pstate->top; ++i) \
136 if (scm_is_eq (PSTATE_STACK_REF (pstate, i), (obj))) \
138 if (pstate->fancyp) \
140 if (pstate->top - pstate->list_offset >= pstate->level) \
142 scm_putc ('#', port); \
146 PUSH_REF(pstate, obj); \
149 #define EXIT_NESTED_DATA(pstate) \
153 PSTATE_STACK_SET (pstate, pstate->top, SCM_UNDEFINED); \
157 SCM scm_print_state_vtable
= SCM_BOOL_F
;
158 static SCM print_state_pool
= SCM_EOL
;
159 scm_i_pthread_mutex_t print_state_mutex
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
161 #ifdef GUILE_DEBUG /* Used for debugging purposes */
163 SCM_DEFINE (scm_current_pstate
, "current-pstate", 0, 0, 0,
165 "Return the current-pstate -- the car of the\n"
166 "@code{print_state_pool}. @code{current-pstate} is only\n"
167 "included in @code{--enable-guile-debug} builds.")
168 #define FUNC_NAME s_scm_current_pstate
170 if (!scm_is_null (print_state_pool
))
171 return SCM_CAR (print_state_pool
);
179 #define PSTATE_SIZE 50L
182 make_print_state (void)
185 = scm_make_struct (scm_print_state_vtable
, SCM_INUM0
, SCM_EOL
);
186 scm_print_state
*pstate
= SCM_PRINT_STATE (print_state
);
187 pstate
->ref_vect
= scm_c_make_vector (PSTATE_SIZE
, SCM_UNDEFINED
);
188 pstate
->ceiling
= SCM_SIMPLE_VECTOR_LENGTH (pstate
->ref_vect
);
189 pstate
->highlight_objects
= SCM_EOL
;
194 scm_make_print_state ()
196 SCM answer
= SCM_BOOL_F
;
198 /* First try to allocate a print state from the pool */
199 scm_i_pthread_mutex_lock (&print_state_mutex
);
200 if (!scm_is_null (print_state_pool
))
202 answer
= SCM_CAR (print_state_pool
);
203 print_state_pool
= SCM_CDR (print_state_pool
);
205 scm_i_pthread_mutex_unlock (&print_state_mutex
);
207 return scm_is_false (answer
) ? make_print_state () : answer
;
211 scm_free_print_state (SCM print_state
)
214 scm_print_state
*pstate
= SCM_PRINT_STATE (print_state
);
215 /* Cleanup before returning print state to pool.
216 * It is better to do it here. Doing it in scm_prin1
217 * would cost more since that function is called much more
221 pstate
->revealed
= 0;
222 pstate
->highlight_objects
= SCM_EOL
;
223 scm_i_pthread_mutex_lock (&print_state_mutex
);
224 handle
= scm_cons (print_state
, print_state_pool
);
225 print_state_pool
= handle
;
226 scm_i_pthread_mutex_unlock (&print_state_mutex
);
230 scm_i_port_with_print_state (SCM port
, SCM print_state
)
232 if (SCM_UNBNDP (print_state
))
234 if (SCM_PORT_WITH_PS_P (port
))
237 print_state
= scm_make_print_state ();
238 /* port does not need to be coerced since it doesn't have ps */
241 port
= SCM_COERCE_OUTPORT (port
);
242 SCM_RETURN_NEWSMOB (scm_tc16_port_with_ps
,
243 SCM_UNPACK (scm_cons (port
, print_state
)));
247 grow_ref_stack (scm_print_state
*pstate
)
249 SCM old_vect
= pstate
->ref_vect
;
250 size_t old_size
= SCM_SIMPLE_VECTOR_LENGTH (old_vect
);
251 size_t new_size
= 2 * pstate
->ceiling
;
252 SCM new_vect
= scm_c_make_vector (new_size
, SCM_UNDEFINED
);
255 for (i
= 0; i
!= old_size
; ++i
)
256 SCM_SIMPLE_VECTOR_SET (new_vect
, i
, SCM_SIMPLE_VECTOR_REF (old_vect
, i
));
258 pstate
->ref_vect
= new_vect
;
259 pstate
->ceiling
= new_size
;
262 #define PSTATE_STACK_REF(p,i) SCM_SIMPLE_VECTOR_REF((p)->ref_vect, (i))
263 #define PSTATE_STACK_SET(p,i,v) SCM_SIMPLE_VECTOR_SET((p)->ref_vect, (i), (v))
266 print_circref (SCM port
, scm_print_state
*pstate
, SCM ref
)
269 long self
= pstate
->top
- 1;
271 if (scm_is_pair (PSTATE_STACK_REF (pstate
, i
)))
275 if (!scm_is_pair (PSTATE_STACK_REF (pstate
, i
-1))
276 || !scm_is_eq (SCM_CDR (PSTATE_STACK_REF (pstate
, i
-1)),
277 SCM_CDR (PSTATE_STACK_REF (pstate
, i
))))
283 for (i
= pstate
->top
- 1; 1; --i
)
284 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), ref
))
286 scm_putc ('#', port
);
287 scm_intprint (i
- self
, 10, port
);
288 scm_putc ('#', port
);
291 /* Print the name of a symbol. */
294 quote_keywordish_symbol (SCM symbol
)
298 if (scm_i_symbol_ref (symbol
, 0) != ':'
299 && scm_i_symbol_ref (symbol
, scm_i_symbol_length (symbol
) - 1) != ':')
302 option
= SCM_PRINT_KEYWORD_STYLE
;
303 if (scm_is_false (option
))
305 if (scm_is_eq (option
, sym_reader
))
306 return scm_is_true (SCM_PACK (SCM_KEYWORD_STYLE
));
311 scm_i_print_symbol_name (SCM str
, SCM port
)
313 /* This points to the first character that has not yet been written to the
316 /* This points to the character we're currently looking at. */
318 /* If the name contains weird characters, we'll escape them with
319 * backslashes and set this flag; it indicates that we should surround the
320 * name with "#{" and "}#". */
322 /* Backslashes are not sufficient to make a name weird, but if a name is
323 * weird because of other characters, backslahes need to be escaped too.
324 * The first time we see a backslash, we set maybe_weird, and mw_pos points
325 * to the backslash. Then if the name turns out to be weird, we re-process
326 * everything starting from mw_pos.
327 * We could instead make backslashes always weird. This is not necessary
328 * to ensure that the output is (read)-able, but it would make this code
329 * simpler and faster. */
332 size_t len
= scm_i_symbol_length (str
);
333 scm_t_wchar str0
= scm_i_symbol_ref (str
, 0);
335 if (len
== 0 || str0
== '\'' || str0
== '`' || str0
== ','
336 || quote_keywordish_symbol (str
)
337 || (str0
== '.' && len
== 1)
338 || scm_is_true (scm_i_string_to_number (scm_symbol_to_string (str
), 10)))
340 scm_lfwrite ("#{", 2, port
);
344 for (end
= pos
; end
< len
; ++end
)
345 switch (scm_i_symbol_ref (str
, end
))
347 #ifdef BRACKETS_AS_PARENS
356 case SCM_WHITE_SPACES
:
357 case SCM_LINE_INCREMENTORS
:
366 scm_lfwrite ("#{", 2, port
);
370 scm_lfwrite_substr (scm_symbol_to_string (str
), pos
, end
, port
);
374 buf
[1] = (char) (unsigned char) scm_i_symbol_ref (str
, end
);
375 scm_lfwrite (buf
, 2, port
);
392 scm_lfwrite_substr (scm_symbol_to_string (str
), pos
, end
, port
);
394 scm_lfwrite ("}#", 2, port
);
398 scm_print_symbol_name (const char *str
, size_t len
, SCM port
)
400 SCM symbol
= scm_from_locale_symboln (str
, len
);
401 scm_i_print_symbol_name (symbol
, port
);
404 /* Print generally. Handles both write and display according to PSTATE.
406 SCM_GPROC(s_write
, "write", 1, 1, 0, scm_write
, g_write
);
407 SCM_GPROC(s_display
, "display", 1, 1, 0, scm_display
, g_display
);
409 static void iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
);
412 scm_iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
)
415 && scm_is_true (scm_memq (exp
, pstate
->highlight_objects
)))
417 scm_display (SCM_PRINT_HIGHLIGHT_PREFIX
, port
);
418 iprin1 (exp
, port
, pstate
);
419 scm_display (SCM_PRINT_HIGHLIGHT_SUFFIX
, port
);
422 iprin1 (exp
, port
, pstate
);
426 iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
)
428 switch (SCM_ITAG3 (exp
))
432 /* These tc3 tags should never occur in an immediate value. They are
433 * only used in cell types of non-immediates, i. e. the value returned
434 * by SCM_CELL_TYPE (exp) can use these tags.
436 scm_ipruk ("immediate", exp
, port
);
440 scm_intprint (SCM_I_INUM (exp
), 10, port
);
445 scm_t_wchar i
= SCM_CHAR (exp
);
448 if (SCM_WRITINGP (pstate
))
450 scm_puts ("#\\", port
);
451 name
= scm_i_charname (exp
);
453 scm_puts (name
, port
);
454 else if (uc_is_general_category_withtable (i
, UC_CATEGORY_MASK_L
458 | UC_CATEGORY_MASK_S
))
459 /* Print the character if is graphic character. */
467 enc
= scm_i_get_port_encoding (port
);
468 if (uc_combining_class (i
) == UC_CCC_NR
)
470 wstr
= scm_i_make_wide_string (1, &wbuf
);
475 /* Character is a combining character: print it connected
476 to a dotted circle instead of connecting it to the
478 wstr
= scm_i_make_wide_string (2, &wbuf
);
479 wbuf
[0] = SCM_CODEPOINT_DOTTED_CIRCLE
;
485 /* Character is graphic and Latin-1. Print it */
486 scm_lfwrite_str (wstr
, port
);
488 /* Character is graphic but unrepresentable in
489 this port's encoding. */
490 scm_intprint (i
, 8, port
);
494 buf
= u32_conv_to_encoding (enc
,
496 (scm_t_uint32
*) wbuf
,
502 /* Character is graphic. Print it. */
503 scm_lfwrite_str (wstr
, port
);
507 /* Character is graphic but unrepresentable in
508 this port's encoding. */
509 scm_intprint (i
, 8, port
);
513 /* Character is a non-graphical character. */
514 scm_intprint (i
, 8, port
);
517 scm_i_charprint (i
, port
);
519 else if (SCM_IFLAGP (exp
)
520 && ((size_t) SCM_IFLAGNUM (exp
) < (sizeof iflagnames
/ sizeof (char *))))
522 scm_puts (iflagnames
[SCM_IFLAGNUM (exp
)], port
);
526 /* unknown immediate value */
527 scm_ipruk ("immediate", exp
, port
);
531 switch (SCM_TYP7 (exp
))
535 ENTER_NESTED_DATA (pstate
, exp
, circref
);
536 if (SCM_OBJ_CLASS_FLAGS (exp
) & SCM_CLASSF_GOOPS
)
538 SCM pwps
, print
= pstate
->writingp
? g_write
: g_display
;
541 pwps
= scm_i_port_with_print_state (port
, pstate
->handle
);
542 pstate
->revealed
= 1;
543 scm_call_generic_2 (print
, exp
, pwps
);
548 scm_print_struct (exp
, port
, pstate
);
550 EXIT_NESTED_DATA (pstate
);
553 case scm_tcs_cons_imcar
:
554 case scm_tcs_cons_nimcar
:
555 ENTER_NESTED_DATA (pstate
, exp
, circref
);
556 scm_iprlist ("(", exp
, ')', port
, pstate
);
557 EXIT_NESTED_DATA (pstate
);
560 print_circref (port
, pstate
, exp
);
563 switch SCM_TYP16 (exp
) {
565 scm_bigprint (exp
, port
, pstate
);
568 scm_print_real (exp
, port
, pstate
);
570 case scm_tc16_complex
:
571 scm_print_complex (exp
, port
, pstate
);
573 case scm_tc16_fraction
:
574 scm_i_print_fraction (exp
, port
, pstate
);
579 if (SCM_WRITINGP (pstate
))
582 static char const hex
[] = "0123456789abcdef";
586 scm_putc ('"', port
);
587 len
= scm_i_string_length (exp
);
588 for (i
= 0; i
< len
; ++i
)
590 scm_t_wchar ch
= scm_i_string_ref (exp
, i
);
593 if (ch
== ' ' || ch
== '\n')
598 else if (ch
== '"' || ch
== '\\')
600 scm_putc ('\\', port
);
601 scm_i_charprint (ch
, port
);
605 if (uc_is_general_category_withtable
607 UC_CATEGORY_MASK_L
| UC_CATEGORY_MASK_M
|
608 UC_CATEGORY_MASK_N
| UC_CATEGORY_MASK_P
|
611 /* Print the character since it is a graphic
614 SCM wstr
= scm_i_make_wide_string (1, &wbuf
);
618 if (scm_i_get_port_encoding (port
))
620 wstr
= scm_i_make_wide_string (1, &wbuf
);
622 buf
= u32_conv_to_encoding (scm_i_get_port_encoding (port
),
624 (scm_t_uint32
*) wbuf
,
630 /* Character is graphic and representable in
631 this encoding. Print it. */
632 scm_lfwrite_str (wstr
, port
);
647 /* Character is graphic but unrepresentable in
648 this port's encoding or is not graphic. */
653 buf
[2] = hex
[ch
/ 16];
654 buf
[3] = hex
[ch
% 16];
655 scm_lfwrite (buf
, 4, port
);
657 else if (ch
<= 0xFFFF)
661 buf
[2] = hex
[(ch
& 0xF000) >> 12];
662 buf
[3] = hex
[(ch
& 0xF00) >> 8];
663 buf
[4] = hex
[(ch
& 0xF0) >> 4];
664 buf
[5] = hex
[(ch
& 0xF)];
665 scm_lfwrite (buf
, 6, port
);
668 else if (ch
> 0xFFFF)
672 buf
[2] = hex
[(ch
& 0xF00000) >> 20];
673 buf
[3] = hex
[(ch
& 0xF0000) >> 16];
674 buf
[4] = hex
[(ch
& 0xF000) >> 12];
675 buf
[5] = hex
[(ch
& 0xF00) >> 8];
676 buf
[6] = hex
[(ch
& 0xF0) >> 4];
677 buf
[7] = hex
[(ch
& 0xF)];
678 scm_lfwrite (buf
, 8, port
);
683 scm_putc ('"', port
);
684 scm_remember_upto_here_1 (exp
);
687 scm_lfwrite_str (exp
, port
);
688 scm_remember_upto_here_1 (exp
);
691 if (scm_i_symbol_is_interned (exp
))
693 scm_i_print_symbol_name (exp
, port
);
694 scm_remember_upto_here_1 (exp
);
698 scm_puts ("#<uninterned-symbol ", port
);
699 scm_i_print_symbol_name (exp
, port
);
700 scm_putc (' ', port
);
701 scm_uintprint (SCM_UNPACK (exp
), 16, port
);
702 scm_putc ('>', port
);
705 case scm_tc7_variable
:
706 scm_i_variable_print (exp
, port
, pstate
);
708 case scm_tc7_program
:
709 scm_i_program_print (exp
, port
, pstate
);
711 case scm_tc7_hashtable
:
712 scm_i_hashtable_print (exp
, port
, pstate
);
715 scm_i_fluid_print (exp
, port
, pstate
);
717 case scm_tc7_dynamic_state
:
718 scm_i_dynamic_state_print (exp
, port
, pstate
);
721 ENTER_NESTED_DATA (pstate
, exp
, circref
);
722 if (SCM_IS_WHVEC (exp
))
723 scm_puts ("#wh(", port
);
725 scm_puts ("#w(", port
);
726 goto common_vector_printer
;
728 case scm_tc7_bytevector
:
729 scm_i_print_bytevector (exp
, port
, pstate
);
732 ENTER_NESTED_DATA (pstate
, exp
, circref
);
733 scm_puts ("#(", port
);
734 common_vector_printer
:
737 long last
= SCM_SIMPLE_VECTOR_LENGTH (exp
) - 1;
740 && SCM_SIMPLE_VECTOR_LENGTH (exp
) > pstate
->length
)
742 last
= pstate
->length
- 1;
745 if (SCM_I_WVECTP (exp
))
747 /* Elements of weak vectors may not be accessed via the
748 `SIMPLE_VECTOR_REF ()' macro. */
749 for (i
= 0; i
< last
; ++i
)
751 scm_iprin1 (scm_c_vector_ref (exp
, i
),
753 scm_putc (' ', port
);
758 for (i
= 0; i
< last
; ++i
)
760 scm_iprin1 (SCM_SIMPLE_VECTOR_REF (exp
, i
), port
, pstate
);
761 scm_putc (' ', port
);
768 scm_iprin1 (scm_c_vector_ref (exp
, i
), port
, pstate
);
771 scm_puts (" ...", port
);
772 scm_putc (')', port
);
774 EXIT_NESTED_DATA (pstate
);
778 SCM name
= scm_symbol_to_string (SCM_SUBR_NAME (exp
));
779 scm_puts (SCM_SUBR_GENERIC (exp
)
780 ? "#<primitive-generic "
781 : "#<primitive-procedure ",
783 scm_lfwrite_str (name
, port
);
784 scm_putc ('>', port
);
789 register long i
= SCM_PTOBNUM (exp
);
791 && scm_ptobs
[i
].print
792 && (scm_ptobs
[i
].print
) (exp
, port
, pstate
))
797 ENTER_NESTED_DATA (pstate
, exp
, circref
);
798 SCM_SMOB_DESCRIPTOR (exp
).print (exp
, port
, pstate
);
799 EXIT_NESTED_DATA (pstate
);
802 /* case scm_tcs_closures: */
804 scm_ipruk ("type", exp
, port
);
809 /* Print states are necessary for circular reference safe printing.
810 * They are also expensive to allocate. Therefore print states are
811 * kept in a pool so that they can be reused.
814 /* The PORT argument can also be a print-state/port pair, which will
815 * then be used instead of allocating a new print state. This is
816 * useful for continuing a chain of print calls from Scheme. */
819 scm_prin1 (SCM exp
, SCM port
, int writingp
)
821 SCM handle
= SCM_BOOL_F
; /* Will GC protect the handle whilst unlinked */
823 scm_print_state
*pstate
;
826 /* If PORT is a print-state/port pair, use that. Else create a new
829 if (SCM_PORT_WITH_PS_P (port
))
831 pstate_scm
= SCM_PORT_WITH_PS_PS (port
);
832 port
= SCM_PORT_WITH_PS_PORT (port
);
836 /* First try to allocate a print state from the pool */
837 scm_i_pthread_mutex_lock (&print_state_mutex
);
838 if (!scm_is_null (print_state_pool
))
840 handle
= print_state_pool
;
841 print_state_pool
= SCM_CDR (print_state_pool
);
843 scm_i_pthread_mutex_unlock (&print_state_mutex
);
844 if (scm_is_false (handle
))
845 handle
= scm_list_1 (make_print_state ());
846 pstate_scm
= SCM_CAR (handle
);
849 pstate
= SCM_PRINT_STATE (pstate_scm
);
850 old_writingp
= pstate
->writingp
;
851 pstate
->writingp
= writingp
;
852 scm_iprin1 (exp
, port
, pstate
);
853 pstate
->writingp
= old_writingp
;
855 /* Return print state to pool if it has been created above and
856 hasn't escaped to Scheme. */
858 if (scm_is_true (handle
) && !pstate
->revealed
)
860 scm_i_pthread_mutex_lock (&print_state_mutex
);
861 SCM_SETCDR (handle
, print_state_pool
);
862 print_state_pool
= handle
;
863 scm_i_pthread_mutex_unlock (&print_state_mutex
);
867 /* Print a character.
870 scm_i_charprint (scm_t_wchar ch
, SCM port
)
873 SCM wstr
= scm_i_make_wide_string (1, &wbuf
);
876 scm_lfwrite_str (wstr
, port
);
883 scm_intprint (scm_t_intmax n
, int radix
, SCM port
)
885 char num_buf
[SCM_INTBUFLEN
];
886 scm_lfwrite (num_buf
, scm_iint2str (n
, radix
, num_buf
), port
);
890 scm_uintprint (scm_t_uintmax n
, int radix
, SCM port
)
892 char num_buf
[SCM_INTBUFLEN
];
893 scm_lfwrite (num_buf
, scm_iuint2str (n
, radix
, num_buf
), port
);
896 /* Print an object of unrecognized type.
900 scm_ipruk (char *hdr
, SCM ptr
, SCM port
)
902 scm_puts ("#<unknown-", port
);
903 scm_puts (hdr
, port
);
904 if (1) /* (scm_in_heap_p (ptr)) */ /* FIXME */
906 scm_puts (" (0x", port
);
907 scm_uintprint (SCM_CELL_WORD_0 (ptr
), 16, port
);
908 scm_puts (" . 0x", port
);
909 scm_uintprint (SCM_CELL_WORD_1 (ptr
), 16, port
);
910 scm_puts (") @", port
);
912 scm_puts (" 0x", port
);
913 scm_uintprint (SCM_UNPACK (ptr
), 16, port
);
914 scm_putc ('>', port
);
921 scm_iprlist (char *hdr
, SCM exp
, int tlr
, SCM port
, scm_print_state
*pstate
)
923 register SCM hare
, tortoise
;
924 long floor
= pstate
->top
- 2;
925 scm_puts (hdr
, port
);
930 /* Run a hare and tortoise so that total time complexity will be
931 O(depth * N) instead of O(N^2). */
932 hare
= SCM_CDR (exp
);
934 while (scm_is_pair (hare
))
936 if (scm_is_eq (hare
, tortoise
))
938 hare
= SCM_CDR (hare
);
939 if (!scm_is_pair (hare
))
941 hare
= SCM_CDR (hare
);
942 tortoise
= SCM_CDR (tortoise
);
945 /* No cdr cycles intrinsic to this list */
946 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
947 for (exp
= SCM_CDR (exp
); scm_is_pair (exp
); exp
= SCM_CDR (exp
))
951 for (i
= floor
; i
>= 0; --i
)
952 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), exp
))
954 PUSH_REF (pstate
, exp
);
955 scm_putc (' ', port
);
957 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
959 if (!SCM_NULL_OR_NIL_P (exp
))
961 scm_puts (" . ", port
);
962 scm_iprin1 (exp
, port
, pstate
);
966 scm_putc (tlr
, port
);
967 pstate
->top
= floor
+ 2;
972 long n
= pstate
->length
;
974 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
975 exp
= SCM_CDR (exp
); --n
;
976 for (; scm_is_pair (exp
); exp
= SCM_CDR (exp
))
978 register unsigned long i
;
980 for (i
= 0; i
< pstate
->top
; ++i
)
981 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), exp
))
987 scm_puts (" ...", port
);
993 PUSH_REF(pstate
, exp
);
994 ++pstate
->list_offset
;
995 scm_putc (' ', port
);
997 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1000 if (!SCM_NULL_OR_NIL_P (exp
))
1002 scm_puts (" . ", port
);
1003 scm_iprin1 (exp
, port
, pstate
);
1006 pstate
->list_offset
-= pstate
->top
- floor
- 2;
1010 pstate
->list_offset
-= pstate
->top
- floor
- 2;
1013 scm_puts (" . ", port
);
1014 print_circref (port
, pstate
, exp
);
1021 scm_valid_oport_value_p (SCM val
)
1023 return (SCM_OPOUTPORTP (val
)
1024 || (SCM_PORT_WITH_PS_P (val
)
1025 && SCM_OPOUTPORTP (SCM_PORT_WITH_PS_PORT (val
))));
1028 /* SCM_GPROC(s_write, "write", 1, 1, 0, scm_write, g_write); */
1031 scm_write (SCM obj
, SCM port
)
1033 if (SCM_UNBNDP (port
))
1034 port
= scm_current_output_port ();
1036 SCM_ASSERT (scm_valid_oport_value_p (port
), port
, SCM_ARG2
, s_write
);
1038 scm_prin1 (obj
, port
, 1);
1043 scm_close_port (port
);
1047 return SCM_UNSPECIFIED
;
1051 /* SCM_GPROC(s_display, "display", 1, 1, 0, scm_display, g_display); */
1054 scm_display (SCM obj
, SCM port
)
1056 if (SCM_UNBNDP (port
))
1057 port
= scm_current_output_port ();
1059 SCM_ASSERT (scm_valid_oport_value_p (port
), port
, SCM_ARG2
, s_display
);
1061 scm_prin1 (obj
, port
, 0);
1066 scm_close_port (port
);
1070 return SCM_UNSPECIFIED
;
1074 SCM_DEFINE (scm_simple_format
, "simple-format", 2, 0, 1,
1075 (SCM destination
, SCM message
, SCM args
),
1076 "Write @var{message} to @var{destination}, defaulting to\n"
1077 "the current output port.\n"
1078 "@var{message} can contain @code{~A} (was @code{%s}) and\n"
1079 "@code{~S} (was @code{%S}) escapes. When printed,\n"
1080 "the escapes are replaced with corresponding members of\n"
1082 "@code{~A} formats using @code{display} and @code{~S} formats\n"
1083 "using @code{write}.\n"
1084 "If @var{destination} is @code{#t}, then use the current output\n"
1085 "port, if @var{destination} is @code{#f}, then return a string\n"
1086 "containing the formatted text. Does not add a trailing newline.")
1087 #define FUNC_NAME s_scm_simple_format
1089 SCM port
, answer
= SCM_UNSPECIFIED
;
1090 int fReturnString
= 0;
1092 size_t start
, p
, end
;
1094 if (scm_is_eq (destination
, SCM_BOOL_T
))
1096 destination
= port
= scm_current_output_port ();
1098 else if (scm_is_false (destination
))
1101 port
= scm_mkstrport (SCM_INUM0
,
1102 scm_make_string (SCM_INUM0
, SCM_UNDEFINED
),
1103 SCM_OPN
| SCM_WRTNG
,
1109 SCM_VALIDATE_OPORT_VALUE (1, destination
);
1110 port
= SCM_COERCE_OUTPORT (destination
);
1112 SCM_VALIDATE_STRING (2, message
);
1113 SCM_VALIDATE_REST_ARGUMENT (args
);
1117 end
= scm_i_string_length (message
);
1118 for (p
= start
; p
!= end
; ++p
)
1119 if (scm_i_string_ref (message
, p
) == '~')
1124 switch (scm_i_string_ref (message
, p
))
1133 scm_lfwrite_substr (message
, start
, p
, port
);
1137 scm_lfwrite_substr (message
, start
, p
- 1, port
);
1142 SCM_MISC_ERROR ("FORMAT: Unsupported format option ~~~A - use (ice-9 format) instead",
1143 scm_list_1 (SCM_MAKE_CHAR (scm_i_string_ref (message
, p
))));
1148 if (!scm_is_pair (args
))
1149 SCM_MISC_ERROR ("FORMAT: Missing argument for ~~~A",
1150 scm_list_1 (SCM_MAKE_CHAR (scm_i_string_ref (message
, p
))));
1152 scm_lfwrite_substr (message
, start
, p
- 1, port
);
1153 /* we pass destination here */
1154 scm_prin1 (SCM_CAR (args
), destination
, writingp
);
1155 args
= SCM_CDR (args
);
1159 scm_lfwrite_substr (message
, start
, p
, port
);
1160 if (!scm_is_eq (args
, SCM_EOL
))
1161 SCM_MISC_ERROR ("FORMAT: ~A superfluous arguments",
1162 scm_list_1 (scm_length (args
)));
1165 answer
= scm_strport_to_string (destination
);
1167 return scm_return_first (answer
, message
);
1172 SCM_DEFINE (scm_newline
, "newline", 0, 1, 0,
1174 "Send a newline to @var{port}.\n"
1175 "If @var{port} is omitted, send to the current output port.")
1176 #define FUNC_NAME s_scm_newline
1178 if (SCM_UNBNDP (port
))
1179 port
= scm_current_output_port ();
1181 SCM_VALIDATE_OPORT_VALUE (1, port
);
1183 scm_putc ('\n', SCM_COERCE_OUTPORT (port
));
1184 return SCM_UNSPECIFIED
;
1188 SCM_DEFINE (scm_write_char
, "write-char", 1, 1, 0,
1189 (SCM chr
, SCM port
),
1190 "Send character @var{chr} to @var{port}.")
1191 #define FUNC_NAME s_scm_write_char
1193 if (SCM_UNBNDP (port
))
1194 port
= scm_current_output_port ();
1196 SCM_VALIDATE_CHAR (1, chr
);
1197 SCM_VALIDATE_OPORT_VALUE (2, port
);
1199 scm_i_charprint (SCM_CHAR (chr
), SCM_COERCE_OUTPORT (port
));
1204 scm_close_port (port
);
1208 return SCM_UNSPECIFIED
;
1214 /* Call back to Scheme code to do the printing of special objects
1215 * (like structs). SCM_PRINTER_APPLY applies PROC to EXP and a smob
1216 * containing PORT and PSTATE. This object can be used as the port for
1217 * display/write etc to continue the current print chain. The REVEALED
1218 * field of PSTATE is set to true to indicate that the print state has
1219 * escaped to Scheme and thus has to be freed by the GC.
1222 scm_t_bits scm_tc16_port_with_ps
;
1224 /* Print exactly as the port itself would */
1227 port_with_ps_print (SCM obj
, SCM port
, scm_print_state
*pstate
)
1229 obj
= SCM_PORT_WITH_PS_PORT (obj
);
1230 return scm_ptobs
[SCM_PTOBNUM (obj
)].print (obj
, port
, pstate
);
1234 scm_printer_apply (SCM proc
, SCM exp
, SCM port
, scm_print_state
*pstate
)
1236 pstate
->revealed
= 1;
1237 return scm_call_2 (proc
, exp
,
1238 scm_i_port_with_print_state (port
, pstate
->handle
));
1241 SCM_DEFINE (scm_port_with_print_state
, "port-with-print-state", 1, 1, 0,
1242 (SCM port
, SCM pstate
),
1243 "Create a new port which behaves like @var{port}, but with an\n"
1244 "included print state @var{pstate}. @var{pstate} is optional.\n"
1245 "If @var{pstate} isn't supplied and @var{port} already has\n"
1246 "a print state, the old print state is reused.")
1247 #define FUNC_NAME s_scm_port_with_print_state
1249 SCM_VALIDATE_OPORT_VALUE (1, port
);
1250 if (!SCM_UNBNDP (pstate
))
1251 SCM_VALIDATE_PRINTSTATE (2, pstate
);
1252 return scm_i_port_with_print_state (port
, pstate
);
1256 SCM_DEFINE (scm_get_print_state
, "get-print-state", 1, 0, 0,
1258 "Return the print state of the port @var{port}. If @var{port}\n"
1259 "has no associated print state, @code{#f} is returned.")
1260 #define FUNC_NAME s_scm_get_print_state
1262 if (SCM_PORT_WITH_PS_P (port
))
1263 return SCM_PORT_WITH_PS_PS (port
);
1264 if (SCM_OUTPUT_PORT_P (port
))
1266 SCM_WRONG_TYPE_ARG (1, port
);
1275 SCM vtable
, layout
, type
;
1277 scm_init_opts (scm_print_options
, scm_print_opts
);
1279 scm_print_options (scm_list_4 (scm_from_locale_symbol ("highlight-prefix"),
1280 scm_from_locale_string ("{"),
1281 scm_from_locale_symbol ("highlight-suffix"),
1282 scm_from_locale_string ("}")));
1284 scm_gc_register_root (&print_state_pool
);
1285 scm_gc_register_root (&scm_print_state_vtable
);
1286 vtable
= scm_make_vtable_vtable (scm_nullstr
, SCM_INUM0
, SCM_EOL
);
1288 scm_make_struct_layout (scm_from_locale_string (SCM_PRINT_STATE_LAYOUT
));
1289 type
= scm_make_struct (vtable
, SCM_INUM0
, scm_list_1 (layout
));
1290 scm_set_struct_vtable_name_x (type
, scm_from_locale_symbol ("print-state"));
1291 scm_print_state_vtable
= type
;
1293 /* Don't want to bind a wrapper class in GOOPS, so pass 0 as arg1. */
1294 scm_tc16_port_with_ps
= scm_make_smob_type (0, 0);
1295 scm_set_smob_print (scm_tc16_port_with_ps
, port_with_ps_print
);
1297 #include "libguile/print.x"
1299 scm_print_opts
[SCM_PRINT_KEYWORD_STYLE_I
].val
= SCM_UNPACK (sym_reader
);