1 /* Copyright (C) 1995-1999, 2000, 2001, 2002, 2003, 2004, 2006, 2008,
2 * 2009, 2010, 2011, 2012, 2013, 2014 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/ports-internal.h"
48 #include "libguile/root.h"
49 #include "libguile/strings.h"
50 #include "libguile/strports.h"
51 #include "libguile/vectors.h"
52 #include "libguile/numbers.h"
53 #include "libguile/vm.h"
55 #include "libguile/validate.h"
56 #include "libguile/print.h"
58 #include "libguile/private-options.h"
62 /* Character printers. */
64 #define PORT_CONVERSION_HANDLER(port) \
65 SCM_PTAB_ENTRY (port)->ilseq_handler
67 static size_t display_string (const void *, int, size_t, SCM
,
68 scm_t_string_failed_conversion_handler
);
70 static int display_character (scm_t_wchar
, SCM
,
71 scm_t_string_failed_conversion_handler
);
73 static void write_character (scm_t_wchar
, SCM
, int);
75 static void write_character_escaped (scm_t_wchar
, int, SCM
);
79 /* {Names of immediate symbols}
81 * This table must agree with the declarations in scm.h: {Immediate Symbols}.
84 /* This table must agree with the list of flags in tags.h. */
85 static const char *iflagnames
[] =
88 "#nil", /* Elisp nil value. Should print from elisp as symbol `nil'. */
89 "#<XXX UNUSED LISP FALSE -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
92 "#<XXX UNUSED BOOLEAN 0 -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
93 "#<XXX UNUSED BOOLEAN 1 -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
94 "#<XXX UNUSED BOOLEAN 2 -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
99 /* Unbound slot marker for GOOPS. For internal use in GOOPS only. */
103 SCM_SYMBOL (sym_reader
, "reader");
105 scm_t_option scm_print_opts
[] = {
106 { SCM_OPTION_SCM
, "highlight-prefix", (scm_t_bits
)SCM_BOOL_F_BITS
,
107 "The string to print before highlighted values." },
108 { SCM_OPTION_SCM
, "highlight-suffix", (scm_t_bits
)SCM_BOOL_F_BITS
,
109 "The string to print after highlighted values." },
110 { SCM_OPTION_SCM
, "quote-keywordish-symbols", (scm_t_bits
)SCM_BOOL_F_BITS
,
111 "How to print symbols that have a colon as their first or last character. "
112 "The value '#f' does not quote the colons; '#t' quotes them; "
113 "'reader' quotes them when the reader option 'keywords' is not '#f'." },
114 { SCM_OPTION_BOOLEAN
, "escape-newlines", 1,
115 "Render newlines as \\n when printing using `write'." },
116 { SCM_OPTION_BOOLEAN
, "r7rs-symbols", 0,
117 "Escape symbols using R7RS |...| symbol notation." },
121 SCM_DEFINE (scm_print_options
, "print-options-interface", 0, 1, 0,
123 "Option interface for the print options. Instead of using\n"
124 "this procedure directly, use the procedures\n"
125 "@code{print-enable}, @code{print-disable}, @code{print-set!}\n"
126 "and @code{print-options}.")
127 #define FUNC_NAME s_scm_print_options
129 SCM ans
= scm_options (setting
,
137 /* {Printing of Scheme Objects}
140 /* Detection of circular references.
142 * Due to other constraints in the implementation, this code has bad
143 * time complexity (O (depth * N)), The printer code can be
144 * rewritten to be O(N).
146 #define PUSH_REF(pstate, obj) \
149 PSTATE_STACK_SET (pstate, pstate->top, obj); \
151 if (pstate->top == pstate->ceiling) \
152 grow_ref_stack (pstate); \
155 #define ENTER_NESTED_DATA(pstate, obj, label) \
158 register unsigned long i; \
159 for (i = 0; i < pstate->top; ++i) \
160 if (scm_is_eq (PSTATE_STACK_REF (pstate, i), (obj))) \
162 if (pstate->fancyp) \
164 if (pstate->top - pstate->list_offset >= pstate->level) \
166 scm_putc_unlocked ('#', port); \
170 PUSH_REF(pstate, obj); \
173 #define EXIT_NESTED_DATA(pstate) \
177 PSTATE_STACK_SET (pstate, pstate->top, SCM_UNDEFINED); \
181 SCM scm_print_state_vtable
= SCM_BOOL_F
;
182 static SCM print_state_pool
= SCM_EOL
;
183 scm_i_pthread_mutex_t print_state_mutex
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
185 #ifdef GUILE_DEBUG /* Used for debugging purposes */
187 SCM_DEFINE (scm_current_pstate
, "current-pstate", 0, 0, 0,
189 "Return the current-pstate -- the car of the\n"
190 "@code{print_state_pool}. @code{current-pstate} is only\n"
191 "included in @code{--enable-guile-debug} builds.")
192 #define FUNC_NAME s_scm_current_pstate
194 if (!scm_is_null (print_state_pool
))
195 return SCM_CAR (print_state_pool
);
203 #define PSTATE_SIZE 50L
206 make_print_state (void)
209 = scm_make_struct (scm_print_state_vtable
, SCM_INUM0
, SCM_EOL
);
210 scm_print_state
*pstate
= SCM_PRINT_STATE (print_state
);
211 pstate
->ref_vect
= scm_c_make_vector (PSTATE_SIZE
, SCM_UNDEFINED
);
212 pstate
->ceiling
= SCM_SIMPLE_VECTOR_LENGTH (pstate
->ref_vect
);
213 pstate
->highlight_objects
= SCM_EOL
;
218 scm_make_print_state ()
220 SCM answer
= SCM_BOOL_F
;
222 /* First try to allocate a print state from the pool */
223 scm_i_pthread_mutex_lock (&print_state_mutex
);
224 if (!scm_is_null (print_state_pool
))
226 answer
= SCM_CAR (print_state_pool
);
227 print_state_pool
= SCM_CDR (print_state_pool
);
229 scm_i_pthread_mutex_unlock (&print_state_mutex
);
231 return scm_is_false (answer
) ? make_print_state () : answer
;
235 scm_free_print_state (SCM print_state
)
238 scm_print_state
*pstate
= SCM_PRINT_STATE (print_state
);
239 /* Cleanup before returning print state to pool.
240 * It is better to do it here. Doing it in scm_prin1
241 * would cost more since that function is called much more
245 pstate
->revealed
= 0;
246 pstate
->highlight_objects
= SCM_EOL
;
247 scm_i_pthread_mutex_lock (&print_state_mutex
);
248 handle
= scm_cons (print_state
, print_state_pool
);
249 print_state_pool
= handle
;
250 scm_i_pthread_mutex_unlock (&print_state_mutex
);
254 scm_i_port_with_print_state (SCM port
, SCM print_state
)
256 if (SCM_UNBNDP (print_state
))
258 if (SCM_PORT_WITH_PS_P (port
))
261 print_state
= scm_make_print_state ();
262 /* port does not need to be coerced since it doesn't have ps */
265 port
= SCM_COERCE_OUTPORT (port
);
266 SCM_RETURN_NEWSMOB (scm_tc16_port_with_ps
,
267 SCM_UNPACK (scm_cons (port
, print_state
)));
271 grow_ref_stack (scm_print_state
*pstate
)
273 SCM old_vect
= pstate
->ref_vect
;
274 size_t old_size
= SCM_SIMPLE_VECTOR_LENGTH (old_vect
);
275 size_t new_size
= 2 * pstate
->ceiling
;
276 SCM new_vect
= scm_c_make_vector (new_size
, SCM_UNDEFINED
);
279 for (i
= 0; i
!= old_size
; ++i
)
280 SCM_SIMPLE_VECTOR_SET (new_vect
, i
, SCM_SIMPLE_VECTOR_REF (old_vect
, i
));
282 pstate
->ref_vect
= new_vect
;
283 pstate
->ceiling
= new_size
;
286 #define PSTATE_STACK_REF(p,i) SCM_SIMPLE_VECTOR_REF((p)->ref_vect, (i))
287 #define PSTATE_STACK_SET(p,i,v) SCM_SIMPLE_VECTOR_SET((p)->ref_vect, (i), (v))
290 print_circref (SCM port
, scm_print_state
*pstate
, SCM ref
)
293 long self
= pstate
->top
- 1;
295 if (scm_is_pair (PSTATE_STACK_REF (pstate
, i
)))
299 if (!scm_is_pair (PSTATE_STACK_REF (pstate
, i
-1))
300 || !scm_is_eq (SCM_CDR (PSTATE_STACK_REF (pstate
, i
-1)),
301 SCM_CDR (PSTATE_STACK_REF (pstate
, i
))))
307 for (i
= pstate
->top
- 1; 1; --i
)
308 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), ref
))
310 scm_putc_unlocked ('#', port
);
311 scm_intprint (i
- self
, 10, port
);
312 scm_putc_unlocked ('#', port
);
315 /* Print the name of a symbol. */
318 quote_keywordish_symbols (void)
320 SCM option
= SCM_PRINT_KEYWORD_STYLE
;
322 if (scm_is_false (option
))
324 if (scm_is_eq (option
, sym_reader
))
325 return scm_is_true (SCM_PACK (SCM_KEYWORD_STYLE
));
329 #define INITIAL_IDENTIFIER_MASK \
330 (UC_CATEGORY_MASK_Lu | UC_CATEGORY_MASK_Ll | UC_CATEGORY_MASK_Lt \
331 | UC_CATEGORY_MASK_Lm | UC_CATEGORY_MASK_Lo | UC_CATEGORY_MASK_Mn \
332 | UC_CATEGORY_MASK_Nl | UC_CATEGORY_MASK_No | UC_CATEGORY_MASK_Pd \
333 | UC_CATEGORY_MASK_Pc | UC_CATEGORY_MASK_Po | UC_CATEGORY_MASK_Sc \
334 | UC_CATEGORY_MASK_Sm | UC_CATEGORY_MASK_Sk | UC_CATEGORY_MASK_So \
335 | UC_CATEGORY_MASK_Co)
337 #define SUBSEQUENT_IDENTIFIER_MASK \
338 (INITIAL_IDENTIFIER_MASK \
339 | UC_CATEGORY_MASK_Nd | UC_CATEGORY_MASK_Mc | UC_CATEGORY_MASK_Me)
341 /* FIXME: Cache this information on the symbol, somehow. */
343 symbol_has_extended_read_syntax (SCM sym
)
345 size_t pos
, len
= scm_i_symbol_length (sym
);
348 /* The empty symbol. */
352 c
= scm_i_symbol_ref (sym
, 0);
362 /* Some initial-character constraints. */
367 /* R7RS allows neither '|' nor '\' in bare symbols. */
368 if (SCM_PRINT_R7RS_SYMBOLS_P
)
373 /* Symbols that look like keywords. */
374 return quote_keywordish_symbols ();
377 /* Single dot conflicts with dotted-pair notation. */
380 /* Fall through to check numbers. */
393 /* Number-ish symbols. Numbers with radixes already caught be #
395 if (scm_is_true (scm_i_string_to_number (scm_symbol_to_string (sym
), 10)))
403 /* Other disallowed first characters. */
404 if (!uc_is_general_category_withtable (c
, INITIAL_IDENTIFIER_MASK
))
407 /* Keywords can be identified by trailing colons too. */
408 if (scm_i_symbol_ref (sym
, len
- 1) == ':')
409 return quote_keywordish_symbols ();
411 /* Otherwise, any character that's in the identifier category mask is
412 fine to pass through as-is, provided it's not one of the ASCII
413 delimiters like `;'. */
414 for (pos
= 1; pos
< len
; pos
++)
416 c
= scm_i_symbol_ref (sym
, pos
);
417 if (!uc_is_general_category_withtable (c
, SUBSEQUENT_IDENTIFIER_MASK
))
419 else if (c
== '"' || c
== ';' || c
== '#')
421 else if ((c
== '|' || c
== '\\') && SCM_PRINT_R7RS_SYMBOLS_P
)
422 /* R7RS allows neither '|' nor '\' in bare symbols. */
430 print_normal_symbol (SCM sym
, SCM port
)
433 scm_t_string_failed_conversion_handler strategy
;
435 len
= scm_i_symbol_length (sym
);
436 strategy
= SCM_PTAB_ENTRY (port
)->ilseq_handler
;
438 if (scm_i_is_narrow_symbol (sym
))
439 display_string (scm_i_symbol_chars (sym
), 1, len
, port
, strategy
);
441 display_string (scm_i_symbol_wide_chars (sym
), 0, len
, port
, strategy
);
445 print_extended_symbol (SCM sym
, SCM port
)
448 scm_t_string_failed_conversion_handler strategy
;
450 len
= scm_i_symbol_length (sym
);
451 strategy
= PORT_CONVERSION_HANDLER (port
);
453 scm_lfwrite_unlocked ("#{", 2, port
);
455 for (pos
= 0; pos
< len
; pos
++)
457 scm_t_wchar c
= scm_i_symbol_ref (sym
, pos
);
459 if (uc_is_general_category_withtable (c
,
460 SUBSEQUENT_IDENTIFIER_MASK
461 | UC_CATEGORY_MASK_Zs
))
463 if (!display_character (c
, port
, strategy
)
464 || (c
== '\\' && !display_character (c
, port
, strategy
)))
465 scm_encoding_error ("print_extended_symbol", errno
,
466 "cannot convert to output locale",
467 port
, SCM_MAKE_CHAR (c
));
471 scm_lfwrite_unlocked ("\\x", 2, port
);
472 scm_intprint (c
, 16, port
);
473 scm_putc_unlocked (';', port
);
477 scm_lfwrite_unlocked ("}#", 2, port
);
481 print_r7rs_extended_symbol (SCM sym
, SCM port
)
484 scm_t_string_failed_conversion_handler strategy
;
486 len
= scm_i_symbol_length (sym
);
487 strategy
= PORT_CONVERSION_HANDLER (port
);
489 scm_putc_unlocked ('|', port
);
491 for (pos
= 0; pos
< len
; pos
++)
493 scm_t_wchar c
= scm_i_symbol_ref (sym
, pos
);
497 case '\a': scm_lfwrite_unlocked ("\\a", 2, port
); break;
498 case '\b': scm_lfwrite_unlocked ("\\b", 2, port
); break;
499 case '\t': scm_lfwrite_unlocked ("\\t", 2, port
); break;
500 case '\n': scm_lfwrite_unlocked ("\\n", 2, port
); break;
501 case '\r': scm_lfwrite_unlocked ("\\r", 2, port
); break;
502 case '|': scm_lfwrite_unlocked ("\\|", 2, port
); break;
503 case '\\': scm_lfwrite_unlocked ("\\x5c;", 5, port
); break;
505 if (uc_is_general_category_withtable (c
,
510 | UC_CATEGORY_MASK_S
)
513 if (!display_character (c
, port
, strategy
))
514 scm_encoding_error ("print_r7rs_extended_symbol", errno
,
515 "cannot convert to output locale",
516 port
, SCM_MAKE_CHAR (c
));
520 scm_lfwrite_unlocked ("\\x", 2, port
);
521 scm_intprint (c
, 16, port
);
522 scm_putc_unlocked (';', port
);
528 scm_putc_unlocked ('|', port
);
531 /* FIXME: allow R6RS hex escapes instead of #{...}# or |...|. */
533 print_symbol (SCM sym
, SCM port
)
535 if (!symbol_has_extended_read_syntax (sym
))
536 print_normal_symbol (sym
, port
);
537 else if (SCM_PRINT_R7RS_SYMBOLS_P
)
538 print_r7rs_extended_symbol (sym
, port
);
540 print_extended_symbol (sym
, port
);
544 scm_print_symbol_name (const char *str
, size_t len
, SCM port
)
546 SCM symbol
= scm_from_utf8_symboln (str
, len
);
547 print_symbol (symbol
, port
);
550 /* Print generally. Handles both write and display according to PSTATE.
552 SCM_GPROC(s_write
, "write", 1, 1, 0, scm_write
, g_write
);
553 SCM_GPROC(s_display
, "display", 1, 1, 0, scm_display
, g_display
);
555 static void iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
);
558 /* Print a character as an octal or hex escape. */
559 #define PRINT_CHAR_ESCAPE(i, port) \
562 if (!SCM_R6RS_ESCAPES_P) \
563 scm_intprint (i, 8, port); \
566 scm_puts_unlocked ("x", port); \
567 scm_intprint (i, 16, port); \
574 scm_iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
)
577 && scm_is_true (scm_memq (exp
, pstate
->highlight_objects
)))
579 scm_display (SCM_PRINT_HIGHLIGHT_PREFIX
, port
);
580 iprin1 (exp
, port
, pstate
);
581 scm_display (SCM_PRINT_HIGHLIGHT_SUFFIX
, port
);
584 iprin1 (exp
, port
, pstate
);
588 iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
)
590 switch (SCM_ITAG3 (exp
))
594 /* These tc3 tags should never occur in an immediate value. They are
595 * only used in cell types of non-immediates, i. e. the value returned
596 * by SCM_CELL_TYPE (exp) can use these tags.
598 scm_ipruk ("immediate", exp
, port
);
602 scm_intprint (SCM_I_INUM (exp
), 10, port
);
607 if (SCM_WRITINGP (pstate
))
608 write_character (SCM_CHAR (exp
), port
, 0);
611 if (!display_character (SCM_CHAR (exp
), port
,
612 PORT_CONVERSION_HANDLER (port
)))
613 scm_encoding_error (__func__
, errno
,
614 "cannot convert to output locale",
618 else if (SCM_IFLAGP (exp
)
619 && ((size_t) SCM_IFLAGNUM (exp
) < (sizeof iflagnames
/ sizeof (char *))))
621 scm_puts_unlocked (iflagnames
[SCM_IFLAGNUM (exp
)], port
);
625 /* unknown immediate value */
626 scm_ipruk ("immediate", exp
, port
);
630 switch (SCM_TYP7 (exp
))
634 ENTER_NESTED_DATA (pstate
, exp
, circref
);
635 if (SCM_OBJ_CLASS_FLAGS (exp
) & SCM_CLASSF_GOOPS
)
637 SCM pwps
, print
= pstate
->writingp
? g_write
: g_display
;
638 if (SCM_UNPACK (print
) == 0)
640 pwps
= scm_i_port_with_print_state (port
, pstate
->handle
);
641 pstate
->revealed
= 1;
642 scm_call_2 (print
, exp
, pwps
);
647 scm_print_struct (exp
, port
, pstate
);
649 EXIT_NESTED_DATA (pstate
);
652 case scm_tcs_cons_imcar
:
653 case scm_tcs_cons_nimcar
:
654 ENTER_NESTED_DATA (pstate
, exp
, circref
);
655 scm_iprlist ("(", exp
, ')', port
, pstate
);
656 EXIT_NESTED_DATA (pstate
);
659 print_circref (port
, pstate
, exp
);
662 switch SCM_TYP16 (exp
) {
664 scm_bigprint (exp
, port
, pstate
);
667 scm_print_real (exp
, port
, pstate
);
669 case scm_tc16_complex
:
670 scm_print_complex (exp
, port
, pstate
);
672 case scm_tc16_fraction
:
673 scm_i_print_fraction (exp
, port
, pstate
);
677 case scm_tc7_stringbuf
:
678 scm_i_print_stringbuf (exp
, port
, pstate
);
681 if (SCM_WRITINGP (pstate
))
685 display_character ('"', port
, iconveh_question_mark
);
686 len
= scm_i_string_length (exp
);
687 for (i
= 0; i
< len
; ++i
)
688 write_character (scm_i_string_ref (exp
, i
), port
, 1);
690 display_character ('"', port
, iconveh_question_mark
);
691 scm_remember_upto_here_1 (exp
);
697 len
= scm_i_string_length (exp
);
698 printed
= display_string (scm_i_string_data (exp
),
699 scm_i_is_narrow_string (exp
),
701 PORT_CONVERSION_HANDLER (port
));
702 if (SCM_UNLIKELY (printed
< len
))
703 scm_encoding_error (__func__
, errno
,
704 "cannot convert to output locale",
705 port
, scm_c_string_ref (exp
, printed
));
708 scm_remember_upto_here_1 (exp
);
711 if (scm_i_symbol_is_interned (exp
))
713 print_symbol (exp
, port
);
714 scm_remember_upto_here_1 (exp
);
718 scm_puts_unlocked ("#<uninterned-symbol ", port
);
719 print_symbol (exp
, port
);
720 scm_putc_unlocked (' ', port
);
721 scm_uintprint (SCM_UNPACK (exp
), 16, port
);
722 scm_putc_unlocked ('>', port
);
725 case scm_tc7_variable
:
726 scm_i_variable_print (exp
, port
, pstate
);
728 case scm_tc7_program
:
729 scm_i_program_print (exp
, port
, pstate
);
731 case scm_tc7_pointer
:
732 scm_i_pointer_print (exp
, port
, pstate
);
734 case scm_tc7_hashtable
:
735 scm_i_hashtable_print (exp
, port
, pstate
);
737 case scm_tc7_weak_set
:
738 scm_i_weak_set_print (exp
, port
, pstate
);
740 case scm_tc7_weak_table
:
741 scm_i_weak_table_print (exp
, port
, pstate
);
744 scm_i_fluid_print (exp
, port
, pstate
);
746 case scm_tc7_dynamic_state
:
747 scm_i_dynamic_state_print (exp
, port
, pstate
);
750 scm_i_frame_print (exp
, port
, pstate
);
752 case scm_tc7_vm_cont
:
753 scm_i_vm_cont_print (exp
, port
, pstate
);
756 ENTER_NESTED_DATA (pstate
, exp
, circref
);
757 scm_i_print_array (exp
, port
, pstate
);
758 EXIT_NESTED_DATA (pstate
);
760 case scm_tc7_bytevector
:
761 scm_i_print_bytevector (exp
, port
, pstate
);
763 case scm_tc7_bitvector
:
764 scm_i_print_bitvector (exp
, port
, pstate
);
767 ENTER_NESTED_DATA (pstate
, exp
, circref
);
768 scm_puts_unlocked ("#w(", port
);
769 goto common_vector_printer
;
771 ENTER_NESTED_DATA (pstate
, exp
, circref
);
772 scm_puts_unlocked ("#(", port
);
773 common_vector_printer
:
776 long last
= SCM_SIMPLE_VECTOR_LENGTH (exp
) - 1;
779 && SCM_SIMPLE_VECTOR_LENGTH (exp
) > pstate
->length
)
781 last
= pstate
->length
- 1;
784 for (i
= 0; i
< last
; ++i
)
786 scm_iprin1 (scm_c_vector_ref (exp
, i
), port
, pstate
);
787 scm_putc_unlocked (' ', port
);
792 scm_iprin1 (scm_c_vector_ref (exp
, i
), port
, pstate
);
795 scm_puts_unlocked (" ...", port
);
796 scm_putc_unlocked (')', port
);
798 EXIT_NESTED_DATA (pstate
);
802 scm_t_ptob_descriptor
*ptob
= SCM_PORT_DESCRIPTOR (exp
);
803 if (ptob
->print
&& ptob
->print (exp
, port
, pstate
))
808 ENTER_NESTED_DATA (pstate
, exp
, circref
);
809 SCM_SMOB_DESCRIPTOR (exp
).print (exp
, port
, pstate
);
810 EXIT_NESTED_DATA (pstate
);
813 /* case scm_tcs_closures: */
815 scm_ipruk ("type", exp
, port
);
820 /* Print states are necessary for circular reference safe printing.
821 * They are also expensive to allocate. Therefore print states are
822 * kept in a pool so that they can be reused.
825 /* The PORT argument can also be a print-state/port pair, which will
826 * then be used instead of allocating a new print state. This is
827 * useful for continuing a chain of print calls from Scheme. */
830 scm_prin1 (SCM exp
, SCM port
, int writingp
)
832 SCM handle
= SCM_BOOL_F
; /* Will GC protect the handle whilst unlinked */
834 scm_print_state
*pstate
;
837 /* If PORT is a print-state/port pair, use that. Else create a new
840 if (SCM_PORT_WITH_PS_P (port
))
842 pstate_scm
= SCM_PORT_WITH_PS_PS (port
);
843 port
= SCM_PORT_WITH_PS_PORT (port
);
847 /* First try to allocate a print state from the pool */
848 scm_i_pthread_mutex_lock (&print_state_mutex
);
849 if (!scm_is_null (print_state_pool
))
851 handle
= print_state_pool
;
852 print_state_pool
= SCM_CDR (print_state_pool
);
854 scm_i_pthread_mutex_unlock (&print_state_mutex
);
855 if (scm_is_false (handle
))
856 handle
= scm_list_1 (make_print_state ());
857 pstate_scm
= SCM_CAR (handle
);
860 pstate
= SCM_PRINT_STATE (pstate_scm
);
861 old_writingp
= pstate
->writingp
;
862 pstate
->writingp
= writingp
;
863 scm_iprin1 (exp
, port
, pstate
);
864 pstate
->writingp
= old_writingp
;
866 /* Return print state to pool if it has been created above and
867 hasn't escaped to Scheme. */
869 if (scm_is_true (handle
) && !pstate
->revealed
)
871 scm_i_pthread_mutex_lock (&print_state_mutex
);
872 SCM_SETCDR (handle
, print_state_pool
);
873 print_state_pool
= handle
;
874 scm_i_pthread_mutex_unlock (&print_state_mutex
);
878 /* Convert codepoint CH to UTF-8 and store the result in UTF8. Return
879 the number of bytes of the UTF-8-encoded string. */
881 codepoint_to_utf8 (scm_t_wchar ch
, scm_t_uint8 utf8
[4])
884 scm_t_uint32 codepoint
;
886 codepoint
= (scm_t_uint32
) ch
;
888 if (codepoint
<= 0x7f)
891 utf8
[0] = (scm_t_uint8
) codepoint
;
893 else if (codepoint
<= 0x7ffUL
)
896 utf8
[0] = 0xc0 | (codepoint
>> 6);
897 utf8
[1] = 0x80 | (codepoint
& 0x3f);
899 else if (codepoint
<= 0xffffUL
)
902 utf8
[0] = 0xe0 | (codepoint
>> 12);
903 utf8
[1] = 0x80 | ((codepoint
>> 6) & 0x3f);
904 utf8
[2] = 0x80 | (codepoint
& 0x3f);
909 utf8
[0] = 0xf0 | (codepoint
>> 18);
910 utf8
[1] = 0x80 | ((codepoint
>> 12) & 0x3f);
911 utf8
[2] = 0x80 | ((codepoint
>> 6) & 0x3f);
912 utf8
[3] = 0x80 | (codepoint
& 0x3f);
918 #define STR_REF(s, x) \
920 ? (scm_t_wchar) ((unsigned char *) (s))[x] \
921 : ((scm_t_wchar *) (s))[x])
923 /* Write STR to PORT as UTF-8. STR is a LEN-codepoint string; it is
924 narrow if NARROW_P is true, wide otherwise. Return LEN. */
926 display_string_as_utf8 (const void *str
, int narrow_p
, size_t len
,
931 while (len
> printed
)
934 char *input
, utf8_buf
[256];
936 /* Convert STR to UTF-8. */
937 for (i
= printed
, utf8_len
= 0, input
= utf8_buf
;
938 i
< len
&& utf8_len
+ 4 < sizeof (utf8_buf
);
941 utf8_len
+= codepoint_to_utf8 (STR_REF (str
, i
),
942 (scm_t_uint8
*) input
);
943 input
= utf8_buf
+ utf8_len
;
946 /* INPUT was successfully converted, entirely; print the
948 scm_lfwrite_unlocked (utf8_buf
, utf8_len
, port
);
949 printed
+= i
- printed
;
952 assert (printed
== len
);
957 /* Write STR to PORT as ISO-8859-1. STR is a LEN-codepoint string; it
958 is narrow if NARROW_P is true, wide otherwise. Return LEN. */
960 display_string_as_latin1 (const void *str
, int narrow_p
, size_t len
,
962 scm_t_string_failed_conversion_handler strategy
)
968 scm_lfwrite_unlocked (str
, len
, port
);
972 while (printed
< len
)
977 for (i
= 0; i
< sizeof(buf
) && printed
< len
; i
++, printed
++)
979 scm_t_wchar c
= STR_REF (str
, printed
);
987 scm_lfwrite_unlocked (buf
, i
, port
);
989 if (i
< sizeof(buf
) && printed
< len
)
991 if (strategy
== SCM_FAILED_CONVERSION_ERROR
)
993 else if (strategy
== SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
)
994 write_character_escaped (STR_REF (str
, printed
), 1, port
);
996 /* STRATEGY is `SCM_FAILED_CONVERSION_QUESTION_MARK'. */
997 display_string ("?", 1, 1, port
, strategy
);
1005 /* Convert STR through PORT's output conversion descriptor and write the
1006 output to PORT. Return the number of codepoints written. */
1008 display_string_using_iconv (const void *str
, int narrow_p
, size_t len
,
1010 scm_t_string_failed_conversion_handler strategy
)
1013 scm_t_iconv_descriptors
*id
;
1014 scm_t_port_internal
*pti
= SCM_PORT_GET_INTERNAL (port
);
1016 id
= scm_i_port_iconv_descriptors (port
, SCM_PORT_WRITE
);
1018 if (SCM_UNLIKELY (pti
->at_stream_start_for_bom_write
&& len
> 0))
1020 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1022 /* Record that we're no longer at stream start. */
1023 pti
->at_stream_start_for_bom_write
= 0;
1025 pti
->at_stream_start_for_bom_read
= 0;
1027 /* Write a BOM if appropriate. */
1028 if (SCM_UNLIKELY (strcmp(pt
->encoding
, "UTF-16") == 0
1029 || strcmp(pt
->encoding
, "UTF-32") == 0))
1030 display_character (SCM_UNICODE_BOM
, port
, iconveh_error
);
1035 while (len
> printed
)
1037 size_t done
, utf8_len
, input_left
, output_left
, i
;
1038 size_t codepoints_read
, output_len
;
1039 char *input
, *output
;
1040 char utf8_buf
[256], encoded_output
[256];
1041 size_t offsets
[256];
1043 /* Convert STR to UTF-8. */
1044 for (i
= printed
, utf8_len
= 0, input
= utf8_buf
;
1045 i
< len
&& utf8_len
+ 4 < sizeof (utf8_buf
);
1048 offsets
[utf8_len
] = i
;
1049 utf8_len
+= codepoint_to_utf8 (STR_REF (str
, i
),
1050 (scm_t_uint8
*) input
);
1051 input
= utf8_buf
+ utf8_len
;
1055 input_left
= utf8_len
;
1057 output
= encoded_output
;
1058 output_left
= sizeof (encoded_output
);
1060 done
= iconv (id
->output_cd
, &input
, &input_left
,
1061 &output
, &output_left
);
1063 output_len
= sizeof (encoded_output
) - output_left
;
1065 if (SCM_UNLIKELY (done
== (size_t) -1))
1067 int errno_save
= errno
;
1069 /* Reset the `iconv' state. */
1070 iconv (id
->output_cd
, NULL
, NULL
, NULL
, NULL
);
1072 /* Print the OUTPUT_LEN bytes successfully converted. */
1073 scm_lfwrite_unlocked (encoded_output
, output_len
, port
);
1075 /* See how many input codepoints these OUTPUT_LEN bytes
1077 codepoints_read
= offsets
[input
- utf8_buf
] - printed
;
1078 printed
+= codepoints_read
;
1080 if (errno_save
== EILSEQ
&&
1081 strategy
!= SCM_FAILED_CONVERSION_ERROR
)
1083 /* Conversion failed somewhere in INPUT and we want to
1084 escape or substitute the offending input character. */
1086 if (strategy
== SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
)
1090 /* Find CH, the offending codepoint, and escape it. */
1091 ch
= STR_REF (str
, offsets
[input
- utf8_buf
]);
1092 write_character_escaped (ch
, 1, port
);
1095 /* STRATEGY is `SCM_FAILED_CONVERSION_QUESTION_MARK'. */
1096 display_string ("?", 1, 1, port
, strategy
);
1101 /* Something bad happened that we can't handle: bail out. */
1106 /* INPUT was successfully converted, entirely; print the
1108 scm_lfwrite_unlocked (encoded_output
, output_len
, port
);
1109 codepoints_read
= i
- printed
;
1110 printed
+= codepoints_read
;
1119 /* Display the LEN codepoints in STR to PORT according to STRATEGY;
1120 return the number of codepoints successfully displayed. If NARROW_P,
1121 then STR is interpreted as a sequence of `char', denoting a Latin-1
1122 string; otherwise it's interpreted as a sequence of
1125 display_string (const void *str
, int narrow_p
,
1126 size_t len
, SCM port
,
1127 scm_t_string_failed_conversion_handler strategy
)
1129 scm_t_port_internal
*pti
;
1131 pti
= SCM_PORT_GET_INTERNAL (port
);
1133 if (pti
->encoding_mode
== SCM_PORT_ENCODING_MODE_UTF8
)
1134 return display_string_as_utf8 (str
, narrow_p
, len
, port
);
1135 else if (pti
->encoding_mode
== SCM_PORT_ENCODING_MODE_LATIN1
)
1136 return display_string_as_latin1 (str
, narrow_p
, len
, port
, strategy
);
1138 return display_string_using_iconv (str
, narrow_p
, len
, port
, strategy
);
1141 /* Attempt to display CH to PORT according to STRATEGY. Return non-zero
1142 if CH was successfully displayed, zero otherwise (e.g., if it was not
1143 representable in PORT's encoding.) */
1145 display_character (scm_t_wchar ch
, SCM port
,
1146 scm_t_string_failed_conversion_handler strategy
)
1148 return display_string (&ch
, 0, 1, port
, strategy
) == 1;
1151 /* Attempt to pretty-print CH, a combining character, to PORT. Return
1152 zero upon failure, non-zero otherwise. The idea is to print CH above
1153 a dotted circle to make it more visible. */
1155 write_combining_character (scm_t_wchar ch
, SCM port
)
1159 str
[0] = SCM_CODEPOINT_DOTTED_CIRCLE
;
1162 return display_string (str
, 0, 2, port
, iconveh_error
) == 2;
1165 /* Write CH to PORT in its escaped form, using the string escape syntax
1166 if STRING_ESCAPES_P is non-zero. */
1168 write_character_escaped (scm_t_wchar ch
, int string_escapes_p
, SCM port
)
1170 if (string_escapes_p
)
1172 /* Represent CH using the in-string escape syntax. */
1174 static const char hex
[] = "0123456789abcdef";
1175 static const char escapes
[7] = "abtnvfr";
1178 if (ch
>= 0x07 && ch
<= 0x0D && ch
!= 0x0A)
1180 /* Use special escapes for some C0 controls. */
1182 buf
[1] = escapes
[ch
- 0x07];
1183 scm_lfwrite_unlocked (buf
, 2, port
);
1185 else if (!SCM_R6RS_ESCAPES_P
)
1191 buf
[2] = hex
[ch
/ 16];
1192 buf
[3] = hex
[ch
% 16];
1193 scm_lfwrite_unlocked (buf
, 4, port
);
1195 else if (ch
<= 0xFFFF)
1199 buf
[2] = hex
[(ch
& 0xF000) >> 12];
1200 buf
[3] = hex
[(ch
& 0xF00) >> 8];
1201 buf
[4] = hex
[(ch
& 0xF0) >> 4];
1202 buf
[5] = hex
[(ch
& 0xF)];
1203 scm_lfwrite_unlocked (buf
, 6, port
);
1205 else if (ch
> 0xFFFF)
1209 buf
[2] = hex
[(ch
& 0xF00000) >> 20];
1210 buf
[3] = hex
[(ch
& 0xF0000) >> 16];
1211 buf
[4] = hex
[(ch
& 0xF000) >> 12];
1212 buf
[5] = hex
[(ch
& 0xF00) >> 8];
1213 buf
[6] = hex
[(ch
& 0xF0) >> 4];
1214 buf
[7] = hex
[(ch
& 0xF)];
1215 scm_lfwrite_unlocked (buf
, 8, port
);
1220 /* Print an R6RS variable-length hex escape: "\xNNNN;". */
1221 scm_t_wchar ch2
= ch
;
1231 buf
[i
] = hex
[ch2
& 0xF];
1238 scm_lfwrite_unlocked (buf
+ i
, 9 - i
, port
);
1243 /* Represent CH using the character escape syntax. */
1246 name
= scm_i_charname (SCM_MAKE_CHAR (ch
));
1248 scm_puts_unlocked (name
, port
);
1250 PRINT_CHAR_ESCAPE (ch
, port
);
1254 /* Write CH to PORT, escaping it if it's non-graphic or not
1255 representable in PORT's encoding. If STRING_ESCAPES_P is true and CH
1256 needs to be escaped, it is escaped using the in-string escape syntax;
1257 otherwise the character escape syntax is used. */
1259 write_character (scm_t_wchar ch
, SCM port
, int string_escapes_p
)
1262 scm_t_string_failed_conversion_handler strategy
;
1264 strategy
= PORT_CONVERSION_HANDLER (port
);
1266 if (string_escapes_p
)
1268 /* Check if CH deserves special treatment. */
1269 if (ch
== '"' || ch
== '\\')
1271 display_character ('\\', port
, iconveh_question_mark
);
1272 display_character (ch
, port
, strategy
);
1275 else if (ch
== '\n' && SCM_PRINT_ESCAPE_NEWLINES_P
)
1277 display_character ('\\', port
, iconveh_question_mark
);
1278 display_character ('n', port
, strategy
);
1281 else if (ch
== ' ' || ch
== '\n')
1283 display_character (ch
, port
, strategy
);
1289 display_string ("#\\", 1, 2, port
, iconveh_question_mark
);
1291 if (uc_combining_class (ch
) != UC_CCC_NR
)
1292 /* Character is a combining character, so attempt to
1294 printed
= write_combining_character (ch
, port
);
1298 && uc_is_general_category_withtable (ch
,
1299 UC_CATEGORY_MASK_L
|
1300 UC_CATEGORY_MASK_M
|
1301 UC_CATEGORY_MASK_N
|
1302 UC_CATEGORY_MASK_P
|
1303 UC_CATEGORY_MASK_S
))
1304 /* CH is graphic; attempt to display it. */
1305 printed
= display_character (ch
, port
, iconveh_error
);
1308 /* CH isn't graphic or cannot be represented in PORT's encoding. */
1309 write_character_escaped (ch
, string_escapes_p
, port
);
1312 /* Display STR to PORT from START inclusive to END exclusive. */
1314 scm_i_display_substring (SCM str
, size_t start
, size_t end
, SCM port
)
1318 size_t len
, printed
;
1320 buf
= scm_i_string_data (str
);
1322 narrow_p
= scm_i_is_narrow_string (str
);
1323 buf
+= start
* (narrow_p
? sizeof (char) : sizeof (scm_t_wchar
));
1325 printed
= display_string (buf
, narrow_p
, end
- start
, port
,
1326 PORT_CONVERSION_HANDLER (port
));
1328 if (SCM_UNLIKELY (printed
< len
))
1329 scm_encoding_error (__func__
, errno
,
1330 "cannot convert to output locale",
1331 port
, scm_c_string_ref (str
, printed
+ start
));
1335 /* Print an integer.
1339 scm_intprint (scm_t_intmax n
, int radix
, SCM port
)
1341 char num_buf
[SCM_INTBUFLEN
];
1342 scm_lfwrite_unlocked (num_buf
, scm_iint2str (n
, radix
, num_buf
), port
);
1346 scm_uintprint (scm_t_uintmax n
, int radix
, SCM port
)
1348 char num_buf
[SCM_INTBUFLEN
];
1349 scm_lfwrite_unlocked (num_buf
, scm_iuint2str (n
, radix
, num_buf
), port
);
1352 /* Print an object of unrecognized type.
1356 scm_ipruk (char *hdr
, SCM ptr
, SCM port
)
1358 scm_puts_unlocked ("#<unknown-", port
);
1359 scm_puts_unlocked (hdr
, port
);
1360 if (1) /* (scm_in_heap_p (ptr)) */ /* FIXME */
1362 scm_puts_unlocked (" (0x", port
);
1363 scm_uintprint (SCM_CELL_WORD_0 (ptr
), 16, port
);
1364 scm_puts_unlocked (" . 0x", port
);
1365 scm_uintprint (SCM_CELL_WORD_1 (ptr
), 16, port
);
1366 scm_puts_unlocked (") @", port
);
1368 scm_puts_unlocked (" 0x", port
);
1369 scm_uintprint (SCM_UNPACK (ptr
), 16, port
);
1370 scm_putc_unlocked ('>', port
);
1377 scm_iprlist (char *hdr
, SCM exp
, int tlr
, SCM port
, scm_print_state
*pstate
)
1379 register SCM hare
, tortoise
;
1380 long floor
= pstate
->top
- 2;
1381 scm_puts_unlocked (hdr
, port
);
1384 goto fancy_printing
;
1386 /* Run a hare and tortoise so that total time complexity will be
1387 O(depth * N) instead of O(N^2). */
1388 hare
= SCM_CDR (exp
);
1390 while (scm_is_pair (hare
))
1392 if (scm_is_eq (hare
, tortoise
))
1393 goto fancy_printing
;
1394 hare
= SCM_CDR (hare
);
1395 if (!scm_is_pair (hare
))
1397 hare
= SCM_CDR (hare
);
1398 tortoise
= SCM_CDR (tortoise
);
1401 /* No cdr cycles intrinsic to this list */
1402 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1403 for (exp
= SCM_CDR (exp
); scm_is_pair (exp
); exp
= SCM_CDR (exp
))
1407 for (i
= floor
; i
>= 0; --i
)
1408 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), exp
))
1410 PUSH_REF (pstate
, exp
);
1411 scm_putc_unlocked (' ', port
);
1413 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1415 if (!SCM_NULL_OR_NIL_P (exp
))
1417 scm_puts_unlocked (" . ", port
);
1418 scm_iprin1 (exp
, port
, pstate
);
1422 scm_putc_unlocked (tlr
, port
);
1423 pstate
->top
= floor
+ 2;
1428 long n
= pstate
->length
;
1430 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1431 exp
= SCM_CDR (exp
); --n
;
1432 for (; scm_is_pair (exp
); exp
= SCM_CDR (exp
))
1434 register unsigned long i
;
1436 for (i
= 0; i
< pstate
->top
; ++i
)
1437 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), exp
))
1443 scm_puts_unlocked (" ...", port
);
1449 PUSH_REF(pstate
, exp
);
1450 ++pstate
->list_offset
;
1451 scm_putc_unlocked (' ', port
);
1453 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1456 if (!SCM_NULL_OR_NIL_P (exp
))
1458 scm_puts_unlocked (" . ", port
);
1459 scm_iprin1 (exp
, port
, pstate
);
1462 pstate
->list_offset
-= pstate
->top
- floor
- 2;
1466 pstate
->list_offset
-= pstate
->top
- floor
- 2;
1469 scm_puts_unlocked (" . ", port
);
1470 print_circref (port
, pstate
, exp
);
1477 scm_valid_oport_value_p (SCM val
)
1479 return (SCM_OPOUTPORTP (val
)
1480 || (SCM_PORT_WITH_PS_P (val
)
1481 && SCM_OPOUTPORTP (SCM_PORT_WITH_PS_PORT (val
))));
1484 /* SCM_GPROC(s_write, "write", 1, 1, 0, scm_write, g_write); */
1487 scm_write (SCM obj
, SCM port
)
1489 if (SCM_UNBNDP (port
))
1490 port
= scm_current_output_port ();
1492 SCM_ASSERT (scm_valid_oport_value_p (port
), port
, SCM_ARG2
, s_write
);
1494 scm_dynwind_begin (0);
1495 scm_dynwind_lock_port (SCM_COERCE_OUTPORT (port
));
1496 scm_prin1 (obj
, port
, 1);
1499 return SCM_UNSPECIFIED
;
1503 /* SCM_GPROC(s_display, "display", 1, 1, 0, scm_display, g_display); */
1506 scm_display (SCM obj
, SCM port
)
1508 if (SCM_UNBNDP (port
))
1509 port
= scm_current_output_port ();
1511 SCM_ASSERT (scm_valid_oport_value_p (port
), port
, SCM_ARG2
, s_display
);
1513 scm_dynwind_begin (0);
1514 scm_dynwind_lock_port (SCM_COERCE_OUTPORT (port
));
1515 scm_prin1 (obj
, port
, 0);
1518 return SCM_UNSPECIFIED
;
1522 SCM_DEFINE (scm_simple_format
, "simple-format", 2, 0, 1,
1523 (SCM destination
, SCM message
, SCM args
),
1524 "Write @var{message} to @var{destination}, defaulting to\n"
1525 "the current output port.\n"
1526 "@var{message} can contain @code{~A} (was @code{%s}) and\n"
1527 "@code{~S} (was @code{%S}) escapes. When printed,\n"
1528 "the escapes are replaced with corresponding members of\n"
1530 "@code{~A} formats using @code{display} and @code{~S} formats\n"
1531 "using @code{write}.\n"
1532 "If @var{destination} is @code{#t}, then use the current output\n"
1533 "port, if @var{destination} is @code{#f}, then return a string\n"
1534 "containing the formatted text. Does not add a trailing newline.")
1535 #define FUNC_NAME s_scm_simple_format
1537 SCM port
, answer
= SCM_UNSPECIFIED
;
1538 int fReturnString
= 0;
1540 size_t start
, p
, end
;
1542 if (scm_is_eq (destination
, SCM_BOOL_T
))
1544 destination
= port
= scm_current_output_port ();
1546 else if (scm_is_false (destination
))
1549 port
= scm_mkstrport (SCM_INUM0
, SCM_BOOL_F
,
1550 SCM_OPN
| SCM_WRTNG
,
1556 SCM_VALIDATE_OPORT_VALUE (1, destination
);
1557 port
= SCM_COERCE_OUTPORT (destination
);
1559 SCM_VALIDATE_STRING (2, message
);
1560 SCM_VALIDATE_REST_ARGUMENT (args
);
1564 end
= scm_i_string_length (message
);
1565 for (p
= start
; p
!= end
; ++p
)
1566 if (scm_i_string_ref (message
, p
) == '~')
1571 switch (scm_i_string_ref (message
, p
))
1580 scm_lfwrite_substr (message
, start
, p
, port
);
1584 scm_lfwrite_substr (message
, start
, p
- 1, port
);
1589 SCM_MISC_ERROR ("FORMAT: Unsupported format option ~~~A - use (ice-9 format) instead",
1590 scm_list_1 (SCM_MAKE_CHAR (scm_i_string_ref (message
, p
))));
1595 if (!scm_is_pair (args
))
1596 SCM_MISC_ERROR ("FORMAT: Missing argument for ~~~A",
1597 scm_list_1 (SCM_MAKE_CHAR (scm_i_string_ref (message
, p
))));
1599 scm_lfwrite_substr (message
, start
, p
- 1, port
);
1600 /* we pass destination here */
1601 scm_prin1 (SCM_CAR (args
), destination
, writingp
);
1602 args
= SCM_CDR (args
);
1606 scm_lfwrite_substr (message
, start
, p
, port
);
1607 if (!scm_is_eq (args
, SCM_EOL
))
1608 SCM_MISC_ERROR ("FORMAT: ~A superfluous arguments",
1609 scm_list_1 (scm_length (args
)));
1612 answer
= scm_strport_to_string (destination
);
1614 return scm_return_first (answer
, message
);
1619 SCM_DEFINE (scm_newline
, "newline", 0, 1, 0,
1621 "Send a newline to @var{port}.\n"
1622 "If @var{port} is omitted, send to the current output port.")
1623 #define FUNC_NAME s_scm_newline
1625 if (SCM_UNBNDP (port
))
1626 port
= scm_current_output_port ();
1628 SCM_VALIDATE_OPORT_VALUE (1, port
);
1630 scm_putc_unlocked ('\n', SCM_COERCE_OUTPORT (port
));
1631 return SCM_UNSPECIFIED
;
1635 SCM_DEFINE (scm_write_char
, "write-char", 1, 1, 0,
1636 (SCM chr
, SCM port
),
1637 "Send character @var{chr} to @var{port}.")
1638 #define FUNC_NAME s_scm_write_char
1640 if (SCM_UNBNDP (port
))
1641 port
= scm_current_output_port ();
1643 SCM_VALIDATE_CHAR (1, chr
);
1644 SCM_VALIDATE_OPORT_VALUE (2, port
);
1646 port
= SCM_COERCE_OUTPORT (port
);
1647 if (!display_character (SCM_CHAR (chr
), port
,
1648 PORT_CONVERSION_HANDLER (port
)))
1649 scm_encoding_error (__func__
, errno
,
1650 "cannot convert to output locale",
1653 return SCM_UNSPECIFIED
;
1659 /* Call back to Scheme code to do the printing of special objects
1660 * (like structs). SCM_PRINTER_APPLY applies PROC to EXP and a smob
1661 * containing PORT and PSTATE. This object can be used as the port for
1662 * display/write etc to continue the current print chain. The REVEALED
1663 * field of PSTATE is set to true to indicate that the print state has
1664 * escaped to Scheme and thus has to be freed by the GC.
1667 scm_t_bits scm_tc16_port_with_ps
;
1669 /* Print exactly as the port itself would */
1672 port_with_ps_print (SCM obj
, SCM port
, scm_print_state
*pstate
)
1674 obj
= SCM_PORT_WITH_PS_PORT (obj
);
1675 return SCM_PORT_DESCRIPTOR (obj
)->print (obj
, port
, pstate
);
1679 scm_printer_apply (SCM proc
, SCM exp
, SCM port
, scm_print_state
*pstate
)
1681 pstate
->revealed
= 1;
1682 return scm_call_2 (proc
, exp
,
1683 scm_i_port_with_print_state (port
, pstate
->handle
));
1686 SCM_DEFINE (scm_port_with_print_state
, "port-with-print-state", 1, 1, 0,
1687 (SCM port
, SCM pstate
),
1688 "Create a new port which behaves like @var{port}, but with an\n"
1689 "included print state @var{pstate}. @var{pstate} is optional.\n"
1690 "If @var{pstate} isn't supplied and @var{port} already has\n"
1691 "a print state, the old print state is reused.")
1692 #define FUNC_NAME s_scm_port_with_print_state
1694 SCM_VALIDATE_OPORT_VALUE (1, port
);
1695 if (!SCM_UNBNDP (pstate
))
1696 SCM_VALIDATE_PRINTSTATE (2, pstate
);
1697 return scm_i_port_with_print_state (port
, pstate
);
1701 SCM_DEFINE (scm_get_print_state
, "get-print-state", 1, 0, 0,
1703 "Return the print state of the port @var{port}. If @var{port}\n"
1704 "has no associated print state, @code{#f} is returned.")
1705 #define FUNC_NAME s_scm_get_print_state
1707 if (SCM_PORT_WITH_PS_P (port
))
1708 return SCM_PORT_WITH_PS_PS (port
);
1709 if (SCM_OUTPUT_PORT_P (port
))
1711 SCM_WRONG_TYPE_ARG (1, port
);
1722 type
= scm_make_vtable (scm_from_locale_string (SCM_PRINT_STATE_LAYOUT
),
1724 scm_set_struct_vtable_name_x (type
, scm_from_latin1_symbol ("print-state"));
1725 scm_print_state_vtable
= type
;
1727 /* Don't want to bind a wrapper class in GOOPS, so pass 0 as arg1. */
1728 scm_tc16_port_with_ps
= scm_make_smob_type (0, 0);
1729 scm_set_smob_print (scm_tc16_port_with_ps
, port_with_ps_print
);
1731 #include "libguile/print.x"
1733 scm_init_opts (scm_print_options
, scm_print_opts
);
1734 scm_print_opts
[SCM_PRINT_HIGHLIGHT_PREFIX_I
].val
=
1735 SCM_UNPACK (scm_from_locale_string ("{"));
1736 scm_print_opts
[SCM_PRINT_HIGHLIGHT_SUFFIX_I
].val
=
1737 SCM_UNPACK (scm_from_locale_string ("}"));
1738 scm_print_opts
[SCM_PRINT_KEYWORD_STYLE_I
].val
= SCM_UNPACK (sym_reader
);