1 /* Copyright (C) 1995-1999,2000,2001, 2002, 2003, 2004, 2006, 2008, 2009, 2010 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/control.h"
34 #include "libguile/eval.h"
35 #include "libguile/macros.h"
36 #include "libguile/procprop.h"
37 #include "libguile/read.h"
38 #include "libguile/weaks.h"
39 #include "libguile/programs.h"
40 #include "libguile/alist.h"
41 #include "libguile/struct.h"
42 #include "libguile/ports.h"
43 #include "libguile/root.h"
44 #include "libguile/strings.h"
45 #include "libguile/strports.h"
46 #include "libguile/vectors.h"
47 #include "libguile/numbers.h"
48 #include "libguile/vm.h"
50 #include "libguile/validate.h"
51 #include "libguile/print.h"
53 #include "libguile/private-options.h"
57 /* {Names of immediate symbols}
59 * This table must agree with the declarations in scm.h: {Immediate Symbols}.
62 /* This table must agree with the list of flags in tags.h. */
63 static const char *iflagnames
[] =
66 "#nil", /* Elisp nil value. Should print from elisp as symbol `nil'. */
67 "#<XXX UNUSED LISP FALSE -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
70 "#<XXX UNUSED BOOLEAN 0 -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
71 "#<XXX UNUSED BOOLEAN 1 -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
72 "#<XXX UNUSED BOOLEAN 2 -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
77 /* Unbound slot marker for GOOPS. For internal use in GOOPS only. */
81 SCM_SYMBOL (sym_reader
, "reader");
83 scm_t_option scm_print_opts
[] = {
84 { SCM_OPTION_SCM
, "closure-hook", (unsigned long) SCM_BOOL_F
,
85 "Hook for printing closures (should handle macros as well)." },
86 { SCM_OPTION_BOOLEAN
, "source", 0,
87 "Print closures with source." },
88 { SCM_OPTION_SCM
, "highlight-prefix", (unsigned long)SCM_BOOL_F
,
89 "The string to print before highlighted values." },
90 { SCM_OPTION_SCM
, "highlight-suffix", (unsigned long)SCM_BOOL_F
,
91 "The string to print after highlighted values." },
92 { SCM_OPTION_SCM
, "quote-keywordish-symbols", (unsigned long)SCM_BOOL_F
,
93 "How to print symbols that have a colon as their first or last character. "
94 "The value '#f' does not quote the colons; '#t' quotes them; "
95 "'reader' quotes them when the reader option 'keywords' is not '#f'."
100 SCM_DEFINE (scm_print_options
, "print-options-interface", 0, 1, 0,
102 "Option interface for the print options. Instead of using\n"
103 "this procedure directly, use the procedures\n"
104 "@code{print-enable}, @code{print-disable}, @code{print-set!}\n"
105 "and @code{print-options}.")
106 #define FUNC_NAME s_scm_print_options
108 SCM ans
= scm_options (setting
,
116 /* {Printing of Scheme Objects}
119 /* Detection of circular references.
121 * Due to other constraints in the implementation, this code has bad
122 * time complexity (O (depth * N)), The printer code can be
123 * rewritten to be O(N).
125 #define PUSH_REF(pstate, obj) \
128 PSTATE_STACK_SET (pstate, pstate->top, obj); \
130 if (pstate->top == pstate->ceiling) \
131 grow_ref_stack (pstate); \
134 #define ENTER_NESTED_DATA(pstate, obj, label) \
137 register unsigned long i; \
138 for (i = 0; i < pstate->top; ++i) \
139 if (scm_is_eq (PSTATE_STACK_REF (pstate, i), (obj))) \
141 if (pstate->fancyp) \
143 if (pstate->top - pstate->list_offset >= pstate->level) \
145 scm_putc ('#', port); \
149 PUSH_REF(pstate, obj); \
152 #define EXIT_NESTED_DATA(pstate) \
156 PSTATE_STACK_SET (pstate, pstate->top, SCM_UNDEFINED); \
160 SCM scm_print_state_vtable
= SCM_BOOL_F
;
161 static SCM print_state_pool
= SCM_EOL
;
162 scm_i_pthread_mutex_t print_state_mutex
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
164 #ifdef GUILE_DEBUG /* Used for debugging purposes */
166 SCM_DEFINE (scm_current_pstate
, "current-pstate", 0, 0, 0,
168 "Return the current-pstate -- the car of the\n"
169 "@code{print_state_pool}. @code{current-pstate} is only\n"
170 "included in @code{--enable-guile-debug} builds.")
171 #define FUNC_NAME s_scm_current_pstate
173 if (!scm_is_null (print_state_pool
))
174 return SCM_CAR (print_state_pool
);
182 #define PSTATE_SIZE 50L
185 make_print_state (void)
188 = scm_make_struct (scm_print_state_vtable
, SCM_INUM0
, SCM_EOL
);
189 scm_print_state
*pstate
= SCM_PRINT_STATE (print_state
);
190 pstate
->ref_vect
= scm_c_make_vector (PSTATE_SIZE
, SCM_UNDEFINED
);
191 pstate
->ceiling
= SCM_SIMPLE_VECTOR_LENGTH (pstate
->ref_vect
);
192 pstate
->highlight_objects
= SCM_EOL
;
197 scm_make_print_state ()
199 SCM answer
= SCM_BOOL_F
;
201 /* First try to allocate a print state from the pool */
202 scm_i_pthread_mutex_lock (&print_state_mutex
);
203 if (!scm_is_null (print_state_pool
))
205 answer
= SCM_CAR (print_state_pool
);
206 print_state_pool
= SCM_CDR (print_state_pool
);
208 scm_i_pthread_mutex_unlock (&print_state_mutex
);
210 return scm_is_false (answer
) ? make_print_state () : answer
;
214 scm_free_print_state (SCM print_state
)
217 scm_print_state
*pstate
= SCM_PRINT_STATE (print_state
);
218 /* Cleanup before returning print state to pool.
219 * It is better to do it here. Doing it in scm_prin1
220 * would cost more since that function is called much more
224 pstate
->revealed
= 0;
225 pstate
->highlight_objects
= SCM_EOL
;
226 scm_i_pthread_mutex_lock (&print_state_mutex
);
227 handle
= scm_cons (print_state
, print_state_pool
);
228 print_state_pool
= handle
;
229 scm_i_pthread_mutex_unlock (&print_state_mutex
);
233 scm_i_port_with_print_state (SCM port
, SCM print_state
)
235 if (SCM_UNBNDP (print_state
))
237 if (SCM_PORT_WITH_PS_P (port
))
240 print_state
= scm_make_print_state ();
241 /* port does not need to be coerced since it doesn't have ps */
244 port
= SCM_COERCE_OUTPORT (port
);
245 SCM_RETURN_NEWSMOB (scm_tc16_port_with_ps
,
246 SCM_UNPACK (scm_cons (port
, print_state
)));
250 grow_ref_stack (scm_print_state
*pstate
)
252 SCM old_vect
= pstate
->ref_vect
;
253 size_t old_size
= SCM_SIMPLE_VECTOR_LENGTH (old_vect
);
254 size_t new_size
= 2 * pstate
->ceiling
;
255 SCM new_vect
= scm_c_make_vector (new_size
, SCM_UNDEFINED
);
258 for (i
= 0; i
!= old_size
; ++i
)
259 SCM_SIMPLE_VECTOR_SET (new_vect
, i
, SCM_SIMPLE_VECTOR_REF (old_vect
, i
));
261 pstate
->ref_vect
= new_vect
;
262 pstate
->ceiling
= new_size
;
265 #define PSTATE_STACK_REF(p,i) SCM_SIMPLE_VECTOR_REF((p)->ref_vect, (i))
266 #define PSTATE_STACK_SET(p,i,v) SCM_SIMPLE_VECTOR_SET((p)->ref_vect, (i), (v))
269 print_circref (SCM port
, scm_print_state
*pstate
, SCM ref
)
272 long self
= pstate
->top
- 1;
274 if (scm_is_pair (PSTATE_STACK_REF (pstate
, i
)))
278 if (!scm_is_pair (PSTATE_STACK_REF (pstate
, i
-1))
279 || !scm_is_eq (SCM_CDR (PSTATE_STACK_REF (pstate
, i
-1)),
280 SCM_CDR (PSTATE_STACK_REF (pstate
, i
))))
286 for (i
= pstate
->top
- 1; 1; --i
)
287 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), ref
))
289 scm_putc ('#', port
);
290 scm_intprint (i
- self
, 10, port
);
291 scm_putc ('#', port
);
294 /* Print the name of a symbol. */
297 quote_keywordish_symbol (SCM symbol
)
301 if (scm_i_symbol_ref (symbol
, 0) != ':'
302 && scm_i_symbol_ref (symbol
, scm_i_symbol_length (symbol
) - 1) != ':')
305 option
= SCM_PRINT_KEYWORD_STYLE
;
306 if (scm_is_false (option
))
308 if (scm_is_eq (option
, sym_reader
))
309 return scm_is_true (SCM_PACK (SCM_KEYWORD_STYLE
));
314 scm_i_print_symbol_name (SCM str
, SCM port
)
316 /* This points to the first character that has not yet been written to the
319 /* This points to the character we're currently looking at. */
321 /* If the name contains weird characters, we'll escape them with
322 * backslashes and set this flag; it indicates that we should surround the
323 * name with "#{" and "}#". */
325 /* Backslashes are not sufficient to make a name weird, but if a name is
326 * weird because of other characters, backslahes need to be escaped too.
327 * The first time we see a backslash, we set maybe_weird, and mw_pos points
328 * to the backslash. Then if the name turns out to be weird, we re-process
329 * everything starting from mw_pos.
330 * We could instead make backslashes always weird. This is not necessary
331 * to ensure that the output is (read)-able, but it would make this code
332 * simpler and faster. */
335 size_t len
= scm_i_symbol_length (str
);
336 scm_t_wchar str0
= scm_i_symbol_ref (str
, 0);
338 if (len
== 0 || str0
== '\'' || str0
== '`' || str0
== ','
339 || quote_keywordish_symbol (str
)
340 || (str0
== '.' && len
== 1)
341 || scm_is_true (scm_i_string_to_number (scm_symbol_to_string (str
), 10)))
343 scm_lfwrite ("#{", 2, port
);
347 for (end
= pos
; end
< len
; ++end
)
348 switch (scm_i_symbol_ref (str
, end
))
350 #ifdef BRACKETS_AS_PARENS
359 case SCM_WHITE_SPACES
:
360 case SCM_LINE_INCREMENTORS
:
369 scm_lfwrite ("#{", 2, port
);
373 scm_lfwrite_substr (scm_symbol_to_string (str
), pos
, end
, port
);
377 buf
[1] = (char) (unsigned char) scm_i_symbol_ref (str
, end
);
378 scm_lfwrite (buf
, 2, port
);
395 scm_lfwrite_substr (scm_symbol_to_string (str
), pos
, end
, port
);
397 scm_lfwrite ("}#", 2, port
);
401 scm_print_symbol_name (const char *str
, size_t len
, SCM port
)
403 SCM symbol
= scm_from_locale_symboln (str
, len
);
404 scm_i_print_symbol_name (symbol
, port
);
407 /* Print generally. Handles both write and display according to PSTATE.
409 SCM_GPROC(s_write
, "write", 1, 1, 0, scm_write
, g_write
);
410 SCM_GPROC(s_display
, "display", 1, 1, 0, scm_display
, g_display
);
412 static void iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
);
415 /* Print a character as an octal or hex escape. */
416 #define PRINT_CHAR_ESCAPE(i, port) \
419 if (!SCM_R6RS_ESCAPES_P) \
420 scm_intprint (i, 8, port); \
423 scm_puts ("x", port); \
424 scm_intprint (i, 16, port); \
431 scm_iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
)
434 && scm_is_true (scm_memq (exp
, pstate
->highlight_objects
)))
436 scm_display (SCM_PRINT_HIGHLIGHT_PREFIX
, port
);
437 iprin1 (exp
, port
, pstate
);
438 scm_display (SCM_PRINT_HIGHLIGHT_SUFFIX
, port
);
441 iprin1 (exp
, port
, pstate
);
445 iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
)
447 switch (SCM_ITAG3 (exp
))
451 /* These tc3 tags should never occur in an immediate value. They are
452 * only used in cell types of non-immediates, i. e. the value returned
453 * by SCM_CELL_TYPE (exp) can use these tags.
455 scm_ipruk ("immediate", exp
, port
);
459 scm_intprint (SCM_I_INUM (exp
), 10, port
);
464 scm_t_wchar i
= SCM_CHAR (exp
);
467 if (SCM_WRITINGP (pstate
))
469 scm_puts ("#\\", port
);
470 name
= scm_i_charname (exp
);
472 scm_puts (name
, port
);
473 else if (uc_is_general_category_withtable (i
, UC_CATEGORY_MASK_L
477 | UC_CATEGORY_MASK_S
))
478 /* Print the character if is graphic character. */
486 enc
= scm_i_get_port_encoding (port
);
487 if (uc_combining_class (i
) == UC_CCC_NR
)
489 wstr
= scm_i_make_wide_string (1, &wbuf
);
494 /* Character is a combining character: print it connected
495 to a dotted circle instead of connecting it to the
497 wstr
= scm_i_make_wide_string (2, &wbuf
);
498 wbuf
[0] = SCM_CODEPOINT_DOTTED_CIRCLE
;
504 /* Character is graphic and Latin-1. Print it */
505 scm_lfwrite_str (wstr
, port
);
507 /* Character is graphic but unrepresentable in
508 this port's encoding. */
509 PRINT_CHAR_ESCAPE (i
, port
);
513 buf
= u32_conv_to_encoding (enc
,
515 (scm_t_uint32
*) wbuf
,
521 /* Character is graphic. Print it. */
522 scm_lfwrite_str (wstr
, port
);
526 /* Character is graphic but unrepresentable in
527 this port's encoding. */
528 PRINT_CHAR_ESCAPE (i
, port
);
532 /* Character is a non-graphical character. */
533 PRINT_CHAR_ESCAPE (i
, port
);
536 scm_i_charprint (i
, port
);
538 else if (SCM_IFLAGP (exp
)
539 && ((size_t) SCM_IFLAGNUM (exp
) < (sizeof iflagnames
/ sizeof (char *))))
541 scm_puts (iflagnames
[SCM_IFLAGNUM (exp
)], port
);
545 /* unknown immediate value */
546 scm_ipruk ("immediate", exp
, port
);
550 switch (SCM_TYP7 (exp
))
554 ENTER_NESTED_DATA (pstate
, exp
, circref
);
555 if (SCM_OBJ_CLASS_FLAGS (exp
) & SCM_CLASSF_GOOPS
)
557 SCM pwps
, print
= pstate
->writingp
? g_write
: g_display
;
560 pwps
= scm_i_port_with_print_state (port
, pstate
->handle
);
561 pstate
->revealed
= 1;
562 scm_call_generic_2 (print
, exp
, pwps
);
567 scm_print_struct (exp
, port
, pstate
);
569 EXIT_NESTED_DATA (pstate
);
572 case scm_tcs_cons_imcar
:
573 case scm_tcs_cons_nimcar
:
574 ENTER_NESTED_DATA (pstate
, exp
, circref
);
575 scm_iprlist ("(", exp
, ')', port
, pstate
);
576 EXIT_NESTED_DATA (pstate
);
579 print_circref (port
, pstate
, exp
);
582 switch SCM_TYP16 (exp
) {
584 scm_bigprint (exp
, port
, pstate
);
587 scm_print_real (exp
, port
, pstate
);
589 case scm_tc16_complex
:
590 scm_print_complex (exp
, port
, pstate
);
592 case scm_tc16_fraction
:
593 scm_i_print_fraction (exp
, port
, pstate
);
598 if (SCM_WRITINGP (pstate
))
601 static char const hex
[] = "0123456789abcdef";
605 scm_putc ('"', port
);
606 len
= scm_i_string_length (exp
);
607 for (i
= 0; i
< len
; ++i
)
609 scm_t_wchar ch
= scm_i_string_ref (exp
, i
);
612 if (ch
== ' ' || ch
== '\n')
617 else if (ch
== '"' || ch
== '\\')
619 scm_putc ('\\', port
);
620 scm_i_charprint (ch
, port
);
624 if (uc_is_general_category_withtable
626 UC_CATEGORY_MASK_L
| UC_CATEGORY_MASK_M
|
627 UC_CATEGORY_MASK_N
| UC_CATEGORY_MASK_P
|
630 /* Print the character since it is a graphic
633 SCM wstr
= scm_i_make_wide_string (1, &wbuf
);
637 if (scm_i_get_port_encoding (port
))
639 wstr
= scm_i_make_wide_string (1, &wbuf
);
641 buf
= u32_conv_to_encoding (scm_i_get_port_encoding (port
),
643 (scm_t_uint32
*) wbuf
,
649 /* Character is graphic and representable in
650 this encoding. Print it. */
651 scm_lfwrite_str (wstr
, port
);
666 /* Character is graphic but unrepresentable in
667 this port's encoding or is not graphic. */
668 if (!SCM_R6RS_ESCAPES_P
)
674 buf
[2] = hex
[ch
/ 16];
675 buf
[3] = hex
[ch
% 16];
676 scm_lfwrite (buf
, 4, port
);
678 else if (ch
<= 0xFFFF)
682 buf
[2] = hex
[(ch
& 0xF000) >> 12];
683 buf
[3] = hex
[(ch
& 0xF00) >> 8];
684 buf
[4] = hex
[(ch
& 0xF0) >> 4];
685 buf
[5] = hex
[(ch
& 0xF)];
686 scm_lfwrite (buf
, 6, port
);
688 else if (ch
> 0xFFFF)
692 buf
[2] = hex
[(ch
& 0xF00000) >> 20];
693 buf
[3] = hex
[(ch
& 0xF0000) >> 16];
694 buf
[4] = hex
[(ch
& 0xF000) >> 12];
695 buf
[5] = hex
[(ch
& 0xF00) >> 8];
696 buf
[6] = hex
[(ch
& 0xF0) >> 4];
697 buf
[7] = hex
[(ch
& 0xF)];
698 scm_lfwrite (buf
, 8, port
);
703 scm_t_wchar ch2
= ch
;
705 /* Print an R6RS variable-length hex escape: "\xNNNN;"
715 buf
[i
] = hex
[ch2
& 0xF];
722 scm_lfwrite (buf
+ i
, 9 - i
, port
);
726 scm_putc ('"', port
);
727 scm_remember_upto_here_1 (exp
);
730 scm_lfwrite_str (exp
, port
);
731 scm_remember_upto_here_1 (exp
);
734 if (scm_i_symbol_is_interned (exp
))
736 scm_i_print_symbol_name (exp
, port
);
737 scm_remember_upto_here_1 (exp
);
741 scm_puts ("#<uninterned-symbol ", port
);
742 scm_i_print_symbol_name (exp
, port
);
743 scm_putc (' ', port
);
744 scm_uintprint (SCM_UNPACK (exp
), 16, port
);
745 scm_putc ('>', port
);
748 case scm_tc7_variable
:
749 scm_i_variable_print (exp
, port
, pstate
);
751 case scm_tc7_program
:
752 scm_i_program_print (exp
, port
, pstate
);
754 case scm_tc7_foreign
:
755 scm_i_foreign_print (exp
, port
, pstate
);
757 case scm_tc7_hashtable
:
758 scm_i_hashtable_print (exp
, port
, pstate
);
761 scm_i_fluid_print (exp
, port
, pstate
);
763 case scm_tc7_dynamic_state
:
764 scm_i_dynamic_state_print (exp
, port
, pstate
);
767 scm_i_frame_print (exp
, port
, pstate
);
769 case scm_tc7_objcode
:
770 scm_i_objcode_print (exp
, port
, pstate
);
773 scm_i_vm_print (exp
, port
, pstate
);
775 case scm_tc7_vm_cont
:
776 scm_i_vm_cont_print (exp
, port
, pstate
);
779 scm_i_prompt_print (exp
, port
, pstate
);
781 case scm_tc7_with_fluids
:
782 scm_i_with_fluids_print (exp
, port
, pstate
);
785 ENTER_NESTED_DATA (pstate
, exp
, circref
);
786 if (SCM_IS_WHVEC (exp
))
787 scm_puts ("#wh(", port
);
789 scm_puts ("#w(", port
);
790 goto common_vector_printer
;
792 case scm_tc7_bytevector
:
793 scm_i_print_bytevector (exp
, port
, pstate
);
796 ENTER_NESTED_DATA (pstate
, exp
, circref
);
797 scm_puts ("#(", port
);
798 common_vector_printer
:
801 long last
= SCM_SIMPLE_VECTOR_LENGTH (exp
) - 1;
804 && SCM_SIMPLE_VECTOR_LENGTH (exp
) > pstate
->length
)
806 last
= pstate
->length
- 1;
809 if (SCM_I_WVECTP (exp
))
811 /* Elements of weak vectors may not be accessed via the
812 `SIMPLE_VECTOR_REF ()' macro. */
813 for (i
= 0; i
< last
; ++i
)
815 scm_iprin1 (scm_c_vector_ref (exp
, i
),
817 scm_putc (' ', port
);
822 for (i
= 0; i
< last
; ++i
)
824 scm_iprin1 (SCM_SIMPLE_VECTOR_REF (exp
, i
), port
, pstate
);
825 scm_putc (' ', port
);
832 scm_iprin1 (scm_c_vector_ref (exp
, i
), port
, pstate
);
835 scm_puts (" ...", port
);
836 scm_putc (')', port
);
838 EXIT_NESTED_DATA (pstate
);
842 register long i
= SCM_PTOBNUM (exp
);
844 && scm_ptobs
[i
].print
845 && (scm_ptobs
[i
].print
) (exp
, port
, pstate
))
850 ENTER_NESTED_DATA (pstate
, exp
, circref
);
851 SCM_SMOB_DESCRIPTOR (exp
).print (exp
, port
, pstate
);
852 EXIT_NESTED_DATA (pstate
);
855 /* case scm_tcs_closures: */
857 scm_ipruk ("type", exp
, port
);
862 /* Print states are necessary for circular reference safe printing.
863 * They are also expensive to allocate. Therefore print states are
864 * kept in a pool so that they can be reused.
867 /* The PORT argument can also be a print-state/port pair, which will
868 * then be used instead of allocating a new print state. This is
869 * useful for continuing a chain of print calls from Scheme. */
872 scm_prin1 (SCM exp
, SCM port
, int writingp
)
874 SCM handle
= SCM_BOOL_F
; /* Will GC protect the handle whilst unlinked */
876 scm_print_state
*pstate
;
879 /* If PORT is a print-state/port pair, use that. Else create a new
882 if (SCM_PORT_WITH_PS_P (port
))
884 pstate_scm
= SCM_PORT_WITH_PS_PS (port
);
885 port
= SCM_PORT_WITH_PS_PORT (port
);
889 /* First try to allocate a print state from the pool */
890 scm_i_pthread_mutex_lock (&print_state_mutex
);
891 if (!scm_is_null (print_state_pool
))
893 handle
= print_state_pool
;
894 print_state_pool
= SCM_CDR (print_state_pool
);
896 scm_i_pthread_mutex_unlock (&print_state_mutex
);
897 if (scm_is_false (handle
))
898 handle
= scm_list_1 (make_print_state ());
899 pstate_scm
= SCM_CAR (handle
);
902 pstate
= SCM_PRINT_STATE (pstate_scm
);
903 old_writingp
= pstate
->writingp
;
904 pstate
->writingp
= writingp
;
905 scm_iprin1 (exp
, port
, pstate
);
906 pstate
->writingp
= old_writingp
;
908 /* Return print state to pool if it has been created above and
909 hasn't escaped to Scheme. */
911 if (scm_is_true (handle
) && !pstate
->revealed
)
913 scm_i_pthread_mutex_lock (&print_state_mutex
);
914 SCM_SETCDR (handle
, print_state_pool
);
915 print_state_pool
= handle
;
916 scm_i_pthread_mutex_unlock (&print_state_mutex
);
920 /* Print a character.
923 scm_i_charprint (scm_t_wchar ch
, SCM port
)
926 SCM wstr
= scm_i_make_wide_string (1, &wbuf
);
929 scm_lfwrite_str (wstr
, port
);
936 scm_intprint (scm_t_intmax n
, int radix
, SCM port
)
938 char num_buf
[SCM_INTBUFLEN
];
939 scm_lfwrite (num_buf
, scm_iint2str (n
, radix
, num_buf
), port
);
943 scm_uintprint (scm_t_uintmax n
, int radix
, SCM port
)
945 char num_buf
[SCM_INTBUFLEN
];
946 scm_lfwrite (num_buf
, scm_iuint2str (n
, radix
, num_buf
), port
);
949 /* Print an object of unrecognized type.
953 scm_ipruk (char *hdr
, SCM ptr
, SCM port
)
955 scm_puts ("#<unknown-", port
);
956 scm_puts (hdr
, port
);
957 if (1) /* (scm_in_heap_p (ptr)) */ /* FIXME */
959 scm_puts (" (0x", port
);
960 scm_uintprint (SCM_CELL_WORD_0 (ptr
), 16, port
);
961 scm_puts (" . 0x", port
);
962 scm_uintprint (SCM_CELL_WORD_1 (ptr
), 16, port
);
963 scm_puts (") @", port
);
965 scm_puts (" 0x", port
);
966 scm_uintprint (SCM_UNPACK (ptr
), 16, port
);
967 scm_putc ('>', port
);
974 scm_iprlist (char *hdr
, SCM exp
, int tlr
, SCM port
, scm_print_state
*pstate
)
976 register SCM hare
, tortoise
;
977 long floor
= pstate
->top
- 2;
978 scm_puts (hdr
, port
);
983 /* Run a hare and tortoise so that total time complexity will be
984 O(depth * N) instead of O(N^2). */
985 hare
= SCM_CDR (exp
);
987 while (scm_is_pair (hare
))
989 if (scm_is_eq (hare
, tortoise
))
991 hare
= SCM_CDR (hare
);
992 if (!scm_is_pair (hare
))
994 hare
= SCM_CDR (hare
);
995 tortoise
= SCM_CDR (tortoise
);
998 /* No cdr cycles intrinsic to this list */
999 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1000 for (exp
= SCM_CDR (exp
); scm_is_pair (exp
); exp
= SCM_CDR (exp
))
1004 for (i
= floor
; i
>= 0; --i
)
1005 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), exp
))
1007 PUSH_REF (pstate
, exp
);
1008 scm_putc (' ', port
);
1010 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1012 if (!SCM_NULL_OR_NIL_P (exp
))
1014 scm_puts (" . ", port
);
1015 scm_iprin1 (exp
, port
, pstate
);
1019 scm_putc (tlr
, port
);
1020 pstate
->top
= floor
+ 2;
1025 long n
= pstate
->length
;
1027 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1028 exp
= SCM_CDR (exp
); --n
;
1029 for (; scm_is_pair (exp
); exp
= SCM_CDR (exp
))
1031 register unsigned long i
;
1033 for (i
= 0; i
< pstate
->top
; ++i
)
1034 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), exp
))
1040 scm_puts (" ...", port
);
1046 PUSH_REF(pstate
, exp
);
1047 ++pstate
->list_offset
;
1048 scm_putc (' ', port
);
1050 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1053 if (!SCM_NULL_OR_NIL_P (exp
))
1055 scm_puts (" . ", port
);
1056 scm_iprin1 (exp
, port
, pstate
);
1059 pstate
->list_offset
-= pstate
->top
- floor
- 2;
1063 pstate
->list_offset
-= pstate
->top
- floor
- 2;
1066 scm_puts (" . ", port
);
1067 print_circref (port
, pstate
, exp
);
1074 scm_valid_oport_value_p (SCM val
)
1076 return (SCM_OPOUTPORTP (val
)
1077 || (SCM_PORT_WITH_PS_P (val
)
1078 && SCM_OPOUTPORTP (SCM_PORT_WITH_PS_PORT (val
))));
1081 /* SCM_GPROC(s_write, "write", 1, 1, 0, scm_write, g_write); */
1084 scm_write (SCM obj
, SCM port
)
1086 if (SCM_UNBNDP (port
))
1087 port
= scm_current_output_port ();
1089 SCM_ASSERT (scm_valid_oport_value_p (port
), port
, SCM_ARG2
, s_write
);
1091 scm_prin1 (obj
, port
, 1);
1096 scm_close_port (port
);
1100 return SCM_UNSPECIFIED
;
1104 /* SCM_GPROC(s_display, "display", 1, 1, 0, scm_display, g_display); */
1107 scm_display (SCM obj
, SCM port
)
1109 if (SCM_UNBNDP (port
))
1110 port
= scm_current_output_port ();
1112 SCM_ASSERT (scm_valid_oport_value_p (port
), port
, SCM_ARG2
, s_display
);
1114 scm_prin1 (obj
, port
, 0);
1119 scm_close_port (port
);
1123 return SCM_UNSPECIFIED
;
1127 SCM_DEFINE (scm_simple_format
, "simple-format", 2, 0, 1,
1128 (SCM destination
, SCM message
, SCM args
),
1129 "Write @var{message} to @var{destination}, defaulting to\n"
1130 "the current output port.\n"
1131 "@var{message} can contain @code{~A} (was @code{%s}) and\n"
1132 "@code{~S} (was @code{%S}) escapes. When printed,\n"
1133 "the escapes are replaced with corresponding members of\n"
1135 "@code{~A} formats using @code{display} and @code{~S} formats\n"
1136 "using @code{write}.\n"
1137 "If @var{destination} is @code{#t}, then use the current output\n"
1138 "port, if @var{destination} is @code{#f}, then return a string\n"
1139 "containing the formatted text. Does not add a trailing newline.")
1140 #define FUNC_NAME s_scm_simple_format
1142 SCM port
, answer
= SCM_UNSPECIFIED
;
1143 int fReturnString
= 0;
1145 size_t start
, p
, end
;
1147 if (scm_is_eq (destination
, SCM_BOOL_T
))
1149 destination
= port
= scm_current_output_port ();
1151 else if (scm_is_false (destination
))
1154 port
= scm_mkstrport (SCM_INUM0
,
1155 scm_make_string (SCM_INUM0
, SCM_UNDEFINED
),
1156 SCM_OPN
| SCM_WRTNG
,
1162 SCM_VALIDATE_OPORT_VALUE (1, destination
);
1163 port
= SCM_COERCE_OUTPORT (destination
);
1165 SCM_VALIDATE_STRING (2, message
);
1166 SCM_VALIDATE_REST_ARGUMENT (args
);
1170 end
= scm_i_string_length (message
);
1171 for (p
= start
; p
!= end
; ++p
)
1172 if (scm_i_string_ref (message
, p
) == '~')
1177 switch (scm_i_string_ref (message
, p
))
1186 scm_lfwrite_substr (message
, start
, p
, port
);
1190 scm_lfwrite_substr (message
, start
, p
- 1, port
);
1195 SCM_MISC_ERROR ("FORMAT: Unsupported format option ~~~A - use (ice-9 format) instead",
1196 scm_list_1 (SCM_MAKE_CHAR (scm_i_string_ref (message
, p
))));
1201 if (!scm_is_pair (args
))
1202 SCM_MISC_ERROR ("FORMAT: Missing argument for ~~~A",
1203 scm_list_1 (SCM_MAKE_CHAR (scm_i_string_ref (message
, p
))));
1205 scm_lfwrite_substr (message
, start
, p
- 1, port
);
1206 /* we pass destination here */
1207 scm_prin1 (SCM_CAR (args
), destination
, writingp
);
1208 args
= SCM_CDR (args
);
1212 scm_lfwrite_substr (message
, start
, p
, port
);
1213 if (!scm_is_eq (args
, SCM_EOL
))
1214 SCM_MISC_ERROR ("FORMAT: ~A superfluous arguments",
1215 scm_list_1 (scm_length (args
)));
1218 answer
= scm_strport_to_string (destination
);
1220 return scm_return_first (answer
, message
);
1225 SCM_DEFINE (scm_newline
, "newline", 0, 1, 0,
1227 "Send a newline to @var{port}.\n"
1228 "If @var{port} is omitted, send to the current output port.")
1229 #define FUNC_NAME s_scm_newline
1231 if (SCM_UNBNDP (port
))
1232 port
= scm_current_output_port ();
1234 SCM_VALIDATE_OPORT_VALUE (1, port
);
1236 scm_putc ('\n', SCM_COERCE_OUTPORT (port
));
1237 return SCM_UNSPECIFIED
;
1241 SCM_DEFINE (scm_write_char
, "write-char", 1, 1, 0,
1242 (SCM chr
, SCM port
),
1243 "Send character @var{chr} to @var{port}.")
1244 #define FUNC_NAME s_scm_write_char
1246 if (SCM_UNBNDP (port
))
1247 port
= scm_current_output_port ();
1249 SCM_VALIDATE_CHAR (1, chr
);
1250 SCM_VALIDATE_OPORT_VALUE (2, port
);
1252 scm_i_charprint (SCM_CHAR (chr
), SCM_COERCE_OUTPORT (port
));
1257 scm_close_port (port
);
1261 return SCM_UNSPECIFIED
;
1267 /* Call back to Scheme code to do the printing of special objects
1268 * (like structs). SCM_PRINTER_APPLY applies PROC to EXP and a smob
1269 * containing PORT and PSTATE. This object can be used as the port for
1270 * display/write etc to continue the current print chain. The REVEALED
1271 * field of PSTATE is set to true to indicate that the print state has
1272 * escaped to Scheme and thus has to be freed by the GC.
1275 scm_t_bits scm_tc16_port_with_ps
;
1277 /* Print exactly as the port itself would */
1280 port_with_ps_print (SCM obj
, SCM port
, scm_print_state
*pstate
)
1282 obj
= SCM_PORT_WITH_PS_PORT (obj
);
1283 return scm_ptobs
[SCM_PTOBNUM (obj
)].print (obj
, port
, pstate
);
1287 scm_printer_apply (SCM proc
, SCM exp
, SCM port
, scm_print_state
*pstate
)
1289 pstate
->revealed
= 1;
1290 return scm_call_2 (proc
, exp
,
1291 scm_i_port_with_print_state (port
, pstate
->handle
));
1294 SCM_DEFINE (scm_port_with_print_state
, "port-with-print-state", 1, 1, 0,
1295 (SCM port
, SCM pstate
),
1296 "Create a new port which behaves like @var{port}, but with an\n"
1297 "included print state @var{pstate}. @var{pstate} is optional.\n"
1298 "If @var{pstate} isn't supplied and @var{port} already has\n"
1299 "a print state, the old print state is reused.")
1300 #define FUNC_NAME s_scm_port_with_print_state
1302 SCM_VALIDATE_OPORT_VALUE (1, port
);
1303 if (!SCM_UNBNDP (pstate
))
1304 SCM_VALIDATE_PRINTSTATE (2, pstate
);
1305 return scm_i_port_with_print_state (port
, pstate
);
1309 SCM_DEFINE (scm_get_print_state
, "get-print-state", 1, 0, 0,
1311 "Return the print state of the port @var{port}. If @var{port}\n"
1312 "has no associated print state, @code{#f} is returned.")
1313 #define FUNC_NAME s_scm_get_print_state
1315 if (SCM_PORT_WITH_PS_P (port
))
1316 return SCM_PORT_WITH_PS_PS (port
);
1317 if (SCM_OUTPUT_PORT_P (port
))
1319 SCM_WRONG_TYPE_ARG (1, port
);
1328 SCM vtable
, layout
, type
;
1330 scm_init_opts (scm_print_options
, scm_print_opts
);
1332 scm_print_options (scm_list_4 (scm_from_locale_symbol ("highlight-prefix"),
1333 scm_from_locale_string ("{"),
1334 scm_from_locale_symbol ("highlight-suffix"),
1335 scm_from_locale_string ("}")));
1337 scm_gc_register_root (&print_state_pool
);
1338 scm_gc_register_root (&scm_print_state_vtable
);
1339 vtable
= scm_make_vtable_vtable (scm_nullstr
, SCM_INUM0
, SCM_EOL
);
1341 scm_make_struct_layout (scm_from_locale_string (SCM_PRINT_STATE_LAYOUT
));
1342 type
= scm_make_struct (vtable
, SCM_INUM0
, scm_list_1 (layout
));
1343 scm_set_struct_vtable_name_x (type
, scm_from_locale_symbol ("print-state"));
1344 scm_print_state_vtable
= type
;
1346 /* Don't want to bind a wrapper class in GOOPS, so pass 0 as arg1. */
1347 scm_tc16_port_with_ps
= scm_make_smob_type (0, 0);
1348 scm_set_smob_print (scm_tc16_port_with_ps
, port_with_ps_print
);
1350 #include "libguile/print.x"
1352 scm_print_opts
[SCM_PRINT_KEYWORD_STYLE_I
].val
= SCM_UNPACK (sym_reader
);