1 /* Copyright (C) 1995-1999, 2000, 2001, 2002, 2003, 2004, 2006, 2008,
2 * 2009, 2010, 2011, 2012 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/weaks.h"
44 #include "libguile/programs.h"
45 #include "libguile/alist.h"
46 #include "libguile/struct.h"
47 #include "libguile/ports.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'." },
119 SCM_DEFINE (scm_print_options
, "print-options-interface", 0, 1, 0,
121 "Option interface for the print options. Instead of using\n"
122 "this procedure directly, use the procedures\n"
123 "@code{print-enable}, @code{print-disable}, @code{print-set!}\n"
124 "and @code{print-options}.")
125 #define FUNC_NAME s_scm_print_options
127 SCM ans
= scm_options (setting
,
135 /* {Printing of Scheme Objects}
138 /* Detection of circular references.
140 * Due to other constraints in the implementation, this code has bad
141 * time complexity (O (depth * N)), The printer code can be
142 * rewritten to be O(N).
144 #define PUSH_REF(pstate, obj) \
147 PSTATE_STACK_SET (pstate, pstate->top, obj); \
149 if (pstate->top == pstate->ceiling) \
150 grow_ref_stack (pstate); \
153 #define ENTER_NESTED_DATA(pstate, obj, label) \
156 register unsigned long i; \
157 for (i = 0; i < pstate->top; ++i) \
158 if (scm_is_eq (PSTATE_STACK_REF (pstate, i), (obj))) \
160 if (pstate->fancyp) \
162 if (pstate->top - pstate->list_offset >= pstate->level) \
164 scm_putc ('#', port); \
168 PUSH_REF(pstate, obj); \
171 #define EXIT_NESTED_DATA(pstate) \
175 PSTATE_STACK_SET (pstate, pstate->top, SCM_UNDEFINED); \
179 SCM scm_print_state_vtable
= SCM_BOOL_F
;
180 static SCM print_state_pool
= SCM_EOL
;
181 scm_i_pthread_mutex_t print_state_mutex
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
183 #ifdef GUILE_DEBUG /* Used for debugging purposes */
185 SCM_DEFINE (scm_current_pstate
, "current-pstate", 0, 0, 0,
187 "Return the current-pstate -- the car of the\n"
188 "@code{print_state_pool}. @code{current-pstate} is only\n"
189 "included in @code{--enable-guile-debug} builds.")
190 #define FUNC_NAME s_scm_current_pstate
192 if (!scm_is_null (print_state_pool
))
193 return SCM_CAR (print_state_pool
);
201 #define PSTATE_SIZE 50L
204 make_print_state (void)
207 = scm_make_struct (scm_print_state_vtable
, SCM_INUM0
, SCM_EOL
);
208 scm_print_state
*pstate
= SCM_PRINT_STATE (print_state
);
209 pstate
->ref_vect
= scm_c_make_vector (PSTATE_SIZE
, SCM_UNDEFINED
);
210 pstate
->ceiling
= SCM_SIMPLE_VECTOR_LENGTH (pstate
->ref_vect
);
211 pstate
->highlight_objects
= SCM_EOL
;
216 scm_make_print_state ()
218 SCM answer
= SCM_BOOL_F
;
220 /* First try to allocate a print state from the pool */
221 scm_i_pthread_mutex_lock (&print_state_mutex
);
222 if (!scm_is_null (print_state_pool
))
224 answer
= SCM_CAR (print_state_pool
);
225 print_state_pool
= SCM_CDR (print_state_pool
);
227 scm_i_pthread_mutex_unlock (&print_state_mutex
);
229 return scm_is_false (answer
) ? make_print_state () : answer
;
233 scm_free_print_state (SCM print_state
)
236 scm_print_state
*pstate
= SCM_PRINT_STATE (print_state
);
237 /* Cleanup before returning print state to pool.
238 * It is better to do it here. Doing it in scm_prin1
239 * would cost more since that function is called much more
243 pstate
->revealed
= 0;
244 pstate
->highlight_objects
= SCM_EOL
;
245 scm_i_pthread_mutex_lock (&print_state_mutex
);
246 handle
= scm_cons (print_state
, print_state_pool
);
247 print_state_pool
= handle
;
248 scm_i_pthread_mutex_unlock (&print_state_mutex
);
252 scm_i_port_with_print_state (SCM port
, SCM print_state
)
254 if (SCM_UNBNDP (print_state
))
256 if (SCM_PORT_WITH_PS_P (port
))
259 print_state
= scm_make_print_state ();
260 /* port does not need to be coerced since it doesn't have ps */
263 port
= SCM_COERCE_OUTPORT (port
);
264 SCM_RETURN_NEWSMOB (scm_tc16_port_with_ps
,
265 SCM_UNPACK (scm_cons (port
, print_state
)));
269 grow_ref_stack (scm_print_state
*pstate
)
271 SCM old_vect
= pstate
->ref_vect
;
272 size_t old_size
= SCM_SIMPLE_VECTOR_LENGTH (old_vect
);
273 size_t new_size
= 2 * pstate
->ceiling
;
274 SCM new_vect
= scm_c_make_vector (new_size
, SCM_UNDEFINED
);
277 for (i
= 0; i
!= old_size
; ++i
)
278 SCM_SIMPLE_VECTOR_SET (new_vect
, i
, SCM_SIMPLE_VECTOR_REF (old_vect
, i
));
280 pstate
->ref_vect
= new_vect
;
281 pstate
->ceiling
= new_size
;
284 #define PSTATE_STACK_REF(p,i) SCM_SIMPLE_VECTOR_REF((p)->ref_vect, (i))
285 #define PSTATE_STACK_SET(p,i,v) SCM_SIMPLE_VECTOR_SET((p)->ref_vect, (i), (v))
288 print_circref (SCM port
, scm_print_state
*pstate
, SCM ref
)
291 long self
= pstate
->top
- 1;
293 if (scm_is_pair (PSTATE_STACK_REF (pstate
, i
)))
297 if (!scm_is_pair (PSTATE_STACK_REF (pstate
, i
-1))
298 || !scm_is_eq (SCM_CDR (PSTATE_STACK_REF (pstate
, i
-1)),
299 SCM_CDR (PSTATE_STACK_REF (pstate
, i
))))
305 for (i
= pstate
->top
- 1; 1; --i
)
306 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), ref
))
308 scm_putc ('#', port
);
309 scm_intprint (i
- self
, 10, port
);
310 scm_putc ('#', port
);
313 /* Print the name of a symbol. */
316 quote_keywordish_symbols (void)
318 SCM option
= SCM_PRINT_KEYWORD_STYLE
;
320 if (scm_is_false (option
))
322 if (scm_is_eq (option
, sym_reader
))
323 return scm_is_true (SCM_PACK (SCM_KEYWORD_STYLE
));
327 #define INITIAL_IDENTIFIER_MASK \
328 (UC_CATEGORY_MASK_Lu | UC_CATEGORY_MASK_Ll | UC_CATEGORY_MASK_Lt \
329 | UC_CATEGORY_MASK_Lm | UC_CATEGORY_MASK_Lo | UC_CATEGORY_MASK_Mn \
330 | UC_CATEGORY_MASK_Nl | UC_CATEGORY_MASK_No | UC_CATEGORY_MASK_Pd \
331 | UC_CATEGORY_MASK_Pc | UC_CATEGORY_MASK_Po | UC_CATEGORY_MASK_Sc \
332 | UC_CATEGORY_MASK_Sm | UC_CATEGORY_MASK_Sk | UC_CATEGORY_MASK_So \
333 | UC_CATEGORY_MASK_Co)
335 #define SUBSEQUENT_IDENTIFIER_MASK \
336 (INITIAL_IDENTIFIER_MASK \
337 | UC_CATEGORY_MASK_Nd | UC_CATEGORY_MASK_Mc | UC_CATEGORY_MASK_Me)
340 symbol_has_extended_read_syntax (SCM sym
)
342 size_t pos
, len
= scm_i_symbol_length (sym
);
345 /* The empty symbol. */
349 c
= scm_i_symbol_ref (sym
, 0);
351 /* Single dot; conflicts with dotted-pair notation. */
352 if (len
== 1 && c
== '.')
355 /* Other initial-character constraints. */
356 if (c
== '\'' || c
== '`' || c
== ',' || c
== '"' || c
== ';' || c
== '#')
359 /* Keywords can be identified by trailing colons too. */
360 if (c
== ':' || scm_i_symbol_ref (sym
, len
- 1) == ':')
361 return quote_keywordish_symbols ();
363 /* Number-ish symbols. */
364 if (scm_is_true (scm_i_string_to_number (scm_symbol_to_string (sym
), 10)))
367 /* Other disallowed first characters. */
368 if (!uc_is_general_category_withtable (c
, INITIAL_IDENTIFIER_MASK
))
371 /* Otherwise, any character that's in the identifier category mask is
372 fine to pass through as-is, provided it's not one of the ASCII
373 delimiters like `;'. */
374 for (pos
= 1; pos
< len
; pos
++)
376 c
= scm_i_symbol_ref (sym
, pos
);
377 if (!uc_is_general_category_withtable (c
, SUBSEQUENT_IDENTIFIER_MASK
))
379 else if (c
== '"' || c
== ';' || c
== '#')
387 print_normal_symbol (SCM sym
, SCM port
)
389 scm_display (scm_symbol_to_string (sym
), port
);
393 print_extended_symbol (SCM sym
, SCM port
)
396 scm_t_string_failed_conversion_handler strategy
;
398 len
= scm_i_symbol_length (sym
);
399 strategy
= PORT_CONVERSION_HANDLER (port
);
401 scm_lfwrite ("#{", 2, port
);
403 for (pos
= 0; pos
< len
; pos
++)
405 scm_t_wchar c
= scm_i_symbol_ref (sym
, pos
);
407 if (uc_is_general_category_withtable (c
,
408 SUBSEQUENT_IDENTIFIER_MASK
409 | UC_CATEGORY_MASK_Zs
))
411 if (!display_character (c
, port
, strategy
))
412 scm_encoding_error ("print_extended_symbol", errno
,
413 "cannot convert to output locale",
414 port
, SCM_MAKE_CHAR (c
));
418 display_string ("\\x", 1, 2, port
, iconveh_question_mark
);
419 scm_intprint (c
, 16, port
);
420 display_character (';', port
, iconveh_question_mark
);
424 scm_lfwrite ("}#", 2, port
);
427 /* FIXME: allow R6RS hex escapes instead of #{...}#. */
429 scm_i_print_symbol_name (SCM sym
, SCM port
)
431 if (symbol_has_extended_read_syntax (sym
))
432 print_extended_symbol (sym
, port
);
434 print_normal_symbol (sym
, port
);
438 scm_print_symbol_name (const char *str
, size_t len
, SCM port
)
440 SCM symbol
= scm_from_locale_symboln (str
, len
);
441 scm_i_print_symbol_name (symbol
, port
);
444 /* Print generally. Handles both write and display according to PSTATE.
446 SCM_GPROC(s_write
, "write", 1, 1, 0, scm_write
, g_write
);
447 SCM_GPROC(s_display
, "display", 1, 1, 0, scm_display
, g_display
);
449 static void iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
);
452 /* Print a character as an octal or hex escape. */
453 #define PRINT_CHAR_ESCAPE(i, port) \
456 if (!SCM_R6RS_ESCAPES_P) \
457 scm_intprint (i, 8, port); \
460 scm_puts ("x", port); \
461 scm_intprint (i, 16, port); \
468 scm_iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
)
471 && scm_is_true (scm_memq (exp
, pstate
->highlight_objects
)))
473 scm_display (SCM_PRINT_HIGHLIGHT_PREFIX
, port
);
474 iprin1 (exp
, port
, pstate
);
475 scm_display (SCM_PRINT_HIGHLIGHT_SUFFIX
, port
);
478 iprin1 (exp
, port
, pstate
);
482 iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
)
484 switch (SCM_ITAG3 (exp
))
488 /* These tc3 tags should never occur in an immediate value. They are
489 * only used in cell types of non-immediates, i. e. the value returned
490 * by SCM_CELL_TYPE (exp) can use these tags.
492 scm_ipruk ("immediate", exp
, port
);
496 scm_intprint (SCM_I_INUM (exp
), 10, port
);
501 if (SCM_WRITINGP (pstate
))
502 write_character (SCM_CHAR (exp
), port
, 0);
505 if (!display_character (SCM_CHAR (exp
), port
,
506 PORT_CONVERSION_HANDLER (port
)))
507 scm_encoding_error (__func__
, errno
,
508 "cannot convert to output locale",
512 else if (SCM_IFLAGP (exp
)
513 && ((size_t) SCM_IFLAGNUM (exp
) < (sizeof iflagnames
/ sizeof (char *))))
515 scm_puts (iflagnames
[SCM_IFLAGNUM (exp
)], port
);
519 /* unknown immediate value */
520 scm_ipruk ("immediate", exp
, port
);
524 switch (SCM_TYP7 (exp
))
528 ENTER_NESTED_DATA (pstate
, exp
, circref
);
529 if (SCM_OBJ_CLASS_FLAGS (exp
) & SCM_CLASSF_GOOPS
)
531 SCM pwps
, print
= pstate
->writingp
? g_write
: g_display
;
532 if (SCM_UNPACK (print
) == 0)
534 pwps
= scm_i_port_with_print_state (port
, pstate
->handle
);
535 pstate
->revealed
= 1;
536 scm_call_generic_2 (print
, exp
, pwps
);
541 scm_print_struct (exp
, port
, pstate
);
543 EXIT_NESTED_DATA (pstate
);
546 case scm_tcs_cons_imcar
:
547 case scm_tcs_cons_nimcar
:
548 ENTER_NESTED_DATA (pstate
, exp
, circref
);
549 scm_iprlist ("(", exp
, ')', port
, pstate
);
550 EXIT_NESTED_DATA (pstate
);
553 print_circref (port
, pstate
, exp
);
556 switch SCM_TYP16 (exp
) {
558 scm_bigprint (exp
, port
, pstate
);
561 scm_print_real (exp
, port
, pstate
);
563 case scm_tc16_complex
:
564 scm_print_complex (exp
, port
, pstate
);
566 case scm_tc16_fraction
:
567 scm_i_print_fraction (exp
, port
, pstate
);
572 if (SCM_WRITINGP (pstate
))
576 display_character ('"', port
, iconveh_question_mark
);
577 len
= scm_i_string_length (exp
);
578 for (i
= 0; i
< len
; ++i
)
579 write_character (scm_i_string_ref (exp
, i
), port
, 1);
581 display_character ('"', port
, iconveh_question_mark
);
582 scm_remember_upto_here_1 (exp
);
588 len
= scm_i_string_length (exp
);
589 printed
= display_string (scm_i_string_data (exp
),
590 scm_i_is_narrow_string (exp
),
592 PORT_CONVERSION_HANDLER (port
));
593 if (SCM_UNLIKELY (printed
< len
))
594 scm_encoding_error (__func__
, errno
,
595 "cannot convert to output locale",
596 port
, scm_c_string_ref (exp
, printed
));
599 scm_remember_upto_here_1 (exp
);
602 if (scm_i_symbol_is_interned (exp
))
604 scm_i_print_symbol_name (exp
, port
);
605 scm_remember_upto_here_1 (exp
);
609 scm_puts ("#<uninterned-symbol ", port
);
610 scm_i_print_symbol_name (exp
, port
);
611 scm_putc (' ', port
);
612 scm_uintprint (SCM_UNPACK (exp
), 16, port
);
613 scm_putc ('>', port
);
616 case scm_tc7_variable
:
617 scm_i_variable_print (exp
, port
, pstate
);
619 case scm_tc7_program
:
620 scm_i_program_print (exp
, port
, pstate
);
622 case scm_tc7_pointer
:
623 scm_i_pointer_print (exp
, port
, pstate
);
625 case scm_tc7_hashtable
:
626 scm_i_hashtable_print (exp
, port
, pstate
);
629 scm_i_fluid_print (exp
, port
, pstate
);
631 case scm_tc7_dynamic_state
:
632 scm_i_dynamic_state_print (exp
, port
, pstate
);
635 scm_i_frame_print (exp
, port
, pstate
);
637 case scm_tc7_objcode
:
638 scm_i_objcode_print (exp
, port
, pstate
);
641 scm_i_vm_print (exp
, port
, pstate
);
643 case scm_tc7_vm_cont
:
644 scm_i_vm_cont_print (exp
, port
, pstate
);
647 scm_i_prompt_print (exp
, port
, pstate
);
649 case scm_tc7_with_fluids
:
650 scm_i_with_fluids_print (exp
, port
, pstate
);
653 ENTER_NESTED_DATA (pstate
, exp
, circref
);
654 scm_i_print_array (exp
, port
, pstate
);
655 EXIT_NESTED_DATA (pstate
);
657 case scm_tc7_bytevector
:
658 scm_i_print_bytevector (exp
, port
, pstate
);
660 case scm_tc7_bitvector
:
661 scm_i_print_bitvector (exp
, port
, pstate
);
664 ENTER_NESTED_DATA (pstate
, exp
, circref
);
665 if (SCM_IS_WHVEC (exp
))
666 scm_puts ("#wh(", port
);
668 scm_puts ("#w(", port
);
669 goto common_vector_printer
;
671 ENTER_NESTED_DATA (pstate
, exp
, circref
);
672 scm_puts ("#(", port
);
673 common_vector_printer
:
676 long last
= SCM_SIMPLE_VECTOR_LENGTH (exp
) - 1;
679 && SCM_SIMPLE_VECTOR_LENGTH (exp
) > pstate
->length
)
681 last
= pstate
->length
- 1;
684 if (SCM_I_WVECTP (exp
))
686 /* Elements of weak vectors may not be accessed via the
687 `SIMPLE_VECTOR_REF ()' macro. */
688 for (i
= 0; i
< last
; ++i
)
690 scm_iprin1 (scm_c_vector_ref (exp
, i
),
692 scm_putc (' ', port
);
697 for (i
= 0; i
< last
; ++i
)
699 scm_iprin1 (SCM_SIMPLE_VECTOR_REF (exp
, i
), port
, pstate
);
700 scm_putc (' ', port
);
707 scm_iprin1 (scm_c_vector_ref (exp
, i
), port
, pstate
);
710 scm_puts (" ...", port
);
711 scm_putc (')', port
);
713 EXIT_NESTED_DATA (pstate
);
717 register long i
= SCM_PTOBNUM (exp
);
719 && scm_ptobs
[i
].print
720 && (scm_ptobs
[i
].print
) (exp
, port
, pstate
))
725 ENTER_NESTED_DATA (pstate
, exp
, circref
);
726 SCM_SMOB_DESCRIPTOR (exp
).print (exp
, port
, pstate
);
727 EXIT_NESTED_DATA (pstate
);
730 /* case scm_tcs_closures: */
732 scm_ipruk ("type", exp
, port
);
737 /* Print states are necessary for circular reference safe printing.
738 * They are also expensive to allocate. Therefore print states are
739 * kept in a pool so that they can be reused.
742 /* The PORT argument can also be a print-state/port pair, which will
743 * then be used instead of allocating a new print state. This is
744 * useful for continuing a chain of print calls from Scheme. */
747 scm_prin1 (SCM exp
, SCM port
, int writingp
)
749 SCM handle
= SCM_BOOL_F
; /* Will GC protect the handle whilst unlinked */
751 scm_print_state
*pstate
;
754 /* If PORT is a print-state/port pair, use that. Else create a new
757 if (SCM_PORT_WITH_PS_P (port
))
759 pstate_scm
= SCM_PORT_WITH_PS_PS (port
);
760 port
= SCM_PORT_WITH_PS_PORT (port
);
764 /* First try to allocate a print state from the pool */
765 scm_i_pthread_mutex_lock (&print_state_mutex
);
766 if (!scm_is_null (print_state_pool
))
768 handle
= print_state_pool
;
769 print_state_pool
= SCM_CDR (print_state_pool
);
771 scm_i_pthread_mutex_unlock (&print_state_mutex
);
772 if (scm_is_false (handle
))
773 handle
= scm_list_1 (make_print_state ());
774 pstate_scm
= SCM_CAR (handle
);
777 pstate
= SCM_PRINT_STATE (pstate_scm
);
778 old_writingp
= pstate
->writingp
;
779 pstate
->writingp
= writingp
;
780 scm_iprin1 (exp
, port
, pstate
);
781 pstate
->writingp
= old_writingp
;
783 /* Return print state to pool if it has been created above and
784 hasn't escaped to Scheme. */
786 if (scm_is_true (handle
) && !pstate
->revealed
)
788 scm_i_pthread_mutex_lock (&print_state_mutex
);
789 SCM_SETCDR (handle
, print_state_pool
);
790 print_state_pool
= handle
;
791 scm_i_pthread_mutex_unlock (&print_state_mutex
);
795 /* Convert codepoint CH to UTF-8 and store the result in UTF8. Return
796 the number of bytes of the UTF-8-encoded string. */
798 codepoint_to_utf8 (scm_t_wchar ch
, scm_t_uint8 utf8
[4])
801 scm_t_uint32 codepoint
;
803 codepoint
= (scm_t_uint32
) ch
;
805 if (codepoint
<= 0x7f)
808 utf8
[0] = (scm_t_uint8
) codepoint
;
810 else if (codepoint
<= 0x7ffUL
)
813 utf8
[0] = 0xc0 | (codepoint
>> 6);
814 utf8
[1] = 0x80 | (codepoint
& 0x3f);
816 else if (codepoint
<= 0xffffUL
)
819 utf8
[0] = 0xe0 | (codepoint
>> 12);
820 utf8
[1] = 0x80 | ((codepoint
>> 6) & 0x3f);
821 utf8
[2] = 0x80 | (codepoint
& 0x3f);
826 utf8
[0] = 0xf0 | (codepoint
>> 18);
827 utf8
[1] = 0x80 | ((codepoint
>> 12) & 0x3f);
828 utf8
[2] = 0x80 | ((codepoint
>> 6) & 0x3f);
829 utf8
[3] = 0x80 | (codepoint
& 0x3f);
835 #define STR_REF(s, x) \
837 ? (scm_t_wchar) ((unsigned char *) (s))[x] \
838 : ((scm_t_wchar *) (s))[x])
840 /* Write STR to PORT as UTF-8. STR is a LEN-codepoint string; it is
841 narrow if NARROW_P is true, wide otherwise. Return LEN. */
843 display_string_as_utf8 (const void *str
, int narrow_p
, size_t len
,
848 while (len
> printed
)
851 char *input
, utf8_buf
[256];
853 /* Convert STR to UTF-8. */
854 for (i
= printed
, utf8_len
= 0, input
= utf8_buf
;
855 i
< len
&& utf8_len
+ 4 < sizeof (utf8_buf
);
858 utf8_len
+= codepoint_to_utf8 (STR_REF (str
, i
),
859 (scm_t_uint8
*) input
);
860 input
= utf8_buf
+ utf8_len
;
863 /* INPUT was successfully converted, entirely; print the
865 scm_lfwrite (utf8_buf
, utf8_len
, port
);
866 printed
+= i
- printed
;
869 assert (printed
== len
);
874 /* Convert STR through PORT's output conversion descriptor and write the
875 output to PORT. Return the number of codepoints written. */
877 display_string_using_iconv (const void *str
, int narrow_p
, size_t len
,
879 scm_t_string_failed_conversion_handler strategy
)
884 pt
= SCM_PTAB_ENTRY (port
);
888 while (len
> printed
)
890 size_t done
, utf8_len
, input_left
, output_left
, i
;
891 size_t codepoints_read
, output_len
;
892 char *input
, *output
;
893 char utf8_buf
[256], encoded_output
[256];
896 /* Convert STR to UTF-8. */
897 for (i
= printed
, utf8_len
= 0, input
= utf8_buf
;
898 i
< len
&& utf8_len
+ 4 < sizeof (utf8_buf
);
901 offsets
[utf8_len
] = i
;
902 utf8_len
+= codepoint_to_utf8 (STR_REF (str
, i
),
903 (scm_t_uint8
*) input
);
904 input
= utf8_buf
+ utf8_len
;
908 input_left
= utf8_len
;
910 output
= encoded_output
;
911 output_left
= sizeof (encoded_output
);
913 done
= iconv (pt
->output_cd
, &input
, &input_left
,
914 &output
, &output_left
);
916 output_len
= sizeof (encoded_output
) - output_left
;
918 if (SCM_UNLIKELY (done
== (size_t) -1))
920 int errno_save
= errno
;
922 /* Reset the `iconv' state. */
923 iconv (pt
->output_cd
, NULL
, NULL
, NULL
, NULL
);
925 /* Print the OUTPUT_LEN bytes successfully converted. */
926 scm_lfwrite (encoded_output
, output_len
, port
);
928 /* See how many input codepoints these OUTPUT_LEN bytes
930 codepoints_read
= offsets
[input
- utf8_buf
] - printed
;
931 printed
+= codepoints_read
;
933 if (errno_save
== EILSEQ
&&
934 strategy
!= SCM_FAILED_CONVERSION_ERROR
)
936 /* Conversion failed somewhere in INPUT and we want to
937 escape or substitute the offending input character. */
939 if (strategy
== SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
)
943 /* Find CH, the offending codepoint, and escape it. */
944 ch
= STR_REF (str
, offsets
[input
- utf8_buf
]);
945 write_character_escaped (ch
, 1, port
);
948 /* STRATEGY is `SCM_FAILED_CONVERSION_QUESTION_MARK'. */
949 display_string ("?", 1, 1, port
, strategy
);
954 /* Something bad happened that we can't handle: bail out. */
959 /* INPUT was successfully converted, entirely; print the
961 scm_lfwrite (encoded_output
, output_len
, port
);
962 codepoints_read
= i
- printed
;
963 printed
+= codepoints_read
;
972 /* Display the LEN codepoints in STR to PORT according to STRATEGY;
973 return the number of codepoints successfully displayed. If NARROW_P,
974 then STR is interpreted as a sequence of `char', denoting a Latin-1
975 string; otherwise it's interpreted as a sequence of
978 display_string (const void *str
, int narrow_p
,
979 size_t len
, SCM port
,
980 scm_t_string_failed_conversion_handler strategy
)
985 pt
= SCM_PTAB_ENTRY (port
);
987 if (pt
->output_cd
== (iconv_t
) -1)
988 /* Initialize the conversion descriptors, if needed. */
989 scm_i_set_port_encoding_x (port
, pt
->encoding
);
991 /* FIXME: In 2.1, add a flag to determine whether a port is UTF-8. */
992 if (pt
->output_cd
== (iconv_t
) -1)
993 return display_string_as_utf8 (str
, narrow_p
, len
, port
);
995 return display_string_using_iconv (str
, narrow_p
, len
,
999 /* Attempt to display CH to PORT according to STRATEGY. Return non-zero
1000 if CH was successfully displayed, zero otherwise (e.g., if it was not
1001 representable in PORT's encoding.) */
1003 display_character (scm_t_wchar ch
, SCM port
,
1004 scm_t_string_failed_conversion_handler strategy
)
1006 return display_string (&ch
, 0, 1, port
, strategy
) == 1;
1009 /* Attempt to pretty-print CH, a combining character, to PORT. Return
1010 zero upon failure, non-zero otherwise. The idea is to print CH above
1011 a dotted circle to make it more visible. */
1013 write_combining_character (scm_t_wchar ch
, SCM port
)
1017 str
[0] = SCM_CODEPOINT_DOTTED_CIRCLE
;
1020 return display_string (str
, 0, 2, port
, iconveh_error
) == 2;
1023 /* Write CH to PORT in its escaped form, using the string escape syntax
1024 if STRING_ESCAPES_P is non-zero. */
1026 write_character_escaped (scm_t_wchar ch
, int string_escapes_p
, SCM port
)
1028 if (string_escapes_p
)
1030 /* Represent CH using the in-string escape syntax. */
1032 static const char hex
[] = "0123456789abcdef";
1033 static const char escapes
[7] = "abtnvfr";
1036 if (ch
>= 0x07 && ch
<= 0x0D && ch
!= 0x0A)
1038 /* Use special escapes for some C0 controls. */
1040 buf
[1] = escapes
[ch
- 0x07];
1041 scm_lfwrite (buf
, 2, port
);
1043 else if (!SCM_R6RS_ESCAPES_P
)
1049 buf
[2] = hex
[ch
/ 16];
1050 buf
[3] = hex
[ch
% 16];
1051 scm_lfwrite (buf
, 4, port
);
1053 else if (ch
<= 0xFFFF)
1057 buf
[2] = hex
[(ch
& 0xF000) >> 12];
1058 buf
[3] = hex
[(ch
& 0xF00) >> 8];
1059 buf
[4] = hex
[(ch
& 0xF0) >> 4];
1060 buf
[5] = hex
[(ch
& 0xF)];
1061 scm_lfwrite (buf
, 6, port
);
1063 else if (ch
> 0xFFFF)
1067 buf
[2] = hex
[(ch
& 0xF00000) >> 20];
1068 buf
[3] = hex
[(ch
& 0xF0000) >> 16];
1069 buf
[4] = hex
[(ch
& 0xF000) >> 12];
1070 buf
[5] = hex
[(ch
& 0xF00) >> 8];
1071 buf
[6] = hex
[(ch
& 0xF0) >> 4];
1072 buf
[7] = hex
[(ch
& 0xF)];
1073 scm_lfwrite (buf
, 8, port
);
1078 /* Print an R6RS variable-length hex escape: "\xNNNN;". */
1079 scm_t_wchar ch2
= ch
;
1089 buf
[i
] = hex
[ch2
& 0xF];
1096 scm_lfwrite (buf
+ i
, 9 - i
, port
);
1101 /* Represent CH using the character escape syntax. */
1104 name
= scm_i_charname (SCM_MAKE_CHAR (ch
));
1106 scm_puts (name
, port
);
1108 PRINT_CHAR_ESCAPE (ch
, port
);
1112 /* Write CH to PORT, escaping it if it's non-graphic or not
1113 representable in PORT's encoding. If STRING_ESCAPES_P is true and CH
1114 needs to be escaped, it is escaped using the in-string escape syntax;
1115 otherwise the character escape syntax is used. */
1117 write_character (scm_t_wchar ch
, SCM port
, int string_escapes_p
)
1120 scm_t_string_failed_conversion_handler strategy
;
1122 strategy
= PORT_CONVERSION_HANDLER (port
);
1124 if (string_escapes_p
)
1126 /* Check if CH deserves special treatment. */
1127 if (ch
== '"' || ch
== '\\')
1129 display_character ('\\', port
, iconveh_question_mark
);
1130 display_character (ch
, port
, strategy
);
1133 else if (ch
== '\n' && SCM_PRINT_ESCAPE_NEWLINES_P
)
1135 display_character ('\\', port
, iconveh_question_mark
);
1136 display_character ('n', port
, strategy
);
1139 else if (ch
== ' ' || ch
== '\n')
1141 display_character (ch
, port
, strategy
);
1147 display_string ("#\\", 1, 2, port
, iconveh_question_mark
);
1149 if (uc_combining_class (ch
) != UC_CCC_NR
)
1150 /* Character is a combining character, so attempt to
1152 printed
= write_combining_character (ch
, port
);
1156 && uc_is_general_category_withtable (ch
,
1157 UC_CATEGORY_MASK_L
|
1158 UC_CATEGORY_MASK_M
|
1159 UC_CATEGORY_MASK_N
|
1160 UC_CATEGORY_MASK_P
|
1161 UC_CATEGORY_MASK_S
))
1162 /* CH is graphic; attempt to display it. */
1163 printed
= display_character (ch
, port
, iconveh_error
);
1166 /* CH isn't graphic or cannot be represented in PORT's encoding. */
1167 write_character_escaped (ch
, string_escapes_p
, port
);
1170 /* Display STR to PORT from START inclusive to END exclusive. */
1172 scm_i_display_substring (SCM str
, size_t start
, size_t end
, SCM port
)
1176 size_t len
, printed
;
1178 buf
= scm_i_string_data (str
);
1180 narrow_p
= scm_i_is_narrow_string (str
);
1181 buf
+= start
* (narrow_p
? sizeof (char) : sizeof (scm_t_wchar
));
1183 printed
= display_string (buf
, narrow_p
, end
- start
, port
,
1184 PORT_CONVERSION_HANDLER (port
));
1186 if (SCM_UNLIKELY (printed
< len
))
1187 scm_encoding_error (__func__
, errno
,
1188 "cannot convert to output locale",
1189 port
, scm_c_string_ref (str
, printed
+ start
));
1193 /* Print an integer.
1197 scm_intprint (scm_t_intmax n
, int radix
, SCM port
)
1199 char num_buf
[SCM_INTBUFLEN
];
1200 scm_lfwrite (num_buf
, scm_iint2str (n
, radix
, num_buf
), port
);
1204 scm_uintprint (scm_t_uintmax n
, int radix
, SCM port
)
1206 char num_buf
[SCM_INTBUFLEN
];
1207 scm_lfwrite (num_buf
, scm_iuint2str (n
, radix
, num_buf
), port
);
1210 /* Print an object of unrecognized type.
1214 scm_ipruk (char *hdr
, SCM ptr
, SCM port
)
1216 scm_puts ("#<unknown-", port
);
1217 scm_puts (hdr
, port
);
1218 if (1) /* (scm_in_heap_p (ptr)) */ /* FIXME */
1220 scm_puts (" (0x", port
);
1221 scm_uintprint (SCM_CELL_WORD_0 (ptr
), 16, port
);
1222 scm_puts (" . 0x", port
);
1223 scm_uintprint (SCM_CELL_WORD_1 (ptr
), 16, port
);
1224 scm_puts (") @", port
);
1226 scm_puts (" 0x", port
);
1227 scm_uintprint (SCM_UNPACK (ptr
), 16, port
);
1228 scm_putc ('>', port
);
1235 scm_iprlist (char *hdr
, SCM exp
, int tlr
, SCM port
, scm_print_state
*pstate
)
1237 register SCM hare
, tortoise
;
1238 long floor
= pstate
->top
- 2;
1239 scm_puts (hdr
, port
);
1242 goto fancy_printing
;
1244 /* Run a hare and tortoise so that total time complexity will be
1245 O(depth * N) instead of O(N^2). */
1246 hare
= SCM_CDR (exp
);
1248 while (scm_is_pair (hare
))
1250 if (scm_is_eq (hare
, tortoise
))
1251 goto fancy_printing
;
1252 hare
= SCM_CDR (hare
);
1253 if (!scm_is_pair (hare
))
1255 hare
= SCM_CDR (hare
);
1256 tortoise
= SCM_CDR (tortoise
);
1259 /* No cdr cycles intrinsic to this list */
1260 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1261 for (exp
= SCM_CDR (exp
); scm_is_pair (exp
); exp
= SCM_CDR (exp
))
1265 for (i
= floor
; i
>= 0; --i
)
1266 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), exp
))
1268 PUSH_REF (pstate
, exp
);
1269 scm_putc (' ', port
);
1271 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1273 if (!SCM_NULL_OR_NIL_P (exp
))
1275 scm_puts (" . ", port
);
1276 scm_iprin1 (exp
, port
, pstate
);
1280 scm_putc (tlr
, port
);
1281 pstate
->top
= floor
+ 2;
1286 long n
= pstate
->length
;
1288 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1289 exp
= SCM_CDR (exp
); --n
;
1290 for (; scm_is_pair (exp
); exp
= SCM_CDR (exp
))
1292 register unsigned long i
;
1294 for (i
= 0; i
< pstate
->top
; ++i
)
1295 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), exp
))
1301 scm_puts (" ...", port
);
1307 PUSH_REF(pstate
, exp
);
1308 ++pstate
->list_offset
;
1309 scm_putc (' ', port
);
1311 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1314 if (!SCM_NULL_OR_NIL_P (exp
))
1316 scm_puts (" . ", port
);
1317 scm_iprin1 (exp
, port
, pstate
);
1320 pstate
->list_offset
-= pstate
->top
- floor
- 2;
1324 pstate
->list_offset
-= pstate
->top
- floor
- 2;
1327 scm_puts (" . ", port
);
1328 print_circref (port
, pstate
, exp
);
1335 scm_valid_oport_value_p (SCM val
)
1337 return (SCM_OPOUTPORTP (val
)
1338 || (SCM_PORT_WITH_PS_P (val
)
1339 && SCM_OPOUTPORTP (SCM_PORT_WITH_PS_PORT (val
))));
1342 /* SCM_GPROC(s_write, "write", 1, 1, 0, scm_write, g_write); */
1345 scm_write (SCM obj
, SCM port
)
1347 if (SCM_UNBNDP (port
))
1348 port
= scm_current_output_port ();
1350 SCM_ASSERT (scm_valid_oport_value_p (port
), port
, SCM_ARG2
, s_write
);
1352 scm_prin1 (obj
, port
, 1);
1353 return SCM_UNSPECIFIED
;
1357 /* SCM_GPROC(s_display, "display", 1, 1, 0, scm_display, g_display); */
1360 scm_display (SCM obj
, SCM port
)
1362 if (SCM_UNBNDP (port
))
1363 port
= scm_current_output_port ();
1365 SCM_ASSERT (scm_valid_oport_value_p (port
), port
, SCM_ARG2
, s_display
);
1367 scm_prin1 (obj
, port
, 0);
1368 return SCM_UNSPECIFIED
;
1372 SCM_DEFINE (scm_simple_format
, "simple-format", 2, 0, 1,
1373 (SCM destination
, SCM message
, SCM args
),
1374 "Write @var{message} to @var{destination}, defaulting to\n"
1375 "the current output port.\n"
1376 "@var{message} can contain @code{~A} (was @code{%s}) and\n"
1377 "@code{~S} (was @code{%S}) escapes. When printed,\n"
1378 "the escapes are replaced with corresponding members of\n"
1380 "@code{~A} formats using @code{display} and @code{~S} formats\n"
1381 "using @code{write}.\n"
1382 "If @var{destination} is @code{#t}, then use the current output\n"
1383 "port, if @var{destination} is @code{#f}, then return a string\n"
1384 "containing the formatted text. Does not add a trailing newline.")
1385 #define FUNC_NAME s_scm_simple_format
1387 SCM port
, answer
= SCM_UNSPECIFIED
;
1388 int fReturnString
= 0;
1390 size_t start
, p
, end
;
1392 if (scm_is_eq (destination
, SCM_BOOL_T
))
1394 destination
= port
= scm_current_output_port ();
1396 else if (scm_is_false (destination
))
1399 port
= scm_mkstrport (SCM_INUM0
, SCM_BOOL_F
,
1400 SCM_OPN
| SCM_WRTNG
,
1406 SCM_VALIDATE_OPORT_VALUE (1, destination
);
1407 port
= SCM_COERCE_OUTPORT (destination
);
1409 SCM_VALIDATE_STRING (2, message
);
1410 SCM_VALIDATE_REST_ARGUMENT (args
);
1414 end
= scm_i_string_length (message
);
1415 for (p
= start
; p
!= end
; ++p
)
1416 if (scm_i_string_ref (message
, p
) == '~')
1421 switch (scm_i_string_ref (message
, p
))
1430 scm_lfwrite_substr (message
, start
, p
, port
);
1434 scm_lfwrite_substr (message
, start
, p
- 1, port
);
1439 SCM_MISC_ERROR ("FORMAT: Unsupported format option ~~~A - use (ice-9 format) instead",
1440 scm_list_1 (SCM_MAKE_CHAR (scm_i_string_ref (message
, p
))));
1445 if (!scm_is_pair (args
))
1446 SCM_MISC_ERROR ("FORMAT: Missing argument for ~~~A",
1447 scm_list_1 (SCM_MAKE_CHAR (scm_i_string_ref (message
, p
))));
1449 scm_lfwrite_substr (message
, start
, p
- 1, port
);
1450 /* we pass destination here */
1451 scm_prin1 (SCM_CAR (args
), destination
, writingp
);
1452 args
= SCM_CDR (args
);
1456 scm_lfwrite_substr (message
, start
, p
, port
);
1457 if (!scm_is_eq (args
, SCM_EOL
))
1458 SCM_MISC_ERROR ("FORMAT: ~A superfluous arguments",
1459 scm_list_1 (scm_length (args
)));
1462 answer
= scm_strport_to_string (destination
);
1464 return scm_return_first (answer
, message
);
1469 SCM_DEFINE (scm_newline
, "newline", 0, 1, 0,
1471 "Send a newline to @var{port}.\n"
1472 "If @var{port} is omitted, send to the current output port.")
1473 #define FUNC_NAME s_scm_newline
1475 if (SCM_UNBNDP (port
))
1476 port
= scm_current_output_port ();
1478 SCM_VALIDATE_OPORT_VALUE (1, port
);
1480 scm_putc ('\n', SCM_COERCE_OUTPORT (port
));
1481 return SCM_UNSPECIFIED
;
1485 SCM_DEFINE (scm_write_char
, "write-char", 1, 1, 0,
1486 (SCM chr
, SCM port
),
1487 "Send character @var{chr} to @var{port}.")
1488 #define FUNC_NAME s_scm_write_char
1490 if (SCM_UNBNDP (port
))
1491 port
= scm_current_output_port ();
1493 SCM_VALIDATE_CHAR (1, chr
);
1494 SCM_VALIDATE_OPORT_VALUE (2, port
);
1496 port
= SCM_COERCE_OUTPORT (port
);
1497 if (!display_character (SCM_CHAR (chr
), port
,
1498 PORT_CONVERSION_HANDLER (port
)))
1499 scm_encoding_error (__func__
, errno
,
1500 "cannot convert to output locale",
1503 return SCM_UNSPECIFIED
;
1509 /* Call back to Scheme code to do the printing of special objects
1510 * (like structs). SCM_PRINTER_APPLY applies PROC to EXP and a smob
1511 * containing PORT and PSTATE. This object can be used as the port for
1512 * display/write etc to continue the current print chain. The REVEALED
1513 * field of PSTATE is set to true to indicate that the print state has
1514 * escaped to Scheme and thus has to be freed by the GC.
1517 scm_t_bits scm_tc16_port_with_ps
;
1519 /* Print exactly as the port itself would */
1522 port_with_ps_print (SCM obj
, SCM port
, scm_print_state
*pstate
)
1524 obj
= SCM_PORT_WITH_PS_PORT (obj
);
1525 return scm_ptobs
[SCM_PTOBNUM (obj
)].print (obj
, port
, pstate
);
1529 scm_printer_apply (SCM proc
, SCM exp
, SCM port
, scm_print_state
*pstate
)
1531 pstate
->revealed
= 1;
1532 return scm_call_2 (proc
, exp
,
1533 scm_i_port_with_print_state (port
, pstate
->handle
));
1536 SCM_DEFINE (scm_port_with_print_state
, "port-with-print-state", 1, 1, 0,
1537 (SCM port
, SCM pstate
),
1538 "Create a new port which behaves like @var{port}, but with an\n"
1539 "included print state @var{pstate}. @var{pstate} is optional.\n"
1540 "If @var{pstate} isn't supplied and @var{port} already has\n"
1541 "a print state, the old print state is reused.")
1542 #define FUNC_NAME s_scm_port_with_print_state
1544 SCM_VALIDATE_OPORT_VALUE (1, port
);
1545 if (!SCM_UNBNDP (pstate
))
1546 SCM_VALIDATE_PRINTSTATE (2, pstate
);
1547 return scm_i_port_with_print_state (port
, pstate
);
1551 SCM_DEFINE (scm_get_print_state
, "get-print-state", 1, 0, 0,
1553 "Return the print state of the port @var{port}. If @var{port}\n"
1554 "has no associated print state, @code{#f} is returned.")
1555 #define FUNC_NAME s_scm_get_print_state
1557 if (SCM_PORT_WITH_PS_P (port
))
1558 return SCM_PORT_WITH_PS_PS (port
);
1559 if (SCM_OUTPUT_PORT_P (port
))
1561 SCM_WRONG_TYPE_ARG (1, port
);
1572 scm_gc_register_root (&print_state_pool
);
1573 scm_gc_register_root (&scm_print_state_vtable
);
1574 type
= scm_make_vtable (scm_from_locale_string (SCM_PRINT_STATE_LAYOUT
),
1576 scm_set_struct_vtable_name_x (type
, scm_from_latin1_symbol ("print-state"));
1577 scm_print_state_vtable
= type
;
1579 /* Don't want to bind a wrapper class in GOOPS, so pass 0 as arg1. */
1580 scm_tc16_port_with_ps
= scm_make_smob_type (0, 0);
1581 scm_set_smob_print (scm_tc16_port_with_ps
, port_with_ps_print
);
1583 #include "libguile/print.x"
1585 scm_init_opts (scm_print_options
, scm_print_opts
);
1586 scm_print_opts
[SCM_PRINT_HIGHLIGHT_PREFIX_I
].val
=
1587 SCM_UNPACK (scm_from_locale_string ("{"));
1588 scm_print_opts
[SCM_PRINT_HIGHLIGHT_SUFFIX_I
].val
=
1589 SCM_UNPACK (scm_from_locale_string ("}"));
1590 scm_print_opts
[SCM_PRINT_KEYWORD_STYLE_I
].val
= SCM_UNPACK (sym_reader
);