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", SCM_UNPACK (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'."
98 SCM_DEFINE (scm_print_options
, "print-options-interface", 0, 1, 0,
100 "Option interface for the print options. Instead of using\n"
101 "this procedure directly, use the procedures\n"
102 "@code{print-enable}, @code{print-disable}, @code{print-set!}\n"
103 "and @code{print-options}.")
104 #define FUNC_NAME s_scm_print_options
106 SCM ans
= scm_options (setting
,
114 /* {Printing of Scheme Objects}
117 /* Detection of circular references.
119 * Due to other constraints in the implementation, this code has bad
120 * time complexity (O (depth * N)), The printer code can be
121 * rewritten to be O(N).
123 #define PUSH_REF(pstate, obj) \
126 PSTATE_STACK_SET (pstate, pstate->top, obj); \
128 if (pstate->top == pstate->ceiling) \
129 grow_ref_stack (pstate); \
132 #define ENTER_NESTED_DATA(pstate, obj, label) \
135 register unsigned long i; \
136 for (i = 0; i < pstate->top; ++i) \
137 if (scm_is_eq (PSTATE_STACK_REF (pstate, i), (obj))) \
139 if (pstate->fancyp) \
141 if (pstate->top - pstate->list_offset >= pstate->level) \
143 scm_putc ('#', port); \
147 PUSH_REF(pstate, obj); \
150 #define EXIT_NESTED_DATA(pstate) \
154 PSTATE_STACK_SET (pstate, pstate->top, SCM_UNDEFINED); \
158 SCM scm_print_state_vtable
= SCM_BOOL_F
;
159 static SCM print_state_pool
= SCM_EOL
;
160 scm_i_pthread_mutex_t print_state_mutex
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
162 #ifdef GUILE_DEBUG /* Used for debugging purposes */
164 SCM_DEFINE (scm_current_pstate
, "current-pstate", 0, 0, 0,
166 "Return the current-pstate -- the car of the\n"
167 "@code{print_state_pool}. @code{current-pstate} is only\n"
168 "included in @code{--enable-guile-debug} builds.")
169 #define FUNC_NAME s_scm_current_pstate
171 if (!scm_is_null (print_state_pool
))
172 return SCM_CAR (print_state_pool
);
180 #define PSTATE_SIZE 50L
183 make_print_state (void)
186 = scm_make_struct (scm_print_state_vtable
, SCM_INUM0
, SCM_EOL
);
187 scm_print_state
*pstate
= SCM_PRINT_STATE (print_state
);
188 pstate
->ref_vect
= scm_c_make_vector (PSTATE_SIZE
, SCM_UNDEFINED
);
189 pstate
->ceiling
= SCM_SIMPLE_VECTOR_LENGTH (pstate
->ref_vect
);
190 pstate
->highlight_objects
= SCM_EOL
;
195 scm_make_print_state ()
197 SCM answer
= SCM_BOOL_F
;
199 /* First try to allocate a print state from the pool */
200 scm_i_pthread_mutex_lock (&print_state_mutex
);
201 if (!scm_is_null (print_state_pool
))
203 answer
= SCM_CAR (print_state_pool
);
204 print_state_pool
= SCM_CDR (print_state_pool
);
206 scm_i_pthread_mutex_unlock (&print_state_mutex
);
208 return scm_is_false (answer
) ? make_print_state () : answer
;
212 scm_free_print_state (SCM print_state
)
215 scm_print_state
*pstate
= SCM_PRINT_STATE (print_state
);
216 /* Cleanup before returning print state to pool.
217 * It is better to do it here. Doing it in scm_prin1
218 * would cost more since that function is called much more
222 pstate
->revealed
= 0;
223 pstate
->highlight_objects
= SCM_EOL
;
224 scm_i_pthread_mutex_lock (&print_state_mutex
);
225 handle
= scm_cons (print_state
, print_state_pool
);
226 print_state_pool
= handle
;
227 scm_i_pthread_mutex_unlock (&print_state_mutex
);
231 scm_i_port_with_print_state (SCM port
, SCM print_state
)
233 if (SCM_UNBNDP (print_state
))
235 if (SCM_PORT_WITH_PS_P (port
))
238 print_state
= scm_make_print_state ();
239 /* port does not need to be coerced since it doesn't have ps */
242 port
= SCM_COERCE_OUTPORT (port
);
243 SCM_RETURN_NEWSMOB (scm_tc16_port_with_ps
,
244 SCM_UNPACK (scm_cons (port
, print_state
)));
248 grow_ref_stack (scm_print_state
*pstate
)
250 SCM old_vect
= pstate
->ref_vect
;
251 size_t old_size
= SCM_SIMPLE_VECTOR_LENGTH (old_vect
);
252 size_t new_size
= 2 * pstate
->ceiling
;
253 SCM new_vect
= scm_c_make_vector (new_size
, SCM_UNDEFINED
);
256 for (i
= 0; i
!= old_size
; ++i
)
257 SCM_SIMPLE_VECTOR_SET (new_vect
, i
, SCM_SIMPLE_VECTOR_REF (old_vect
, i
));
259 pstate
->ref_vect
= new_vect
;
260 pstate
->ceiling
= new_size
;
263 #define PSTATE_STACK_REF(p,i) SCM_SIMPLE_VECTOR_REF((p)->ref_vect, (i))
264 #define PSTATE_STACK_SET(p,i,v) SCM_SIMPLE_VECTOR_SET((p)->ref_vect, (i), (v))
267 print_circref (SCM port
, scm_print_state
*pstate
, SCM ref
)
270 long self
= pstate
->top
- 1;
272 if (scm_is_pair (PSTATE_STACK_REF (pstate
, i
)))
276 if (!scm_is_pair (PSTATE_STACK_REF (pstate
, i
-1))
277 || !scm_is_eq (SCM_CDR (PSTATE_STACK_REF (pstate
, i
-1)),
278 SCM_CDR (PSTATE_STACK_REF (pstate
, i
))))
284 for (i
= pstate
->top
- 1; 1; --i
)
285 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), ref
))
287 scm_putc ('#', port
);
288 scm_intprint (i
- self
, 10, port
);
289 scm_putc ('#', port
);
292 /* Print the name of a symbol. */
295 quote_keywordish_symbol (SCM symbol
)
299 if (scm_i_symbol_ref (symbol
, 0) != ':'
300 && scm_i_symbol_ref (symbol
, scm_i_symbol_length (symbol
) - 1) != ':')
303 option
= SCM_PRINT_KEYWORD_STYLE
;
304 if (scm_is_false (option
))
306 if (scm_is_eq (option
, sym_reader
))
307 return scm_is_true (SCM_PACK (SCM_KEYWORD_STYLE
));
312 scm_i_print_symbol_name (SCM str
, SCM port
)
314 /* This points to the first character that has not yet been written to the
317 /* This points to the character we're currently looking at. */
319 /* If the name contains weird characters, we'll escape them with
320 * backslashes and set this flag; it indicates that we should surround the
321 * name with "#{" and "}#". */
323 /* Backslashes are not sufficient to make a name weird, but if a name is
324 * weird because of other characters, backslahes need to be escaped too.
325 * The first time we see a backslash, we set maybe_weird, and mw_pos points
326 * to the backslash. Then if the name turns out to be weird, we re-process
327 * everything starting from mw_pos.
328 * We could instead make backslashes always weird. This is not necessary
329 * to ensure that the output is (read)-able, but it would make this code
330 * simpler and faster. */
333 size_t len
= scm_i_symbol_length (str
);
334 scm_t_wchar str0
= scm_i_symbol_ref (str
, 0);
336 if (len
== 0 || str0
== '\'' || str0
== '`' || str0
== ','
337 || quote_keywordish_symbol (str
)
338 || (str0
== '.' && len
== 1)
339 || scm_is_true (scm_i_string_to_number (scm_symbol_to_string (str
), 10)))
341 scm_lfwrite ("#{", 2, port
);
345 for (end
= pos
; end
< len
; ++end
)
346 switch (scm_i_symbol_ref (str
, end
))
348 #ifdef BRACKETS_AS_PARENS
357 case SCM_WHITE_SPACES
:
358 case SCM_LINE_INCREMENTORS
:
367 scm_lfwrite ("#{", 2, port
);
371 scm_lfwrite_substr (scm_symbol_to_string (str
), pos
, end
, port
);
375 buf
[1] = (char) (unsigned char) scm_i_symbol_ref (str
, end
);
376 scm_lfwrite (buf
, 2, port
);
393 scm_lfwrite_substr (scm_symbol_to_string (str
), pos
, end
, port
);
395 scm_lfwrite ("}#", 2, port
);
399 scm_print_symbol_name (const char *str
, size_t len
, SCM port
)
401 SCM symbol
= scm_from_locale_symboln (str
, len
);
402 scm_i_print_symbol_name (symbol
, port
);
405 /* Print generally. Handles both write and display according to PSTATE.
407 SCM_GPROC(s_write
, "write", 1, 1, 0, scm_write
, g_write
);
408 SCM_GPROC(s_display
, "display", 1, 1, 0, scm_display
, g_display
);
410 static void iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
);
413 scm_iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
)
416 && scm_is_true (scm_memq (exp
, pstate
->highlight_objects
)))
418 scm_display (SCM_PRINT_HIGHLIGHT_PREFIX
, port
);
419 iprin1 (exp
, port
, pstate
);
420 scm_display (SCM_PRINT_HIGHLIGHT_SUFFIX
, port
);
423 iprin1 (exp
, port
, pstate
);
427 iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
)
429 switch (SCM_ITAG3 (exp
))
433 /* These tc3 tags should never occur in an immediate value. They are
434 * only used in cell types of non-immediates, i. e. the value returned
435 * by SCM_CELL_TYPE (exp) can use these tags.
437 scm_ipruk ("immediate", exp
, port
);
441 scm_intprint (SCM_I_INUM (exp
), 10, port
);
446 scm_t_wchar i
= SCM_CHAR (exp
);
449 if (SCM_WRITINGP (pstate
))
451 scm_puts ("#\\", port
);
452 name
= scm_i_charname (exp
);
454 scm_puts (name
, port
);
455 else if (uc_is_general_category_withtable (i
, UC_CATEGORY_MASK_L
459 | UC_CATEGORY_MASK_S
))
460 /* Print the character if is graphic character. */
468 enc
= scm_i_get_port_encoding (port
);
469 if (uc_combining_class (i
) == UC_CCC_NR
)
471 wstr
= scm_i_make_wide_string (1, &wbuf
);
476 /* Character is a combining character: print it connected
477 to a dotted circle instead of connecting it to the
479 wstr
= scm_i_make_wide_string (2, &wbuf
);
480 wbuf
[0] = SCM_CODEPOINT_DOTTED_CIRCLE
;
486 /* Character is graphic and Latin-1. Print it */
487 scm_lfwrite_str (wstr
, port
);
489 /* Character is graphic but unrepresentable in
490 this port's encoding. */
491 scm_intprint (i
, 8, port
);
495 buf
= u32_conv_to_encoding (enc
,
497 (scm_t_uint32
*) wbuf
,
503 /* Character is graphic. Print it. */
504 scm_lfwrite_str (wstr
, port
);
508 /* Character is graphic but unrepresentable in
509 this port's encoding. */
510 scm_intprint (i
, 8, port
);
514 /* Character is a non-graphical character. */
515 scm_intprint (i
, 8, port
);
518 scm_i_charprint (i
, port
);
520 else if (SCM_IFLAGP (exp
)
521 && ((size_t) SCM_IFLAGNUM (exp
) < (sizeof iflagnames
/ sizeof (char *))))
523 scm_puts (iflagnames
[SCM_IFLAGNUM (exp
)], port
);
527 /* unknown immediate value */
528 scm_ipruk ("immediate", exp
, port
);
532 switch (SCM_TYP7 (exp
))
536 ENTER_NESTED_DATA (pstate
, exp
, circref
);
537 if (SCM_OBJ_CLASS_FLAGS (exp
) & SCM_CLASSF_GOOPS
)
539 SCM pwps
, print
= pstate
->writingp
? g_write
: g_display
;
542 pwps
= scm_i_port_with_print_state (port
, pstate
->handle
);
543 pstate
->revealed
= 1;
544 scm_call_generic_2 (print
, exp
, pwps
);
549 scm_print_struct (exp
, port
, pstate
);
551 EXIT_NESTED_DATA (pstate
);
554 case scm_tcs_cons_imcar
:
555 case scm_tcs_cons_nimcar
:
556 ENTER_NESTED_DATA (pstate
, exp
, circref
);
557 scm_iprlist ("(", exp
, ')', port
, pstate
);
558 EXIT_NESTED_DATA (pstate
);
561 print_circref (port
, pstate
, exp
);
564 switch SCM_TYP16 (exp
) {
566 scm_bigprint (exp
, port
, pstate
);
569 scm_print_real (exp
, port
, pstate
);
571 case scm_tc16_complex
:
572 scm_print_complex (exp
, port
, pstate
);
574 case scm_tc16_fraction
:
575 scm_i_print_fraction (exp
, port
, pstate
);
580 if (SCM_WRITINGP (pstate
))
583 static char const hex
[] = "0123456789abcdef";
587 scm_putc ('"', port
);
588 len
= scm_i_string_length (exp
);
589 for (i
= 0; i
< len
; ++i
)
591 scm_t_wchar ch
= scm_i_string_ref (exp
, i
);
594 if (ch
== ' ' || ch
== '\n')
599 else if (ch
== '"' || ch
== '\\')
601 scm_putc ('\\', port
);
602 scm_i_charprint (ch
, port
);
606 if (uc_is_general_category_withtable
608 UC_CATEGORY_MASK_L
| UC_CATEGORY_MASK_M
|
609 UC_CATEGORY_MASK_N
| UC_CATEGORY_MASK_P
|
612 /* Print the character since it is a graphic
615 SCM wstr
= scm_i_make_wide_string (1, &wbuf
);
619 if (scm_i_get_port_encoding (port
))
621 wstr
= scm_i_make_wide_string (1, &wbuf
);
623 buf
= u32_conv_to_encoding (scm_i_get_port_encoding (port
),
625 (scm_t_uint32
*) wbuf
,
631 /* Character is graphic and representable in
632 this encoding. Print it. */
633 scm_lfwrite_str (wstr
, port
);
648 /* Character is graphic but unrepresentable in
649 this port's encoding or is not graphic. */
654 buf
[2] = hex
[ch
/ 16];
655 buf
[3] = hex
[ch
% 16];
656 scm_lfwrite (buf
, 4, port
);
658 else if (ch
<= 0xFFFF)
662 buf
[2] = hex
[(ch
& 0xF000) >> 12];
663 buf
[3] = hex
[(ch
& 0xF00) >> 8];
664 buf
[4] = hex
[(ch
& 0xF0) >> 4];
665 buf
[5] = hex
[(ch
& 0xF)];
666 scm_lfwrite (buf
, 6, port
);
669 else if (ch
> 0xFFFF)
673 buf
[2] = hex
[(ch
& 0xF00000) >> 20];
674 buf
[3] = hex
[(ch
& 0xF0000) >> 16];
675 buf
[4] = hex
[(ch
& 0xF000) >> 12];
676 buf
[5] = hex
[(ch
& 0xF00) >> 8];
677 buf
[6] = hex
[(ch
& 0xF0) >> 4];
678 buf
[7] = hex
[(ch
& 0xF)];
679 scm_lfwrite (buf
, 8, port
);
684 scm_putc ('"', port
);
685 scm_remember_upto_here_1 (exp
);
688 scm_lfwrite_str (exp
, port
);
689 scm_remember_upto_here_1 (exp
);
692 if (scm_i_symbol_is_interned (exp
))
694 scm_i_print_symbol_name (exp
, port
);
695 scm_remember_upto_here_1 (exp
);
699 scm_puts ("#<uninterned-symbol ", port
);
700 scm_i_print_symbol_name (exp
, port
);
701 scm_putc (' ', port
);
702 scm_uintprint (SCM_UNPACK (exp
), 16, port
);
703 scm_putc ('>', port
);
706 case scm_tc7_variable
:
707 scm_i_variable_print (exp
, port
, pstate
);
709 case scm_tc7_program
:
710 scm_i_program_print (exp
, port
, pstate
);
712 case scm_tc7_hashtable
:
713 scm_i_hashtable_print (exp
, port
, pstate
);
716 scm_i_fluid_print (exp
, port
, pstate
);
718 case scm_tc7_dynamic_state
:
719 scm_i_dynamic_state_print (exp
, port
, pstate
);
722 ENTER_NESTED_DATA (pstate
, exp
, circref
);
723 if (SCM_IS_WHVEC (exp
))
724 scm_puts ("#wh(", port
);
726 scm_puts ("#w(", port
);
727 goto common_vector_printer
;
729 case scm_tc7_bytevector
:
730 scm_i_print_bytevector (exp
, port
, pstate
);
733 ENTER_NESTED_DATA (pstate
, exp
, circref
);
734 scm_puts ("#(", port
);
735 common_vector_printer
:
738 long last
= SCM_SIMPLE_VECTOR_LENGTH (exp
) - 1;
741 && SCM_SIMPLE_VECTOR_LENGTH (exp
) > pstate
->length
)
743 last
= pstate
->length
- 1;
746 if (SCM_I_WVECTP (exp
))
748 /* Elements of weak vectors may not be accessed via the
749 `SIMPLE_VECTOR_REF ()' macro. */
750 for (i
= 0; i
< last
; ++i
)
752 scm_iprin1 (scm_c_vector_ref (exp
, i
),
754 scm_putc (' ', port
);
759 for (i
= 0; i
< last
; ++i
)
761 scm_iprin1 (SCM_SIMPLE_VECTOR_REF (exp
, i
), port
, pstate
);
762 scm_putc (' ', port
);
769 scm_iprin1 (scm_c_vector_ref (exp
, i
), port
, pstate
);
772 scm_puts (" ...", port
);
773 scm_putc (')', port
);
775 EXIT_NESTED_DATA (pstate
);
779 SCM name
= scm_symbol_to_string (SCM_SUBR_NAME (exp
));
780 scm_puts (SCM_SUBR_GENERIC (exp
)
781 ? "#<primitive-generic "
782 : "#<primitive-procedure ",
784 scm_lfwrite_str (name
, port
);
785 scm_putc ('>', port
);
790 register long i
= SCM_PTOBNUM (exp
);
792 && scm_ptobs
[i
].print
793 && (scm_ptobs
[i
].print
) (exp
, port
, pstate
))
798 ENTER_NESTED_DATA (pstate
, exp
, circref
);
799 SCM_SMOB_DESCRIPTOR (exp
).print (exp
, port
, pstate
);
800 EXIT_NESTED_DATA (pstate
);
803 /* case scm_tcs_closures: */
805 scm_ipruk ("type", exp
, port
);
810 /* Print states are necessary for circular reference safe printing.
811 * They are also expensive to allocate. Therefore print states are
812 * kept in a pool so that they can be reused.
815 /* The PORT argument can also be a print-state/port pair, which will
816 * then be used instead of allocating a new print state. This is
817 * useful for continuing a chain of print calls from Scheme. */
820 scm_prin1 (SCM exp
, SCM port
, int writingp
)
822 SCM handle
= SCM_BOOL_F
; /* Will GC protect the handle whilst unlinked */
824 scm_print_state
*pstate
;
827 /* If PORT is a print-state/port pair, use that. Else create a new
830 if (SCM_PORT_WITH_PS_P (port
))
832 pstate_scm
= SCM_PORT_WITH_PS_PS (port
);
833 port
= SCM_PORT_WITH_PS_PORT (port
);
837 /* First try to allocate a print state from the pool */
838 scm_i_pthread_mutex_lock (&print_state_mutex
);
839 if (!scm_is_null (print_state_pool
))
841 handle
= print_state_pool
;
842 print_state_pool
= SCM_CDR (print_state_pool
);
844 scm_i_pthread_mutex_unlock (&print_state_mutex
);
845 if (scm_is_false (handle
))
846 handle
= scm_list_1 (make_print_state ());
847 pstate_scm
= SCM_CAR (handle
);
850 pstate
= SCM_PRINT_STATE (pstate_scm
);
851 old_writingp
= pstate
->writingp
;
852 pstate
->writingp
= writingp
;
853 scm_iprin1 (exp
, port
, pstate
);
854 pstate
->writingp
= old_writingp
;
856 /* Return print state to pool if it has been created above and
857 hasn't escaped to Scheme. */
859 if (scm_is_true (handle
) && !pstate
->revealed
)
861 scm_i_pthread_mutex_lock (&print_state_mutex
);
862 SCM_SETCDR (handle
, print_state_pool
);
863 print_state_pool
= handle
;
864 scm_i_pthread_mutex_unlock (&print_state_mutex
);
868 /* Print a character.
871 scm_i_charprint (scm_t_wchar ch
, SCM port
)
874 SCM wstr
= scm_i_make_wide_string (1, &wbuf
);
877 scm_lfwrite_str (wstr
, port
);
884 scm_intprint (scm_t_intmax n
, int radix
, SCM port
)
886 char num_buf
[SCM_INTBUFLEN
];
887 scm_lfwrite (num_buf
, scm_iint2str (n
, radix
, num_buf
), port
);
891 scm_uintprint (scm_t_uintmax n
, int radix
, SCM port
)
893 char num_buf
[SCM_INTBUFLEN
];
894 scm_lfwrite (num_buf
, scm_iuint2str (n
, radix
, num_buf
), port
);
897 /* Print an object of unrecognized type.
901 scm_ipruk (char *hdr
, SCM ptr
, SCM port
)
903 scm_puts ("#<unknown-", port
);
904 scm_puts (hdr
, port
);
905 if (1) /* (scm_in_heap_p (ptr)) */ /* FIXME */
907 scm_puts (" (0x", port
);
908 scm_uintprint (SCM_CELL_WORD_0 (ptr
), 16, port
);
909 scm_puts (" . 0x", port
);
910 scm_uintprint (SCM_CELL_WORD_1 (ptr
), 16, port
);
911 scm_puts (") @", port
);
913 scm_puts (" 0x", port
);
914 scm_uintprint (SCM_UNPACK (ptr
), 16, port
);
915 scm_putc ('>', port
);
922 scm_iprlist (char *hdr
, SCM exp
, int tlr
, SCM port
, scm_print_state
*pstate
)
924 register SCM hare
, tortoise
;
925 long floor
= pstate
->top
- 2;
926 scm_puts (hdr
, port
);
931 /* Run a hare and tortoise so that total time complexity will be
932 O(depth * N) instead of O(N^2). */
933 hare
= SCM_CDR (exp
);
935 while (scm_is_pair (hare
))
937 if (scm_is_eq (hare
, tortoise
))
939 hare
= SCM_CDR (hare
);
940 if (!scm_is_pair (hare
))
942 hare
= SCM_CDR (hare
);
943 tortoise
= SCM_CDR (tortoise
);
946 /* No cdr cycles intrinsic to this list */
947 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
948 for (exp
= SCM_CDR (exp
); scm_is_pair (exp
); exp
= SCM_CDR (exp
))
952 for (i
= floor
; i
>= 0; --i
)
953 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), exp
))
955 PUSH_REF (pstate
, exp
);
956 scm_putc (' ', port
);
958 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
960 if (!SCM_NULL_OR_NIL_P (exp
))
962 scm_puts (" . ", port
);
963 scm_iprin1 (exp
, port
, pstate
);
967 scm_putc (tlr
, port
);
968 pstate
->top
= floor
+ 2;
973 long n
= pstate
->length
;
975 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
976 exp
= SCM_CDR (exp
); --n
;
977 for (; scm_is_pair (exp
); exp
= SCM_CDR (exp
))
979 register unsigned long i
;
981 for (i
= 0; i
< pstate
->top
; ++i
)
982 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), exp
))
988 scm_puts (" ...", port
);
994 PUSH_REF(pstate
, exp
);
995 ++pstate
->list_offset
;
996 scm_putc (' ', port
);
998 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1001 if (!SCM_NULL_OR_NIL_P (exp
))
1003 scm_puts (" . ", port
);
1004 scm_iprin1 (exp
, port
, pstate
);
1007 pstate
->list_offset
-= pstate
->top
- floor
- 2;
1011 pstate
->list_offset
-= pstate
->top
- floor
- 2;
1014 scm_puts (" . ", port
);
1015 print_circref (port
, pstate
, exp
);
1022 scm_valid_oport_value_p (SCM val
)
1024 return (SCM_OPOUTPORTP (val
)
1025 || (SCM_PORT_WITH_PS_P (val
)
1026 && SCM_OPOUTPORTP (SCM_PORT_WITH_PS_PORT (val
))));
1029 /* SCM_GPROC(s_write, "write", 1, 1, 0, scm_write, g_write); */
1032 scm_write (SCM obj
, SCM port
)
1034 if (SCM_UNBNDP (port
))
1035 port
= scm_current_output_port ();
1037 SCM_ASSERT (scm_valid_oport_value_p (port
), port
, SCM_ARG2
, s_write
);
1039 scm_prin1 (obj
, port
, 1);
1044 scm_close_port (port
);
1048 return SCM_UNSPECIFIED
;
1052 /* SCM_GPROC(s_display, "display", 1, 1, 0, scm_display, g_display); */
1055 scm_display (SCM obj
, SCM port
)
1057 if (SCM_UNBNDP (port
))
1058 port
= scm_current_output_port ();
1060 SCM_ASSERT (scm_valid_oport_value_p (port
), port
, SCM_ARG2
, s_display
);
1062 scm_prin1 (obj
, port
, 0);
1067 scm_close_port (port
);
1071 return SCM_UNSPECIFIED
;
1075 SCM_DEFINE (scm_simple_format
, "simple-format", 2, 0, 1,
1076 (SCM destination
, SCM message
, SCM args
),
1077 "Write @var{message} to @var{destination}, defaulting to\n"
1078 "the current output port.\n"
1079 "@var{message} can contain @code{~A} (was @code{%s}) and\n"
1080 "@code{~S} (was @code{%S}) escapes. When printed,\n"
1081 "the escapes are replaced with corresponding members of\n"
1083 "@code{~A} formats using @code{display} and @code{~S} formats\n"
1084 "using @code{write}.\n"
1085 "If @var{destination} is @code{#t}, then use the current output\n"
1086 "port, if @var{destination} is @code{#f}, then return a string\n"
1087 "containing the formatted text. Does not add a trailing newline.")
1088 #define FUNC_NAME s_scm_simple_format
1090 SCM port
, answer
= SCM_UNSPECIFIED
;
1091 int fReturnString
= 0;
1093 size_t start
, p
, end
;
1095 if (scm_is_eq (destination
, SCM_BOOL_T
))
1097 destination
= port
= scm_current_output_port ();
1099 else if (scm_is_false (destination
))
1102 port
= scm_mkstrport (SCM_INUM0
,
1103 scm_make_string (SCM_INUM0
, SCM_UNDEFINED
),
1104 SCM_OPN
| SCM_WRTNG
,
1110 SCM_VALIDATE_OPORT_VALUE (1, destination
);
1111 port
= SCM_COERCE_OUTPORT (destination
);
1113 SCM_VALIDATE_STRING (2, message
);
1114 SCM_VALIDATE_REST_ARGUMENT (args
);
1118 end
= scm_i_string_length (message
);
1119 for (p
= start
; p
!= end
; ++p
)
1120 if (scm_i_string_ref (message
, p
) == '~')
1125 switch (scm_i_string_ref (message
, p
))
1134 scm_lfwrite_substr (message
, start
, p
, port
);
1138 scm_lfwrite_substr (message
, start
, p
- 1, port
);
1143 SCM_MISC_ERROR ("FORMAT: Unsupported format option ~~~A - use (ice-9 format) instead",
1144 scm_list_1 (SCM_MAKE_CHAR (scm_i_string_ref (message
, p
))));
1149 if (!scm_is_pair (args
))
1150 SCM_MISC_ERROR ("FORMAT: Missing argument for ~~~A",
1151 scm_list_1 (SCM_MAKE_CHAR (scm_i_string_ref (message
, p
))));
1153 scm_lfwrite_substr (message
, start
, p
- 1, port
);
1154 /* we pass destination here */
1155 scm_prin1 (SCM_CAR (args
), destination
, writingp
);
1156 args
= SCM_CDR (args
);
1160 scm_lfwrite_substr (message
, start
, p
, port
);
1161 if (!scm_is_eq (args
, SCM_EOL
))
1162 SCM_MISC_ERROR ("FORMAT: ~A superfluous arguments",
1163 scm_list_1 (scm_length (args
)));
1166 answer
= scm_strport_to_string (destination
);
1168 return scm_return_first (answer
, message
);
1173 SCM_DEFINE (scm_newline
, "newline", 0, 1, 0,
1175 "Send a newline to @var{port}.\n"
1176 "If @var{port} is omitted, send to the current output port.")
1177 #define FUNC_NAME s_scm_newline
1179 if (SCM_UNBNDP (port
))
1180 port
= scm_current_output_port ();
1182 SCM_VALIDATE_OPORT_VALUE (1, port
);
1184 scm_putc ('\n', SCM_COERCE_OUTPORT (port
));
1185 return SCM_UNSPECIFIED
;
1189 SCM_DEFINE (scm_write_char
, "write-char", 1, 1, 0,
1190 (SCM chr
, SCM port
),
1191 "Send character @var{chr} to @var{port}.")
1192 #define FUNC_NAME s_scm_write_char
1194 if (SCM_UNBNDP (port
))
1195 port
= scm_current_output_port ();
1197 SCM_VALIDATE_CHAR (1, chr
);
1198 SCM_VALIDATE_OPORT_VALUE (2, port
);
1200 scm_i_charprint (SCM_CHAR (chr
), SCM_COERCE_OUTPORT (port
));
1205 scm_close_port (port
);
1209 return SCM_UNSPECIFIED
;
1215 /* Call back to Scheme code to do the printing of special objects
1216 * (like structs). SCM_PRINTER_APPLY applies PROC to EXP and a smob
1217 * containing PORT and PSTATE. This object can be used as the port for
1218 * display/write etc to continue the current print chain. The REVEALED
1219 * field of PSTATE is set to true to indicate that the print state has
1220 * escaped to Scheme and thus has to be freed by the GC.
1223 scm_t_bits scm_tc16_port_with_ps
;
1225 /* Print exactly as the port itself would */
1228 port_with_ps_print (SCM obj
, SCM port
, scm_print_state
*pstate
)
1230 obj
= SCM_PORT_WITH_PS_PORT (obj
);
1231 return scm_ptobs
[SCM_PTOBNUM (obj
)].print (obj
, port
, pstate
);
1235 scm_printer_apply (SCM proc
, SCM exp
, SCM port
, scm_print_state
*pstate
)
1237 pstate
->revealed
= 1;
1238 return scm_call_2 (proc
, exp
,
1239 scm_i_port_with_print_state (port
, pstate
->handle
));
1242 SCM_DEFINE (scm_port_with_print_state
, "port-with-print-state", 1, 1, 0,
1243 (SCM port
, SCM pstate
),
1244 "Create a new port which behaves like @var{port}, but with an\n"
1245 "included print state @var{pstate}. @var{pstate} is optional.\n"
1246 "If @var{pstate} isn't supplied and @var{port} already has\n"
1247 "a print state, the old print state is reused.")
1248 #define FUNC_NAME s_scm_port_with_print_state
1250 SCM_VALIDATE_OPORT_VALUE (1, port
);
1251 if (!SCM_UNBNDP (pstate
))
1252 SCM_VALIDATE_PRINTSTATE (2, pstate
);
1253 return scm_i_port_with_print_state (port
, pstate
);
1257 SCM_DEFINE (scm_get_print_state
, "get-print-state", 1, 0, 0,
1259 "Return the print state of the port @var{port}. If @var{port}\n"
1260 "has no associated print state, @code{#f} is returned.")
1261 #define FUNC_NAME s_scm_get_print_state
1263 if (SCM_PORT_WITH_PS_P (port
))
1264 return SCM_PORT_WITH_PS_PS (port
);
1265 if (SCM_OUTPUT_PORT_P (port
))
1267 SCM_WRONG_TYPE_ARG (1, port
);
1276 SCM vtable
, layout
, type
;
1278 scm_init_opts (scm_print_options
, scm_print_opts
);
1280 scm_print_options (scm_list_4 (scm_from_locale_symbol ("highlight-prefix"),
1281 scm_from_locale_string ("{"),
1282 scm_from_locale_symbol ("highlight-suffix"),
1283 scm_from_locale_string ("}")));
1285 scm_gc_register_root (&print_state_pool
);
1286 scm_gc_register_root (&scm_print_state_vtable
);
1287 vtable
= scm_make_vtable_vtable (scm_nullstr
, SCM_INUM0
, SCM_EOL
);
1289 scm_make_struct_layout (scm_from_locale_string (SCM_PRINT_STATE_LAYOUT
));
1290 type
= scm_make_struct (vtable
, SCM_INUM0
, scm_list_1 (layout
));
1291 scm_set_struct_vtable_name_x (type
, scm_from_locale_symbol ("print-state"));
1292 scm_print_state_vtable
= type
;
1294 /* Don't want to bind a wrapper class in GOOPS, so pass 0 as arg1. */
1295 scm_tc16_port_with_ps
= scm_make_smob_type (0, 0);
1296 scm_set_smob_print (scm_tc16_port_with_ps
, port_with_ps_print
);
1298 #include "libguile/print.x"
1300 scm_print_opts
[SCM_PRINT_KEYWORD_STYLE_I
].val
= SCM_UNPACK (sym_reader
);