1 /* Copyright (C) 1995-1999, 2000, 2001, 2002, 2003, 2004, 2006, 2008,
2 * 2009, 2010, 2011 Free Software Foundation, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public License
6 * as published by the Free Software Foundation; either version 3 of
7 * the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
34 #include "libguile/_scm.h"
35 #include "libguile/chars.h"
36 #include "libguile/continuations.h"
37 #include "libguile/smob.h"
38 #include "libguile/control.h"
39 #include "libguile/eval.h"
40 #include "libguile/macros.h"
41 #include "libguile/procprop.h"
42 #include "libguile/read.h"
43 #include "libguile/programs.h"
44 #include "libguile/alist.h"
45 #include "libguile/struct.h"
46 #include "libguile/ports.h"
47 #include "libguile/root.h"
48 #include "libguile/strings.h"
49 #include "libguile/strports.h"
50 #include "libguile/vectors.h"
51 #include "libguile/numbers.h"
52 #include "libguile/vm.h"
54 #include "libguile/validate.h"
55 #include "libguile/print.h"
57 #include "libguile/private-options.h"
61 /* Character printers. */
63 static size_t display_string (const void *, int, size_t, SCM
,
64 scm_t_string_failed_conversion_handler
);
66 static int display_character (scm_t_wchar
, SCM
,
67 scm_t_string_failed_conversion_handler
);
69 static void write_character (scm_t_wchar
, SCM
, int);
71 static void write_character_escaped (scm_t_wchar
, int, SCM
);
75 /* {Names of immediate symbols}
77 * This table must agree with the declarations in scm.h: {Immediate Symbols}.
80 /* This table must agree with the list of flags in tags.h. */
81 static const char *iflagnames
[] =
84 "#nil", /* Elisp nil value. Should print from elisp as symbol `nil'. */
85 "#<XXX UNUSED LISP FALSE -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
88 "#<XXX UNUSED BOOLEAN 0 -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
89 "#<XXX UNUSED BOOLEAN 1 -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
90 "#<XXX UNUSED BOOLEAN 2 -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
95 /* Unbound slot marker for GOOPS. For internal use in GOOPS only. */
99 SCM_SYMBOL (sym_reader
, "reader");
101 scm_t_option scm_print_opts
[] = {
102 { SCM_OPTION_SCM
, "highlight-prefix", (scm_t_bits
)SCM_BOOL_F_BITS
,
103 "The string to print before highlighted values." },
104 { SCM_OPTION_SCM
, "highlight-suffix", (scm_t_bits
)SCM_BOOL_F_BITS
,
105 "The string to print after highlighted values." },
106 { SCM_OPTION_SCM
, "quote-keywordish-symbols", (scm_t_bits
)SCM_BOOL_F_BITS
,
107 "How to print symbols that have a colon as their first or last character. "
108 "The value '#f' does not quote the colons; '#t' quotes them; "
109 "'reader' quotes them when the reader option 'keywords' is not '#f'."
114 SCM_DEFINE (scm_print_options
, "print-options-interface", 0, 1, 0,
116 "Option interface for the print options. Instead of using\n"
117 "this procedure directly, use the procedures\n"
118 "@code{print-enable}, @code{print-disable}, @code{print-set!}\n"
119 "and @code{print-options}.")
120 #define FUNC_NAME s_scm_print_options
122 SCM ans
= scm_options (setting
,
130 /* {Printing of Scheme Objects}
133 /* Detection of circular references.
135 * Due to other constraints in the implementation, this code has bad
136 * time complexity (O (depth * N)), The printer code can be
137 * rewritten to be O(N).
139 #define PUSH_REF(pstate, obj) \
142 PSTATE_STACK_SET (pstate, pstate->top, obj); \
144 if (pstate->top == pstate->ceiling) \
145 grow_ref_stack (pstate); \
148 #define ENTER_NESTED_DATA(pstate, obj, label) \
151 register unsigned long i; \
152 for (i = 0; i < pstate->top; ++i) \
153 if (scm_is_eq (PSTATE_STACK_REF (pstate, i), (obj))) \
155 if (pstate->fancyp) \
157 if (pstate->top - pstate->list_offset >= pstate->level) \
159 scm_putc_unlocked ('#', port); \
163 PUSH_REF(pstate, obj); \
166 #define EXIT_NESTED_DATA(pstate) \
170 PSTATE_STACK_SET (pstate, pstate->top, SCM_UNDEFINED); \
174 SCM scm_print_state_vtable
= SCM_BOOL_F
;
175 static SCM print_state_pool
= SCM_EOL
;
176 scm_i_pthread_mutex_t print_state_mutex
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
178 #ifdef GUILE_DEBUG /* Used for debugging purposes */
180 SCM_DEFINE (scm_current_pstate
, "current-pstate", 0, 0, 0,
182 "Return the current-pstate -- the car of the\n"
183 "@code{print_state_pool}. @code{current-pstate} is only\n"
184 "included in @code{--enable-guile-debug} builds.")
185 #define FUNC_NAME s_scm_current_pstate
187 if (!scm_is_null (print_state_pool
))
188 return SCM_CAR (print_state_pool
);
196 #define PSTATE_SIZE 50L
199 make_print_state (void)
202 = scm_make_struct (scm_print_state_vtable
, SCM_INUM0
, SCM_EOL
);
203 scm_print_state
*pstate
= SCM_PRINT_STATE (print_state
);
204 pstate
->ref_vect
= scm_c_make_vector (PSTATE_SIZE
, SCM_UNDEFINED
);
205 pstate
->ceiling
= SCM_SIMPLE_VECTOR_LENGTH (pstate
->ref_vect
);
206 pstate
->highlight_objects
= SCM_EOL
;
211 scm_make_print_state ()
213 SCM answer
= SCM_BOOL_F
;
215 /* First try to allocate a print state from the pool */
216 scm_i_pthread_mutex_lock (&print_state_mutex
);
217 if (!scm_is_null (print_state_pool
))
219 answer
= SCM_CAR (print_state_pool
);
220 print_state_pool
= SCM_CDR (print_state_pool
);
222 scm_i_pthread_mutex_unlock (&print_state_mutex
);
224 return scm_is_false (answer
) ? make_print_state () : answer
;
228 scm_free_print_state (SCM print_state
)
231 scm_print_state
*pstate
= SCM_PRINT_STATE (print_state
);
232 /* Cleanup before returning print state to pool.
233 * It is better to do it here. Doing it in scm_prin1
234 * would cost more since that function is called much more
238 pstate
->revealed
= 0;
239 pstate
->highlight_objects
= SCM_EOL
;
240 scm_i_pthread_mutex_lock (&print_state_mutex
);
241 handle
= scm_cons (print_state
, print_state_pool
);
242 print_state_pool
= handle
;
243 scm_i_pthread_mutex_unlock (&print_state_mutex
);
247 scm_i_port_with_print_state (SCM port
, SCM print_state
)
249 if (SCM_UNBNDP (print_state
))
251 if (SCM_PORT_WITH_PS_P (port
))
254 print_state
= scm_make_print_state ();
255 /* port does not need to be coerced since it doesn't have ps */
258 port
= SCM_COERCE_OUTPORT (port
);
259 SCM_RETURN_NEWSMOB (scm_tc16_port_with_ps
,
260 SCM_UNPACK (scm_cons (port
, print_state
)));
264 grow_ref_stack (scm_print_state
*pstate
)
266 SCM old_vect
= pstate
->ref_vect
;
267 size_t old_size
= SCM_SIMPLE_VECTOR_LENGTH (old_vect
);
268 size_t new_size
= 2 * pstate
->ceiling
;
269 SCM new_vect
= scm_c_make_vector (new_size
, SCM_UNDEFINED
);
272 for (i
= 0; i
!= old_size
; ++i
)
273 SCM_SIMPLE_VECTOR_SET (new_vect
, i
, SCM_SIMPLE_VECTOR_REF (old_vect
, i
));
275 pstate
->ref_vect
= new_vect
;
276 pstate
->ceiling
= new_size
;
279 #define PSTATE_STACK_REF(p,i) SCM_SIMPLE_VECTOR_REF((p)->ref_vect, (i))
280 #define PSTATE_STACK_SET(p,i,v) SCM_SIMPLE_VECTOR_SET((p)->ref_vect, (i), (v))
283 print_circref (SCM port
, scm_print_state
*pstate
, SCM ref
)
286 long self
= pstate
->top
- 1;
288 if (scm_is_pair (PSTATE_STACK_REF (pstate
, i
)))
292 if (!scm_is_pair (PSTATE_STACK_REF (pstate
, i
-1))
293 || !scm_is_eq (SCM_CDR (PSTATE_STACK_REF (pstate
, i
-1)),
294 SCM_CDR (PSTATE_STACK_REF (pstate
, i
))))
300 for (i
= pstate
->top
- 1; 1; --i
)
301 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), ref
))
303 scm_putc_unlocked ('#', port
);
304 scm_intprint (i
- self
, 10, port
);
305 scm_putc_unlocked ('#', port
);
308 /* Print the name of a symbol. */
311 quote_keywordish_symbols (void)
313 SCM option
= SCM_PRINT_KEYWORD_STYLE
;
315 if (scm_is_false (option
))
317 if (scm_is_eq (option
, sym_reader
))
318 return scm_is_true (SCM_PACK (SCM_KEYWORD_STYLE
));
322 #define INITIAL_IDENTIFIER_MASK \
323 (UC_CATEGORY_MASK_Lu | UC_CATEGORY_MASK_Ll | UC_CATEGORY_MASK_Lt \
324 | UC_CATEGORY_MASK_Lm | UC_CATEGORY_MASK_Lo | UC_CATEGORY_MASK_Mn \
325 | UC_CATEGORY_MASK_Nl | UC_CATEGORY_MASK_No | UC_CATEGORY_MASK_Pd \
326 | UC_CATEGORY_MASK_Pc | UC_CATEGORY_MASK_Po | UC_CATEGORY_MASK_Sc \
327 | UC_CATEGORY_MASK_Sm | UC_CATEGORY_MASK_Sk | UC_CATEGORY_MASK_So \
328 | UC_CATEGORY_MASK_Co)
330 #define SUBSEQUENT_IDENTIFIER_MASK \
331 (INITIAL_IDENTIFIER_MASK \
332 | UC_CATEGORY_MASK_Nd | UC_CATEGORY_MASK_Mc | UC_CATEGORY_MASK_Me)
335 symbol_has_extended_read_syntax (SCM sym
)
337 size_t pos
, len
= scm_i_symbol_length (sym
);
340 /* The empty symbol. */
344 c
= scm_i_symbol_ref (sym
, 0);
346 /* Single dot; conflicts with dotted-pair notation. */
347 if (len
== 1 && c
== '.')
350 /* Other initial-character constraints. */
351 if (c
== '\'' || c
== '`' || c
== ',' || c
== '"' || c
== ';' || c
== '#')
354 /* Keywords can be identified by trailing colons too. */
355 if (c
== ':' || scm_i_symbol_ref (sym
, len
- 1) == ':')
356 return quote_keywordish_symbols ();
358 /* Number-ish symbols. */
359 if (scm_is_true (scm_i_string_to_number (scm_symbol_to_string (sym
), 10)))
362 /* Other disallowed first characters. */
363 if (!uc_is_general_category_withtable (c
, INITIAL_IDENTIFIER_MASK
))
366 /* Otherwise, any character that's in the identifier category mask is
367 fine to pass through as-is, provided it's not one of the ASCII
368 delimiters like `;'. */
369 for (pos
= 1; pos
< len
; pos
++)
371 c
= scm_i_symbol_ref (sym
, pos
);
372 if (!uc_is_general_category_withtable (c
, SUBSEQUENT_IDENTIFIER_MASK
))
374 else if (c
== '"' || c
== ';' || c
== '#')
382 print_normal_symbol (SCM sym
, SCM port
)
384 scm_display (scm_symbol_to_string (sym
), port
);
388 print_extended_symbol (SCM sym
, SCM port
)
391 scm_t_string_failed_conversion_handler strategy
;
393 len
= scm_i_symbol_length (sym
);
394 strategy
= scm_i_get_conversion_strategy (port
);
396 scm_lfwrite_unlocked ("#{", 2, port
);
398 for (pos
= 0; pos
< len
; pos
++)
400 scm_t_wchar c
= scm_i_symbol_ref (sym
, pos
);
402 if (uc_is_general_category_withtable (c
,
403 SUBSEQUENT_IDENTIFIER_MASK
404 | UC_CATEGORY_MASK_Zs
))
406 if (!display_character (c
, port
, strategy
))
407 scm_encoding_error ("print_extended_symbol", errno
,
408 "cannot convert to output locale",
409 port
, SCM_MAKE_CHAR (c
));
413 display_string ("\\x", 1, 2, port
, iconveh_question_mark
);
414 scm_intprint (c
, 16, port
);
415 display_character (';', port
, iconveh_question_mark
);
419 scm_lfwrite_unlocked ("}#", 2, port
);
422 /* FIXME: allow R6RS hex escapes instead of #{...}#. */
424 scm_i_print_symbol_name (SCM sym
, SCM port
)
426 if (symbol_has_extended_read_syntax (sym
))
427 print_extended_symbol (sym
, port
);
429 print_normal_symbol (sym
, port
);
433 scm_print_symbol_name (const char *str
, size_t len
, SCM port
)
435 SCM symbol
= scm_from_utf8_symboln (str
, len
);
436 scm_i_print_symbol_name (symbol
, port
);
439 /* Print generally. Handles both write and display according to PSTATE.
441 SCM_GPROC(s_write
, "write", 1, 1, 0, scm_write
, g_write
);
442 SCM_GPROC(s_display
, "display", 1, 1, 0, scm_display
, g_display
);
444 static void iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
);
447 /* Print a character as an octal or hex escape. */
448 #define PRINT_CHAR_ESCAPE(i, port) \
451 if (!SCM_R6RS_ESCAPES_P) \
452 scm_intprint (i, 8, port); \
455 scm_puts_unlocked ("x", port); \
456 scm_intprint (i, 16, port); \
463 scm_iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
)
466 && scm_is_true (scm_memq (exp
, pstate
->highlight_objects
)))
468 scm_display (SCM_PRINT_HIGHLIGHT_PREFIX
, port
);
469 iprin1 (exp
, port
, pstate
);
470 scm_display (SCM_PRINT_HIGHLIGHT_SUFFIX
, port
);
473 iprin1 (exp
, port
, pstate
);
477 iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
)
479 switch (SCM_ITAG3 (exp
))
483 /* These tc3 tags should never occur in an immediate value. They are
484 * only used in cell types of non-immediates, i. e. the value returned
485 * by SCM_CELL_TYPE (exp) can use these tags.
487 scm_ipruk ("immediate", exp
, port
);
491 scm_intprint (SCM_I_INUM (exp
), 10, port
);
496 if (SCM_WRITINGP (pstate
))
497 write_character (SCM_CHAR (exp
), port
, 0);
500 if (!display_character (SCM_CHAR (exp
), port
,
501 scm_i_get_conversion_strategy (port
)))
502 scm_encoding_error (__func__
, errno
,
503 "cannot convert to output locale",
507 else if (SCM_IFLAGP (exp
)
508 && ((size_t) SCM_IFLAGNUM (exp
) < (sizeof iflagnames
/ sizeof (char *))))
510 scm_puts_unlocked (iflagnames
[SCM_IFLAGNUM (exp
)], port
);
514 /* unknown immediate value */
515 scm_ipruk ("immediate", exp
, port
);
519 switch (SCM_TYP7 (exp
))
523 ENTER_NESTED_DATA (pstate
, exp
, circref
);
524 if (SCM_OBJ_CLASS_FLAGS (exp
) & SCM_CLASSF_GOOPS
)
526 SCM pwps
, print
= pstate
->writingp
? g_write
: g_display
;
527 if (SCM_UNPACK (print
) == 0)
529 pwps
= scm_i_port_with_print_state (port
, pstate
->handle
);
530 pstate
->revealed
= 1;
531 scm_call_2 (print
, exp
, pwps
);
536 scm_print_struct (exp
, port
, pstate
);
538 EXIT_NESTED_DATA (pstate
);
541 case scm_tcs_cons_imcar
:
542 case scm_tcs_cons_nimcar
:
543 ENTER_NESTED_DATA (pstate
, exp
, circref
);
544 scm_iprlist ("(", exp
, ')', port
, pstate
);
545 EXIT_NESTED_DATA (pstate
);
548 print_circref (port
, pstate
, exp
);
551 switch SCM_TYP16 (exp
) {
553 scm_bigprint (exp
, port
, pstate
);
556 scm_print_real (exp
, port
, pstate
);
558 case scm_tc16_complex
:
559 scm_print_complex (exp
, port
, pstate
);
561 case scm_tc16_fraction
:
562 scm_i_print_fraction (exp
, port
, pstate
);
567 if (SCM_WRITINGP (pstate
))
571 display_character ('"', port
, iconveh_question_mark
);
572 len
= scm_i_string_length (exp
);
573 for (i
= 0; i
< len
; ++i
)
574 write_character (scm_i_string_ref (exp
, i
), port
, 1);
576 display_character ('"', port
, iconveh_question_mark
);
577 scm_remember_upto_here_1 (exp
);
583 len
= scm_i_string_length (exp
);
584 printed
= display_string (scm_i_string_data (exp
),
585 scm_i_is_narrow_string (exp
),
587 scm_i_get_conversion_strategy (port
));
588 if (SCM_UNLIKELY (printed
< len
))
589 scm_encoding_error (__func__
, errno
,
590 "cannot convert to output locale",
591 port
, scm_c_string_ref (exp
, printed
));
594 scm_remember_upto_here_1 (exp
);
597 if (scm_i_symbol_is_interned (exp
))
599 scm_i_print_symbol_name (exp
, port
);
600 scm_remember_upto_here_1 (exp
);
604 scm_puts_unlocked ("#<uninterned-symbol ", port
);
605 scm_i_print_symbol_name (exp
, port
);
606 scm_putc_unlocked (' ', port
);
607 scm_uintprint (SCM_UNPACK (exp
), 16, port
);
608 scm_putc_unlocked ('>', port
);
611 case scm_tc7_variable
:
612 scm_i_variable_print (exp
, port
, pstate
);
614 case scm_tc7_program
:
615 scm_i_program_print (exp
, port
, pstate
);
617 case scm_tc7_pointer
:
618 scm_i_pointer_print (exp
, port
, pstate
);
620 case scm_tc7_hashtable
:
621 scm_i_hashtable_print (exp
, port
, pstate
);
623 case scm_tc7_weak_set
:
624 scm_i_weak_set_print (exp
, port
, pstate
);
626 case scm_tc7_weak_table
:
627 scm_i_weak_table_print (exp
, port
, pstate
);
630 scm_i_fluid_print (exp
, port
, pstate
);
632 case scm_tc7_dynamic_state
:
633 scm_i_dynamic_state_print (exp
, port
, pstate
);
636 scm_i_frame_print (exp
, port
, pstate
);
638 case scm_tc7_objcode
:
639 scm_i_objcode_print (exp
, port
, pstate
);
642 scm_i_vm_print (exp
, port
, pstate
);
644 case scm_tc7_vm_cont
:
645 scm_i_vm_cont_print (exp
, port
, pstate
);
648 scm_i_prompt_print (exp
, port
, pstate
);
650 case scm_tc7_with_fluids
:
651 scm_i_with_fluids_print (exp
, port
, pstate
);
654 ENTER_NESTED_DATA (pstate
, exp
, circref
);
655 scm_puts_unlocked ("#w(", port
);
656 goto common_vector_printer
;
658 case scm_tc7_bytevector
:
659 scm_i_print_bytevector (exp
, port
, pstate
);
662 ENTER_NESTED_DATA (pstate
, exp
, circref
);
663 scm_puts_unlocked ("#(", port
);
664 common_vector_printer
:
667 long last
= SCM_SIMPLE_VECTOR_LENGTH (exp
) - 1;
670 && SCM_SIMPLE_VECTOR_LENGTH (exp
) > pstate
->length
)
672 last
= pstate
->length
- 1;
675 for (i
= 0; i
< last
; ++i
)
677 scm_iprin1 (scm_c_vector_ref (exp
, i
), port
, pstate
);
678 scm_putc_unlocked (' ', port
);
683 scm_iprin1 (scm_c_vector_ref (exp
, i
), port
, pstate
);
686 scm_puts_unlocked (" ...", port
);
687 scm_putc_unlocked (')', port
);
689 EXIT_NESTED_DATA (pstate
);
693 scm_t_ptob_descriptor
*ptob
= SCM_PORT_DESCRIPTOR (exp
);
694 if (ptob
->print
&& ptob
->print (exp
, port
, pstate
))
699 ENTER_NESTED_DATA (pstate
, exp
, circref
);
700 SCM_SMOB_DESCRIPTOR (exp
).print (exp
, port
, pstate
);
701 EXIT_NESTED_DATA (pstate
);
704 /* case scm_tcs_closures: */
706 scm_ipruk ("type", exp
, port
);
711 /* Print states are necessary for circular reference safe printing.
712 * They are also expensive to allocate. Therefore print states are
713 * kept in a pool so that they can be reused.
716 /* The PORT argument can also be a print-state/port pair, which will
717 * then be used instead of allocating a new print state. This is
718 * useful for continuing a chain of print calls from Scheme. */
721 scm_prin1 (SCM exp
, SCM port
, int writingp
)
723 SCM handle
= SCM_BOOL_F
; /* Will GC protect the handle whilst unlinked */
725 scm_print_state
*pstate
;
728 /* If PORT is a print-state/port pair, use that. Else create a new
731 if (SCM_PORT_WITH_PS_P (port
))
733 pstate_scm
= SCM_PORT_WITH_PS_PS (port
);
734 port
= SCM_PORT_WITH_PS_PORT (port
);
738 /* First try to allocate a print state from the pool */
739 scm_i_pthread_mutex_lock (&print_state_mutex
);
740 if (!scm_is_null (print_state_pool
))
742 handle
= print_state_pool
;
743 print_state_pool
= SCM_CDR (print_state_pool
);
745 scm_i_pthread_mutex_unlock (&print_state_mutex
);
746 if (scm_is_false (handle
))
747 handle
= scm_list_1 (make_print_state ());
748 pstate_scm
= SCM_CAR (handle
);
751 pstate
= SCM_PRINT_STATE (pstate_scm
);
752 old_writingp
= pstate
->writingp
;
753 pstate
->writingp
= writingp
;
754 scm_iprin1 (exp
, port
, pstate
);
755 pstate
->writingp
= old_writingp
;
757 /* Return print state to pool if it has been created above and
758 hasn't escaped to Scheme. */
760 if (scm_is_true (handle
) && !pstate
->revealed
)
762 scm_i_pthread_mutex_lock (&print_state_mutex
);
763 SCM_SETCDR (handle
, print_state_pool
);
764 print_state_pool
= handle
;
765 scm_i_pthread_mutex_unlock (&print_state_mutex
);
769 /* Convert codepoint CH to UTF-8 and store the result in UTF8. Return
770 the number of bytes of the UTF-8-encoded string. */
772 codepoint_to_utf8 (scm_t_wchar ch
, scm_t_uint8 utf8
[4])
775 scm_t_uint32 codepoint
;
777 codepoint
= (scm_t_uint32
) ch
;
779 if (codepoint
<= 0x7f)
782 utf8
[0] = (scm_t_uint8
) codepoint
;
784 else if (codepoint
<= 0x7ffUL
)
787 utf8
[0] = 0xc0 | (codepoint
>> 6);
788 utf8
[1] = 0x80 | (codepoint
& 0x3f);
790 else if (codepoint
<= 0xffffUL
)
793 utf8
[0] = 0xe0 | (codepoint
>> 12);
794 utf8
[1] = 0x80 | ((codepoint
>> 6) & 0x3f);
795 utf8
[2] = 0x80 | (codepoint
& 0x3f);
800 utf8
[0] = 0xf0 | (codepoint
>> 18);
801 utf8
[1] = 0x80 | ((codepoint
>> 12) & 0x3f);
802 utf8
[2] = 0x80 | ((codepoint
>> 6) & 0x3f);
803 utf8
[3] = 0x80 | (codepoint
& 0x3f);
809 #define STR_REF(s, x) \
811 ? (scm_t_wchar) ((unsigned char *) (s))[x] \
812 : ((scm_t_wchar *) (s))[x])
814 /* Write STR to PORT as UTF-8. STR is a LEN-codepoint string; it is
815 narrow if NARROW_P is true, wide otherwise. Return LEN. */
817 display_string_as_utf8 (const void *str
, int narrow_p
, size_t len
,
822 while (len
> printed
)
825 char *input
, utf8_buf
[256];
827 /* Convert STR to UTF-8. */
828 for (i
= printed
, utf8_len
= 0, input
= utf8_buf
;
829 i
< len
&& utf8_len
+ 4 < sizeof (utf8_buf
);
832 utf8_len
+= codepoint_to_utf8 (STR_REF (str
, i
),
833 (scm_t_uint8
*) input
);
834 input
= utf8_buf
+ utf8_len
;
837 /* INPUT was successfully converted, entirely; print the
839 scm_lfwrite_unlocked (utf8_buf
, utf8_len
, port
);
840 printed
+= i
- printed
;
843 assert (printed
== len
);
848 /* Convert STR through PORT's output conversion descriptor and write the
849 output to PORT. Return the number of codepoints written. */
851 display_string_using_iconv (const void *str
, int narrow_p
, size_t len
,
853 scm_t_string_failed_conversion_handler strategy
)
858 pt
= SCM_PTAB_ENTRY (port
);
862 while (len
> printed
)
864 size_t done
, utf8_len
, input_left
, output_left
, i
;
865 size_t codepoints_read
, output_len
;
866 char *input
, *output
;
867 char utf8_buf
[256], encoded_output
[256];
870 /* Convert STR to UTF-8. */
871 for (i
= printed
, utf8_len
= 0, input
= utf8_buf
;
872 i
< len
&& utf8_len
+ 4 < sizeof (utf8_buf
);
875 offsets
[utf8_len
] = i
;
876 utf8_len
+= codepoint_to_utf8 (STR_REF (str
, i
),
877 (scm_t_uint8
*) input
);
878 input
= utf8_buf
+ utf8_len
;
882 input_left
= utf8_len
;
884 output
= encoded_output
;
885 output_left
= sizeof (encoded_output
);
887 done
= iconv (pt
->output_cd
, &input
, &input_left
,
888 &output
, &output_left
);
890 output_len
= sizeof (encoded_output
) - output_left
;
892 if (SCM_UNLIKELY (done
== (size_t) -1))
894 int errno_save
= errno
;
896 /* Reset the `iconv' state. */
897 iconv (pt
->output_cd
, NULL
, NULL
, NULL
, NULL
);
899 /* Print the OUTPUT_LEN bytes successfully converted. */
900 scm_lfwrite_unlocked (encoded_output
, output_len
, port
);
902 /* See how many input codepoints these OUTPUT_LEN bytes
904 codepoints_read
= offsets
[input
- utf8_buf
] - printed
;
905 printed
+= codepoints_read
;
907 if (errno_save
== EILSEQ
&&
908 strategy
!= SCM_FAILED_CONVERSION_ERROR
)
910 /* Conversion failed somewhere in INPUT and we want to
911 escape or substitute the offending input character. */
913 if (strategy
== SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
)
917 /* Find CH, the offending codepoint, and escape it. */
918 ch
= STR_REF (str
, offsets
[input
- utf8_buf
]);
919 write_character_escaped (ch
, 1, port
);
922 /* STRATEGY is `SCM_FAILED_CONVERSION_QUESTION_MARK'. */
923 display_string ("?", 1, 1, port
, strategy
);
928 /* Something bad happened that we can't handle: bail out. */
933 /* INPUT was successfully converted, entirely; print the
935 scm_lfwrite_unlocked (encoded_output
, output_len
, port
);
936 codepoints_read
= i
- printed
;
937 printed
+= codepoints_read
;
946 /* Display the LEN codepoints in STR to PORT according to STRATEGY;
947 return the number of codepoints successfully displayed. If NARROW_P,
948 then STR is interpreted as a sequence of `char', denoting a Latin-1
949 string; otherwise it's interpreted as a sequence of
952 display_string (const void *str
, int narrow_p
,
953 size_t len
, SCM port
,
954 scm_t_string_failed_conversion_handler strategy
)
959 pt
= SCM_PTAB_ENTRY (port
);
961 if (pt
->output_cd
== (iconv_t
) -1)
962 /* Initialize the conversion descriptors, if needed. */
963 scm_i_set_port_encoding_x (port
, pt
->encoding
);
965 /* FIXME: In 2.1, add a flag to determine whether a port is UTF-8. */
966 if (pt
->output_cd
== (iconv_t
) -1)
967 return display_string_as_utf8 (str
, narrow_p
, len
, port
);
969 return display_string_using_iconv (str
, narrow_p
, len
,
973 /* Attempt to display CH to PORT according to STRATEGY. Return non-zero
974 if CH was successfully displayed, zero otherwise (e.g., if it was not
975 representable in PORT's encoding.) */
977 display_character (scm_t_wchar ch
, SCM port
,
978 scm_t_string_failed_conversion_handler strategy
)
980 return display_string (&ch
, 0, 1, port
, strategy
) == 1;
983 /* Attempt to pretty-print CH, a combining character, to PORT. Return
984 zero upon failure, non-zero otherwise. The idea is to print CH above
985 a dotted circle to make it more visible. */
987 write_combining_character (scm_t_wchar ch
, SCM port
)
991 str
[0] = SCM_CODEPOINT_DOTTED_CIRCLE
;
994 return display_string (str
, 0, 2, port
, iconveh_error
) == 2;
997 /* Write CH to PORT in its escaped form, using the string escape syntax
998 if STRING_ESCAPES_P is non-zero. */
1000 write_character_escaped (scm_t_wchar ch
, int string_escapes_p
, SCM port
)
1002 if (string_escapes_p
)
1004 /* Represent CH using the in-string escape syntax. */
1006 static const char hex
[] = "0123456789abcdef";
1007 static const char escapes
[7] = "abtnvfr";
1010 if (ch
>= 0x07 && ch
<= 0x0D && ch
!= 0x0A)
1012 /* Use special escapes for some C0 controls. */
1014 buf
[1] = escapes
[ch
- 0x07];
1015 scm_lfwrite_unlocked (buf
, 2, port
);
1017 else if (!SCM_R6RS_ESCAPES_P
)
1023 buf
[2] = hex
[ch
/ 16];
1024 buf
[3] = hex
[ch
% 16];
1025 scm_lfwrite_unlocked (buf
, 4, port
);
1027 else if (ch
<= 0xFFFF)
1031 buf
[2] = hex
[(ch
& 0xF000) >> 12];
1032 buf
[3] = hex
[(ch
& 0xF00) >> 8];
1033 buf
[4] = hex
[(ch
& 0xF0) >> 4];
1034 buf
[5] = hex
[(ch
& 0xF)];
1035 scm_lfwrite_unlocked (buf
, 6, port
);
1037 else if (ch
> 0xFFFF)
1041 buf
[2] = hex
[(ch
& 0xF00000) >> 20];
1042 buf
[3] = hex
[(ch
& 0xF0000) >> 16];
1043 buf
[4] = hex
[(ch
& 0xF000) >> 12];
1044 buf
[5] = hex
[(ch
& 0xF00) >> 8];
1045 buf
[6] = hex
[(ch
& 0xF0) >> 4];
1046 buf
[7] = hex
[(ch
& 0xF)];
1047 scm_lfwrite_unlocked (buf
, 8, port
);
1052 /* Print an R6RS variable-length hex escape: "\xNNNN;". */
1053 scm_t_wchar ch2
= ch
;
1063 buf
[i
] = hex
[ch2
& 0xF];
1070 scm_lfwrite_unlocked (buf
+ i
, 9 - i
, port
);
1075 /* Represent CH using the character escape syntax. */
1078 name
= scm_i_charname (SCM_MAKE_CHAR (ch
));
1080 scm_puts_unlocked (name
, port
);
1082 PRINT_CHAR_ESCAPE (ch
, port
);
1086 /* Write CH to PORT, escaping it if it's non-graphic or not
1087 representable in PORT's encoding. If STRING_ESCAPES_P is true and CH
1088 needs to be escaped, it is escaped using the in-string escape syntax;
1089 otherwise the character escape syntax is used. */
1091 write_character (scm_t_wchar ch
, SCM port
, int string_escapes_p
)
1094 scm_t_string_failed_conversion_handler strategy
;
1096 strategy
= scm_i_get_conversion_strategy (port
);
1098 if (string_escapes_p
)
1100 /* Check if CH deserves special treatment. */
1101 if (ch
== '"' || ch
== '\\')
1103 display_character ('\\', port
, iconveh_question_mark
);
1104 display_character (ch
, port
, strategy
);
1107 else if (ch
== ' ' || ch
== '\n')
1109 display_character (ch
, port
, strategy
);
1115 display_string ("#\\", 1, 2, port
, iconveh_question_mark
);
1117 if (uc_combining_class (ch
) != UC_CCC_NR
)
1118 /* Character is a combining character, so attempt to
1120 printed
= write_combining_character (ch
, port
);
1124 && uc_is_general_category_withtable (ch
,
1125 UC_CATEGORY_MASK_L
|
1126 UC_CATEGORY_MASK_M
|
1127 UC_CATEGORY_MASK_N
|
1128 UC_CATEGORY_MASK_P
|
1129 UC_CATEGORY_MASK_S
))
1130 /* CH is graphic; attempt to display it. */
1131 printed
= display_character (ch
, port
, iconveh_error
);
1134 /* CH isn't graphic or cannot be represented in PORT's encoding. */
1135 write_character_escaped (ch
, string_escapes_p
, port
);
1138 /* Print an integer.
1142 scm_intprint (scm_t_intmax n
, int radix
, SCM port
)
1144 char num_buf
[SCM_INTBUFLEN
];
1145 scm_lfwrite_unlocked (num_buf
, scm_iint2str (n
, radix
, num_buf
), port
);
1149 scm_uintprint (scm_t_uintmax n
, int radix
, SCM port
)
1151 char num_buf
[SCM_INTBUFLEN
];
1152 scm_lfwrite_unlocked (num_buf
, scm_iuint2str (n
, radix
, num_buf
), port
);
1155 /* Print an object of unrecognized type.
1159 scm_ipruk (char *hdr
, SCM ptr
, SCM port
)
1161 scm_puts_unlocked ("#<unknown-", port
);
1162 scm_puts_unlocked (hdr
, port
);
1163 if (1) /* (scm_in_heap_p (ptr)) */ /* FIXME */
1165 scm_puts_unlocked (" (0x", port
);
1166 scm_uintprint (SCM_CELL_WORD_0 (ptr
), 16, port
);
1167 scm_puts_unlocked (" . 0x", port
);
1168 scm_uintprint (SCM_CELL_WORD_1 (ptr
), 16, port
);
1169 scm_puts_unlocked (") @", port
);
1171 scm_puts_unlocked (" 0x", port
);
1172 scm_uintprint (SCM_UNPACK (ptr
), 16, port
);
1173 scm_putc_unlocked ('>', port
);
1180 scm_iprlist (char *hdr
, SCM exp
, int tlr
, SCM port
, scm_print_state
*pstate
)
1182 register SCM hare
, tortoise
;
1183 long floor
= pstate
->top
- 2;
1184 scm_puts_unlocked (hdr
, port
);
1187 goto fancy_printing
;
1189 /* Run a hare and tortoise so that total time complexity will be
1190 O(depth * N) instead of O(N^2). */
1191 hare
= SCM_CDR (exp
);
1193 while (scm_is_pair (hare
))
1195 if (scm_is_eq (hare
, tortoise
))
1196 goto fancy_printing
;
1197 hare
= SCM_CDR (hare
);
1198 if (!scm_is_pair (hare
))
1200 hare
= SCM_CDR (hare
);
1201 tortoise
= SCM_CDR (tortoise
);
1204 /* No cdr cycles intrinsic to this list */
1205 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1206 for (exp
= SCM_CDR (exp
); scm_is_pair (exp
); exp
= SCM_CDR (exp
))
1210 for (i
= floor
; i
>= 0; --i
)
1211 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), exp
))
1213 PUSH_REF (pstate
, exp
);
1214 scm_putc_unlocked (' ', port
);
1216 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1218 if (!SCM_NULL_OR_NIL_P (exp
))
1220 scm_puts_unlocked (" . ", port
);
1221 scm_iprin1 (exp
, port
, pstate
);
1225 scm_putc_unlocked (tlr
, port
);
1226 pstate
->top
= floor
+ 2;
1231 long n
= pstate
->length
;
1233 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1234 exp
= SCM_CDR (exp
); --n
;
1235 for (; scm_is_pair (exp
); exp
= SCM_CDR (exp
))
1237 register unsigned long i
;
1239 for (i
= 0; i
< pstate
->top
; ++i
)
1240 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), exp
))
1246 scm_puts_unlocked (" ...", port
);
1252 PUSH_REF(pstate
, exp
);
1253 ++pstate
->list_offset
;
1254 scm_putc_unlocked (' ', port
);
1256 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1259 if (!SCM_NULL_OR_NIL_P (exp
))
1261 scm_puts_unlocked (" . ", port
);
1262 scm_iprin1 (exp
, port
, pstate
);
1265 pstate
->list_offset
-= pstate
->top
- floor
- 2;
1269 pstate
->list_offset
-= pstate
->top
- floor
- 2;
1272 scm_puts_unlocked (" . ", port
);
1273 print_circref (port
, pstate
, exp
);
1280 scm_valid_oport_value_p (SCM val
)
1282 return (SCM_OPOUTPORTP (val
)
1283 || (SCM_PORT_WITH_PS_P (val
)
1284 && SCM_OPOUTPORTP (SCM_PORT_WITH_PS_PORT (val
))));
1287 /* SCM_GPROC(s_write, "write", 1, 1, 0, scm_write, g_write); */
1290 scm_write (SCM obj
, SCM port
)
1292 if (SCM_UNBNDP (port
))
1293 port
= scm_current_output_port ();
1295 SCM_ASSERT (scm_valid_oport_value_p (port
), port
, SCM_ARG2
, s_write
);
1297 scm_dynwind_begin (0);
1298 scm_dynwind_lock_port (port
);
1299 scm_prin1 (obj
, port
, 1);
1302 return SCM_UNSPECIFIED
;
1306 /* SCM_GPROC(s_display, "display", 1, 1, 0, scm_display, g_display); */
1309 scm_display (SCM obj
, SCM port
)
1311 if (SCM_UNBNDP (port
))
1312 port
= scm_current_output_port ();
1314 SCM_ASSERT (scm_valid_oport_value_p (port
), port
, SCM_ARG2
, s_display
);
1316 scm_dynwind_begin (0);
1317 scm_dynwind_lock_port (port
);
1318 scm_prin1 (obj
, port
, 0);
1321 return SCM_UNSPECIFIED
;
1325 SCM_DEFINE (scm_simple_format
, "simple-format", 2, 0, 1,
1326 (SCM destination
, SCM message
, SCM args
),
1327 "Write @var{message} to @var{destination}, defaulting to\n"
1328 "the current output port.\n"
1329 "@var{message} can contain @code{~A} (was @code{%s}) and\n"
1330 "@code{~S} (was @code{%S}) escapes. When printed,\n"
1331 "the escapes are replaced with corresponding members of\n"
1333 "@code{~A} formats using @code{display} and @code{~S} formats\n"
1334 "using @code{write}.\n"
1335 "If @var{destination} is @code{#t}, then use the current output\n"
1336 "port, if @var{destination} is @code{#f}, then return a string\n"
1337 "containing the formatted text. Does not add a trailing newline.")
1338 #define FUNC_NAME s_scm_simple_format
1340 SCM port
, answer
= SCM_UNSPECIFIED
;
1341 int fReturnString
= 0;
1343 size_t start
, p
, end
;
1345 if (scm_is_eq (destination
, SCM_BOOL_T
))
1347 destination
= port
= scm_current_output_port ();
1349 else if (scm_is_false (destination
))
1352 port
= scm_mkstrport (SCM_INUM0
, SCM_BOOL_F
,
1353 SCM_OPN
| SCM_WRTNG
,
1359 SCM_VALIDATE_OPORT_VALUE (1, destination
);
1360 port
= SCM_COERCE_OUTPORT (destination
);
1362 SCM_VALIDATE_STRING (2, message
);
1363 SCM_VALIDATE_REST_ARGUMENT (args
);
1367 end
= scm_i_string_length (message
);
1368 for (p
= start
; p
!= end
; ++p
)
1369 if (scm_i_string_ref (message
, p
) == '~')
1374 switch (scm_i_string_ref (message
, p
))
1383 scm_lfwrite_substr (message
, start
, p
, port
);
1387 scm_lfwrite_substr (message
, start
, p
- 1, port
);
1392 SCM_MISC_ERROR ("FORMAT: Unsupported format option ~~~A - use (ice-9 format) instead",
1393 scm_list_1 (SCM_MAKE_CHAR (scm_i_string_ref (message
, p
))));
1398 if (!scm_is_pair (args
))
1399 SCM_MISC_ERROR ("FORMAT: Missing argument for ~~~A",
1400 scm_list_1 (SCM_MAKE_CHAR (scm_i_string_ref (message
, p
))));
1402 scm_lfwrite_substr (message
, start
, p
- 1, port
);
1403 /* we pass destination here */
1404 scm_prin1 (SCM_CAR (args
), destination
, writingp
);
1405 args
= SCM_CDR (args
);
1409 scm_lfwrite_substr (message
, start
, p
, port
);
1410 if (!scm_is_eq (args
, SCM_EOL
))
1411 SCM_MISC_ERROR ("FORMAT: ~A superfluous arguments",
1412 scm_list_1 (scm_length (args
)));
1415 answer
= scm_strport_to_string (destination
);
1417 return scm_return_first (answer
, message
);
1422 SCM_DEFINE (scm_newline
, "newline", 0, 1, 0,
1424 "Send a newline to @var{port}.\n"
1425 "If @var{port} is omitted, send to the current output port.")
1426 #define FUNC_NAME s_scm_newline
1428 if (SCM_UNBNDP (port
))
1429 port
= scm_current_output_port ();
1431 SCM_VALIDATE_OPORT_VALUE (1, port
);
1433 scm_putc_unlocked ('\n', SCM_COERCE_OUTPORT (port
));
1434 return SCM_UNSPECIFIED
;
1438 SCM_DEFINE (scm_write_char
, "write-char", 1, 1, 0,
1439 (SCM chr
, SCM port
),
1440 "Send character @var{chr} to @var{port}.")
1441 #define FUNC_NAME s_scm_write_char
1443 if (SCM_UNBNDP (port
))
1444 port
= scm_current_output_port ();
1446 SCM_VALIDATE_CHAR (1, chr
);
1447 SCM_VALIDATE_OPORT_VALUE (2, port
);
1449 port
= SCM_COERCE_OUTPORT (port
);
1450 if (!display_character (SCM_CHAR (chr
), port
,
1451 scm_i_get_conversion_strategy (port
)))
1452 scm_encoding_error (__func__
, errno
,
1453 "cannot convert to output locale",
1456 return SCM_UNSPECIFIED
;
1462 /* Call back to Scheme code to do the printing of special objects
1463 * (like structs). SCM_PRINTER_APPLY applies PROC to EXP and a smob
1464 * containing PORT and PSTATE. This object can be used as the port for
1465 * display/write etc to continue the current print chain. The REVEALED
1466 * field of PSTATE is set to true to indicate that the print state has
1467 * escaped to Scheme and thus has to be freed by the GC.
1470 scm_t_bits scm_tc16_port_with_ps
;
1472 /* Print exactly as the port itself would */
1475 port_with_ps_print (SCM obj
, SCM port
, scm_print_state
*pstate
)
1477 obj
= SCM_PORT_WITH_PS_PORT (obj
);
1478 return SCM_PORT_DESCRIPTOR (obj
)->print (obj
, port
, pstate
);
1482 scm_printer_apply (SCM proc
, SCM exp
, SCM port
, scm_print_state
*pstate
)
1484 pstate
->revealed
= 1;
1485 return scm_call_2 (proc
, exp
,
1486 scm_i_port_with_print_state (port
, pstate
->handle
));
1489 SCM_DEFINE (scm_port_with_print_state
, "port-with-print-state", 1, 1, 0,
1490 (SCM port
, SCM pstate
),
1491 "Create a new port which behaves like @var{port}, but with an\n"
1492 "included print state @var{pstate}. @var{pstate} is optional.\n"
1493 "If @var{pstate} isn't supplied and @var{port} already has\n"
1494 "a print state, the old print state is reused.")
1495 #define FUNC_NAME s_scm_port_with_print_state
1497 SCM_VALIDATE_OPORT_VALUE (1, port
);
1498 if (!SCM_UNBNDP (pstate
))
1499 SCM_VALIDATE_PRINTSTATE (2, pstate
);
1500 return scm_i_port_with_print_state (port
, pstate
);
1504 SCM_DEFINE (scm_get_print_state
, "get-print-state", 1, 0, 0,
1506 "Return the print state of the port @var{port}. If @var{port}\n"
1507 "has no associated print state, @code{#f} is returned.")
1508 #define FUNC_NAME s_scm_get_print_state
1510 if (SCM_PORT_WITH_PS_P (port
))
1511 return SCM_PORT_WITH_PS_PS (port
);
1512 if (SCM_OUTPUT_PORT_P (port
))
1514 SCM_WRONG_TYPE_ARG (1, port
);
1523 SCM vtable
, layout
, type
;
1525 scm_init_opts (scm_print_options
, scm_print_opts
);
1527 scm_print_options (scm_list_4 (scm_from_latin1_symbol ("highlight-prefix"),
1528 scm_from_locale_string ("{"),
1529 scm_from_latin1_symbol ("highlight-suffix"),
1530 scm_from_locale_string ("}")));
1532 scm_gc_register_root (&print_state_pool
);
1533 scm_gc_register_root (&scm_print_state_vtable
);
1534 vtable
= scm_make_vtable_vtable (scm_nullstr
, SCM_INUM0
, SCM_EOL
);
1536 scm_make_struct_layout (scm_from_locale_string (SCM_PRINT_STATE_LAYOUT
));
1537 type
= scm_make_struct (vtable
, SCM_INUM0
, scm_list_1 (layout
));
1538 scm_set_struct_vtable_name_x (type
, scm_from_latin1_symbol ("print-state"));
1539 scm_print_state_vtable
= type
;
1541 /* Don't want to bind a wrapper class in GOOPS, so pass 0 as arg1. */
1542 scm_tc16_port_with_ps
= scm_make_smob_type (0, 0);
1543 scm_set_smob_print (scm_tc16_port_with_ps
, port_with_ps_print
);
1545 #include "libguile/print.x"
1547 scm_print_opts
[SCM_PRINT_KEYWORD_STYLE_I
].val
= SCM_UNPACK (sym_reader
);