1 /* Copyright (C) 1995-1999,2000,2001, 2002, 2003, 2004, 2006, 2008, 2009 Free Software Foundation, Inc.
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public License
5 * as published by the Free Software Foundation; either version 3 of
6 * the License, or (at your option) any later version.
8 * This library is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
29 #include "libguile/_scm.h"
30 #include "libguile/chars.h"
31 #include "libguile/continuations.h"
32 #include "libguile/smob.h"
33 #include "libguile/eval.h"
34 #include "libguile/macros.h"
35 #include "libguile/procprop.h"
36 #include "libguile/read.h"
37 #include "libguile/weaks.h"
38 #include "libguile/programs.h"
39 #include "libguile/alist.h"
40 #include "libguile/struct.h"
41 #include "libguile/objects.h"
42 #include "libguile/ports.h"
43 #include "libguile/root.h"
44 #include "libguile/strings.h"
45 #include "libguile/strports.h"
46 #include "libguile/vectors.h"
47 #include "libguile/lang.h"
48 #include "libguile/numbers.h"
50 #include "libguile/validate.h"
51 #include "libguile/print.h"
53 #include "libguile/private-options.h"
57 /* {Names of immediate symbols}
59 * This table must agree with the declarations in scm.h: {Immediate Symbols}.
62 /* This table must agree with the list of flags in tags.h. */
63 static const char *iflagnames
[] =
72 /* Unbound slot marker for GOOPS. For internal use in GOOPS only. */
75 /* Elisp nil value. This is its Scheme name; whenever it's printed in
76 * Elisp, it should appear as the symbol `nil'. */
80 SCM_SYMBOL (sym_reader
, "reader");
82 scm_t_option scm_print_opts
[] = {
83 { SCM_OPTION_SCM
, "closure-hook", SCM_UNPACK (SCM_BOOL_F
),
84 "Hook for printing closures (should handle macros as well)." },
85 { SCM_OPTION_BOOLEAN
, "source", 0,
86 "Print closures with source." },
87 { SCM_OPTION_SCM
, "highlight-prefix", (unsigned long)SCM_BOOL_F
,
88 "The string to print before highlighted values." },
89 { SCM_OPTION_SCM
, "highlight-suffix", (unsigned long)SCM_BOOL_F
,
90 "The string to print after highlighted values." },
91 { SCM_OPTION_SCM
, "quote-keywordish-symbols", (unsigned long)SCM_BOOL_F
,
92 "How to print symbols that have a colon as their first or last character. "
93 "The value '#f' does not quote the colons; '#t' quotes them; "
94 "'reader' quotes them when the reader option 'keywords' is not '#f'."
100 SCM_DEFINE (scm_print_options
, "print-options-interface", 0, 1, 0,
102 "Option interface for the print options. Instead of using\n"
103 "this procedure directly, use the procedures\n"
104 "@code{print-enable}, @code{print-disable}, @code{print-set!}\n"
105 "and @code{print-options}.")
106 #define FUNC_NAME s_scm_print_options
108 SCM ans
= scm_options (setting
,
116 /* {Printing of Scheme Objects}
119 /* Detection of circular references.
121 * Due to other constraints in the implementation, this code has bad
122 * time complexity (O (depth * N)), The printer code can be
123 * rewritten to be O(N).
125 #define PUSH_REF(pstate, obj) \
128 PSTATE_STACK_SET (pstate, pstate->top, obj); \
130 if (pstate->top == pstate->ceiling) \
131 grow_ref_stack (pstate); \
134 #define ENTER_NESTED_DATA(pstate, obj, label) \
137 register unsigned long i; \
138 for (i = 0; i < pstate->top; ++i) \
139 if (scm_is_eq (PSTATE_STACK_REF (pstate, i), (obj))) \
141 if (pstate->fancyp) \
143 if (pstate->top - pstate->list_offset >= pstate->level) \
145 scm_putc ('#', port); \
149 PUSH_REF(pstate, obj); \
152 #define EXIT_NESTED_DATA(pstate) \
156 PSTATE_STACK_SET (pstate, pstate->top, SCM_UNDEFINED); \
160 SCM scm_print_state_vtable
= SCM_BOOL_F
;
161 static SCM print_state_pool
= SCM_EOL
;
162 scm_i_pthread_mutex_t print_state_mutex
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
164 #ifdef GUILE_DEBUG /* Used for debugging purposes */
166 SCM_DEFINE (scm_current_pstate
, "current-pstate", 0, 0, 0,
168 "Return the current-pstate -- the car of the\n"
169 "@code{print_state_pool}. @code{current-pstate} is only\n"
170 "included in @code{--enable-guile-debug} builds.")
171 #define FUNC_NAME s_scm_current_pstate
173 if (!scm_is_null (print_state_pool
))
174 return SCM_CAR (print_state_pool
);
182 #define PSTATE_SIZE 50L
185 make_print_state (void)
188 = scm_make_struct (scm_print_state_vtable
, SCM_INUM0
, SCM_EOL
);
189 scm_print_state
*pstate
= SCM_PRINT_STATE (print_state
);
190 pstate
->ref_vect
= scm_c_make_vector (PSTATE_SIZE
, SCM_UNDEFINED
);
191 pstate
->ceiling
= SCM_SIMPLE_VECTOR_LENGTH (pstate
->ref_vect
);
192 pstate
->highlight_objects
= SCM_EOL
;
197 scm_make_print_state ()
199 SCM answer
= SCM_BOOL_F
;
201 /* First try to allocate a print state from the pool */
202 scm_i_pthread_mutex_lock (&print_state_mutex
);
203 if (!scm_is_null (print_state_pool
))
205 answer
= SCM_CAR (print_state_pool
);
206 print_state_pool
= SCM_CDR (print_state_pool
);
208 scm_i_pthread_mutex_unlock (&print_state_mutex
);
210 return scm_is_false (answer
) ? make_print_state () : answer
;
214 scm_free_print_state (SCM print_state
)
217 scm_print_state
*pstate
= SCM_PRINT_STATE (print_state
);
218 /* Cleanup before returning print state to pool.
219 * It is better to do it here. Doing it in scm_prin1
220 * would cost more since that function is called much more
224 pstate
->revealed
= 0;
225 pstate
->highlight_objects
= SCM_EOL
;
226 scm_i_pthread_mutex_lock (&print_state_mutex
);
227 handle
= scm_cons (print_state
, print_state_pool
);
228 print_state_pool
= handle
;
229 scm_i_pthread_mutex_unlock (&print_state_mutex
);
233 scm_i_port_with_print_state (SCM port
, SCM print_state
)
235 if (SCM_UNBNDP (print_state
))
237 if (SCM_PORT_WITH_PS_P (port
))
240 print_state
= scm_make_print_state ();
241 /* port does not need to be coerced since it doesn't have ps */
244 port
= SCM_COERCE_OUTPORT (port
);
245 SCM_RETURN_NEWSMOB (scm_tc16_port_with_ps
,
246 SCM_UNPACK (scm_cons (port
, print_state
)));
250 grow_ref_stack (scm_print_state
*pstate
)
252 SCM old_vect
= pstate
->ref_vect
;
253 size_t old_size
= SCM_SIMPLE_VECTOR_LENGTH (old_vect
);
254 size_t new_size
= 2 * pstate
->ceiling
;
255 SCM new_vect
= scm_c_make_vector (new_size
, SCM_UNDEFINED
);
258 for (i
= 0; i
!= old_size
; ++i
)
259 SCM_SIMPLE_VECTOR_SET (new_vect
, i
, SCM_SIMPLE_VECTOR_REF (old_vect
, i
));
261 pstate
->ref_vect
= new_vect
;
262 pstate
->ceiling
= new_size
;
265 #define PSTATE_STACK_REF(p,i) SCM_SIMPLE_VECTOR_REF((p)->ref_vect, (i))
266 #define PSTATE_STACK_SET(p,i,v) SCM_SIMPLE_VECTOR_SET((p)->ref_vect, (i), (v))
269 print_circref (SCM port
, scm_print_state
*pstate
, SCM ref
)
272 long self
= pstate
->top
- 1;
274 if (scm_is_pair (PSTATE_STACK_REF (pstate
, i
)))
278 if (!scm_is_pair (PSTATE_STACK_REF (pstate
, i
-1))
279 || !scm_is_eq (SCM_CDR (PSTATE_STACK_REF (pstate
, i
-1)),
280 SCM_CDR (PSTATE_STACK_REF (pstate
, i
))))
286 for (i
= pstate
->top
- 1; 1; --i
)
287 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), ref
))
289 scm_putc ('#', port
);
290 scm_intprint (i
- self
, 10, port
);
291 scm_putc ('#', port
);
294 /* Print the name of a symbol. */
297 quote_keywordish_symbol (SCM symbol
)
301 if (scm_i_symbol_ref (symbol
, 0) != ':'
302 && scm_i_symbol_ref (symbol
, scm_i_symbol_length (symbol
) - 1) != ':')
305 option
= SCM_PRINT_KEYWORD_STYLE
;
306 if (scm_is_false (option
))
308 if (scm_is_eq (option
, sym_reader
))
309 return scm_is_true (SCM_PACK (SCM_KEYWORD_STYLE
));
314 scm_i_print_symbol_name (SCM str
, SCM port
)
316 /* This points to the first character that has not yet been written to the
319 /* This points to the character we're currently looking at. */
321 /* If the name contains weird characters, we'll escape them with
322 * backslashes and set this flag; it indicates that we should surround the
323 * name with "#{" and "}#". */
325 /* Backslashes are not sufficient to make a name weird, but if a name is
326 * weird because of other characters, backslahes need to be escaped too.
327 * The first time we see a backslash, we set maybe_weird, and mw_pos points
328 * to the backslash. Then if the name turns out to be weird, we re-process
329 * everything starting from mw_pos.
330 * We could instead make backslashes always weird. This is not necessary
331 * to ensure that the output is (read)-able, but it would make this code
332 * simpler and faster. */
335 size_t len
= scm_i_symbol_length (str
);
336 scm_t_wchar str0
= scm_i_symbol_ref (str
, 0);
338 if (len
== 0 || str0
== '\'' || str0
== '`' || str0
== ','
339 || quote_keywordish_symbol (str
)
340 || (str0
== '.' && len
== 1)
341 || scm_is_true (scm_i_string_to_number (scm_symbol_to_string (str
), 10)))
343 scm_lfwrite ("#{", 2, port
);
347 for (end
= pos
; end
< len
; ++end
)
348 switch (scm_i_symbol_ref (str
, end
))
350 #ifdef BRACKETS_AS_PARENS
359 case SCM_WHITE_SPACES
:
360 case SCM_LINE_INCREMENTORS
:
369 scm_lfwrite ("#{", 2, port
);
373 scm_lfwrite_substr (scm_symbol_to_string (str
), pos
, end
, port
);
377 buf
[1] = (char) (unsigned char) scm_i_symbol_ref (str
, end
);
378 scm_lfwrite (buf
, 2, port
);
395 scm_lfwrite_substr (scm_symbol_to_string (str
), pos
, end
, port
);
397 scm_lfwrite ("}#", 2, port
);
401 scm_print_symbol_name (const char *str
, size_t len
, SCM port
)
403 SCM symbol
= scm_from_locale_symboln (str
, len
);
404 return scm_i_print_symbol_name (symbol
, port
);
407 /* Print generally. Handles both write and display according to PSTATE.
409 SCM_GPROC(s_write
, "write", 1, 1, 0, scm_write
, g_write
);
410 SCM_GPROC(s_display
, "display", 1, 1, 0, scm_display
, g_display
);
412 static void iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
);
415 scm_iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
)
418 && scm_is_true (scm_memq (exp
, pstate
->highlight_objects
)))
420 scm_display (SCM_PRINT_HIGHLIGHT_PREFIX
, port
);
421 iprin1 (exp
, port
, pstate
);
422 scm_display (SCM_PRINT_HIGHLIGHT_SUFFIX
, port
);
425 iprin1 (exp
, port
, pstate
);
429 iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
)
431 switch (SCM_ITAG3 (exp
))
433 case scm_tc3_closure
:
436 /* These tc3 tags should never occur in an immediate value. They are
437 * only used in cell types of non-immediates, i. e. the value returned
438 * by SCM_CELL_TYPE (exp) can use these tags.
440 scm_ipruk ("immediate", exp
, port
);
444 scm_intprint (SCM_I_INUM (exp
), 10, port
);
449 scm_t_wchar i
= SCM_CHAR (exp
);
452 if (SCM_WRITINGP (pstate
))
454 scm_puts ("#\\", port
);
455 name
= scm_i_charname (exp
);
457 scm_puts (name
, port
);
458 else if (uc_is_general_category_withtable (i
, UC_CATEGORY_MASK_L
462 | UC_CATEGORY_MASK_S
))
463 /* Print the character if is graphic character. */
466 SCM wstr
= scm_i_make_wide_string (1, &wbuf
);
471 enc
= scm_i_get_port_encoding (port
);
476 /* Character is graphic and Latin-1. Print it */
477 scm_lfwrite_str (wstr
, port
);
479 /* Character is graphic but unrepresentable in
480 this port's encoding. */
481 scm_intprint (i
, 8, port
);
485 buf
= u32_conv_to_encoding (enc
,
487 (scm_t_uint32
*) wbuf
,
493 /* Character is graphic. Print it. */
494 scm_lfwrite_str (wstr
, port
);
498 /* Character is graphic but unrepresentable in
499 this port's encoding. */
500 scm_intprint (i
, 8, port
);
504 /* Character is a non-graphical character. */
505 scm_intprint (i
, 8, port
);
508 scm_i_charprint (i
, port
);
510 else if (SCM_IFLAGP (exp
)
511 && ((size_t) SCM_IFLAGNUM (exp
) < (sizeof iflagnames
/ sizeof (char *))))
513 scm_puts (iflagnames
[SCM_IFLAGNUM (exp
)], port
);
515 else if (SCM_ISYMP (exp
))
517 scm_i_print_isym (exp
, port
);
519 else if (SCM_ILOCP (exp
))
521 scm_i_print_iloc (exp
, port
);
525 /* unknown immediate value */
526 scm_ipruk ("immediate", exp
, port
);
530 switch (SCM_TYP7 (exp
))
534 ENTER_NESTED_DATA (pstate
, exp
, circref
);
535 if (SCM_OBJ_CLASS_FLAGS (exp
) & SCM_CLASSF_GOOPS
)
537 SCM pwps
, print
= pstate
->writingp
? g_write
: g_display
;
540 pwps
= scm_i_port_with_print_state (port
, pstate
->handle
);
541 pstate
->revealed
= 1;
542 scm_call_generic_2 (print
, exp
, pwps
);
547 scm_print_struct (exp
, port
, pstate
);
549 EXIT_NESTED_DATA (pstate
);
552 case scm_tcs_cons_imcar
:
553 case scm_tcs_cons_nimcar
:
554 ENTER_NESTED_DATA (pstate
, exp
, circref
);
555 scm_iprlist ("(", exp
, ')', port
, pstate
);
556 EXIT_NESTED_DATA (pstate
);
559 print_circref (port
, pstate
, exp
);
561 case scm_tcs_closures
:
562 if (scm_is_false (scm_procedure_p (SCM_PRINT_CLOSURE
))
563 || scm_is_false (scm_printer_apply (SCM_PRINT_CLOSURE
,
566 SCM formals
= SCM_CLOSURE_FORMALS (exp
);
567 scm_puts ("#<procedure", port
);
568 scm_putc (' ', port
);
569 scm_iprin1 (scm_procedure_name (exp
), port
, pstate
);
570 scm_putc (' ', port
);
571 if (SCM_PRINT_SOURCE_P
)
573 SCM env
= SCM_ENV (exp
);
574 SCM xenv
= SCM_EXTEND_ENV (formals
, SCM_EOL
, env
);
575 SCM src
= scm_i_unmemocopy_body (SCM_CODE (exp
), xenv
);
576 ENTER_NESTED_DATA (pstate
, exp
, circref
);
577 scm_iprin1 (src
, port
, pstate
);
578 EXIT_NESTED_DATA (pstate
);
581 scm_iprin1 (formals
, port
, pstate
);
582 scm_putc ('>', port
);
586 switch SCM_TYP16 (exp
) {
588 scm_bigprint (exp
, port
, pstate
);
591 scm_print_real (exp
, port
, pstate
);
593 case scm_tc16_complex
:
594 scm_print_complex (exp
, port
, pstate
);
596 case scm_tc16_fraction
:
597 scm_i_print_fraction (exp
, port
, pstate
);
602 if (SCM_WRITINGP (pstate
))
605 static char const hex
[] = "0123456789abcdef";
609 scm_putc ('"', port
);
610 len
= scm_i_string_length (exp
);
611 for (i
= 0; i
< len
; ++i
)
613 scm_t_wchar ch
= scm_i_string_ref (exp
, i
);
616 if (ch
== ' ' || ch
== '\n')
621 else if (ch
== '"' || ch
== '\\')
623 scm_putc ('\\', port
);
624 scm_i_charprint (ch
, port
);
628 if (uc_is_general_category_withtable
630 UC_CATEGORY_MASK_L
| UC_CATEGORY_MASK_M
|
631 UC_CATEGORY_MASK_N
| UC_CATEGORY_MASK_P
|
634 /* Print the character since it is a graphic
637 SCM wstr
= scm_i_make_wide_string (1, &wbuf
);
641 if (scm_i_get_port_encoding (port
))
643 wstr
= scm_i_make_wide_string (1, &wbuf
);
645 buf
= u32_conv_to_encoding (scm_i_get_port_encoding (port
),
647 (scm_t_uint32
*) wbuf
,
653 /* Character is graphic and representable in
654 this encoding. Print it. */
655 scm_lfwrite_str (wstr
, port
);
670 /* Character is graphic but unrepresentable in
671 this port's encoding or is not graphic. */
676 buf
[2] = hex
[ch
/ 16];
677 buf
[3] = hex
[ch
% 16];
678 scm_lfwrite (buf
, 4, port
);
680 else if (ch
<= 0xFFFF)
684 buf
[2] = hex
[(ch
& 0xF000) >> 12];
685 buf
[3] = hex
[(ch
& 0xF00) >> 8];
686 buf
[4] = hex
[(ch
& 0xF0) >> 4];
687 buf
[5] = hex
[(ch
& 0xF)];
688 scm_lfwrite (buf
, 6, port
);
691 else if (ch
> 0xFFFF)
695 buf
[2] = hex
[(ch
& 0xF00000) >> 20];
696 buf
[3] = hex
[(ch
& 0xF0000) >> 16];
697 buf
[4] = hex
[(ch
& 0xF000) >> 12];
698 buf
[5] = hex
[(ch
& 0xF00) >> 8];
699 buf
[6] = hex
[(ch
& 0xF0) >> 4];
700 buf
[7] = hex
[(ch
& 0xF)];
701 scm_lfwrite (buf
, 8, port
);
706 scm_putc ('"', port
);
707 scm_remember_upto_here_1 (exp
);
710 scm_lfwrite_str (exp
, port
);
711 scm_remember_upto_here_1 (exp
);
714 if (scm_i_symbol_is_interned (exp
))
716 scm_i_print_symbol_name (exp
, port
);
717 scm_remember_upto_here_1 (exp
);
721 scm_puts ("#<uninterned-symbol ", port
);
722 scm_i_print_symbol_name (exp
, port
);
723 scm_putc (' ', port
);
724 scm_uintprint (SCM_UNPACK (exp
), 16, port
);
725 scm_putc ('>', port
);
728 case scm_tc7_variable
:
729 scm_i_variable_print (exp
, port
, pstate
);
731 case scm_tc7_program
:
732 scm_i_program_print (exp
, port
, pstate
);
735 ENTER_NESTED_DATA (pstate
, exp
, circref
);
736 if (SCM_IS_WHVEC (exp
))
737 scm_puts ("#wh(", port
);
739 scm_puts ("#w(", port
);
740 goto common_vector_printer
;
743 ENTER_NESTED_DATA (pstate
, exp
, circref
);
744 scm_puts ("#(", port
);
745 common_vector_printer
:
748 long last
= SCM_SIMPLE_VECTOR_LENGTH (exp
) - 1;
751 && SCM_SIMPLE_VECTOR_LENGTH (exp
) > pstate
->length
)
753 last
= pstate
->length
- 1;
756 if (SCM_I_WVECTP (exp
))
758 /* Elements of weak vectors may not be accessed via the
759 `SIMPLE_VECTOR_REF ()' macro. */
760 for (i
= 0; i
< last
; ++i
)
762 scm_iprin1 (scm_c_vector_ref (exp
, i
),
764 scm_putc (' ', port
);
769 for (i
= 0; i
< last
; ++i
)
771 scm_iprin1 (SCM_SIMPLE_VECTOR_REF (exp
, i
), port
, pstate
);
772 scm_putc (' ', port
);
779 scm_iprin1 (scm_c_vector_ref (exp
, i
), port
, pstate
);
782 scm_puts (" ...", port
);
783 scm_putc (')', port
);
785 EXIT_NESTED_DATA (pstate
);
789 SCM name
= scm_symbol_to_string (SCM_SUBR_NAME (exp
));
790 scm_puts (SCM_SUBR_GENERIC (exp
)
791 ? "#<primitive-generic "
792 : "#<primitive-procedure ",
794 scm_lfwrite_str (name
, port
);
795 scm_putc ('>', port
);
799 scm_puts ("#<procedure-with-setter", port
);
801 SCM name
= scm_procedure_name (exp
);
802 if (scm_is_true (name
))
804 scm_putc (' ', port
);
805 scm_display (name
, port
);
808 scm_putc ('>', port
);
812 register long i
= SCM_PTOBNUM (exp
);
814 && scm_ptobs
[i
].print
815 && (scm_ptobs
[i
].print
) (exp
, port
, pstate
))
820 ENTER_NESTED_DATA (pstate
, exp
, circref
);
821 SCM_SMOB_DESCRIPTOR (exp
).print (exp
, port
, pstate
);
822 EXIT_NESTED_DATA (pstate
);
826 scm_ipruk ("type", exp
, port
);
831 /* Print states are necessary for circular reference safe printing.
832 * They are also expensive to allocate. Therefore print states are
833 * kept in a pool so that they can be reused.
836 /* The PORT argument can also be a print-state/port pair, which will
837 * then be used instead of allocating a new print state. This is
838 * useful for continuing a chain of print calls from Scheme. */
841 scm_prin1 (SCM exp
, SCM port
, int writingp
)
843 SCM handle
= SCM_BOOL_F
; /* Will GC protect the handle whilst unlinked */
845 scm_print_state
*pstate
;
848 /* If PORT is a print-state/port pair, use that. Else create a new
851 if (SCM_PORT_WITH_PS_P (port
))
853 pstate_scm
= SCM_PORT_WITH_PS_PS (port
);
854 port
= SCM_PORT_WITH_PS_PORT (port
);
858 /* First try to allocate a print state from the pool */
859 scm_i_pthread_mutex_lock (&print_state_mutex
);
860 if (!scm_is_null (print_state_pool
))
862 handle
= print_state_pool
;
863 print_state_pool
= SCM_CDR (print_state_pool
);
865 scm_i_pthread_mutex_unlock (&print_state_mutex
);
866 if (scm_is_false (handle
))
867 handle
= scm_list_1 (make_print_state ());
868 pstate_scm
= SCM_CAR (handle
);
871 pstate
= SCM_PRINT_STATE (pstate_scm
);
872 old_writingp
= pstate
->writingp
;
873 pstate
->writingp
= writingp
;
874 scm_iprin1 (exp
, port
, pstate
);
875 pstate
->writingp
= old_writingp
;
877 /* Return print state to pool if it has been created above and
878 hasn't escaped to Scheme. */
880 if (scm_is_true (handle
) && !pstate
->revealed
)
882 scm_i_pthread_mutex_lock (&print_state_mutex
);
883 SCM_SETCDR (handle
, print_state_pool
);
884 print_state_pool
= handle
;
885 scm_i_pthread_mutex_unlock (&print_state_mutex
);
889 /* Print a character.
892 scm_i_charprint (scm_t_wchar ch
, SCM port
)
895 SCM wstr
= scm_i_make_wide_string (1, &wbuf
);
898 scm_lfwrite_str (wstr
, port
);
905 scm_intprint (scm_t_intmax n
, int radix
, SCM port
)
907 char num_buf
[SCM_INTBUFLEN
];
908 scm_lfwrite (num_buf
, scm_iint2str (n
, radix
, num_buf
), port
);
912 scm_uintprint (scm_t_uintmax n
, int radix
, SCM port
)
914 char num_buf
[SCM_INTBUFLEN
];
915 scm_lfwrite (num_buf
, scm_iuint2str (n
, radix
, num_buf
), port
);
918 /* Print an object of unrecognized type.
922 scm_ipruk (char *hdr
, SCM ptr
, SCM port
)
924 scm_puts ("#<unknown-", port
);
925 scm_puts (hdr
, port
);
926 if (1) /* (scm_in_heap_p (ptr)) */ /* FIXME */
928 scm_puts (" (0x", port
);
929 scm_uintprint (SCM_CELL_WORD_0 (ptr
), 16, port
);
930 scm_puts (" . 0x", port
);
931 scm_uintprint (SCM_CELL_WORD_1 (ptr
), 16, port
);
932 scm_puts (") @", port
);
934 scm_puts (" 0x", port
);
935 scm_uintprint (SCM_UNPACK (ptr
), 16, port
);
936 scm_putc ('>', port
);
943 scm_iprlist (char *hdr
, SCM exp
, int tlr
, SCM port
, scm_print_state
*pstate
)
945 register SCM hare
, tortoise
;
946 long floor
= pstate
->top
- 2;
947 scm_puts (hdr
, port
);
952 /* Run a hare and tortoise so that total time complexity will be
953 O(depth * N) instead of O(N^2). */
954 hare
= SCM_CDR (exp
);
956 while (scm_is_pair (hare
))
958 if (scm_is_eq (hare
, tortoise
))
960 hare
= SCM_CDR (hare
);
961 if (!scm_is_pair (hare
))
963 hare
= SCM_CDR (hare
);
964 tortoise
= SCM_CDR (tortoise
);
967 /* No cdr cycles intrinsic to this list */
968 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
969 for (exp
= SCM_CDR (exp
); scm_is_pair (exp
); exp
= SCM_CDR (exp
))
973 for (i
= floor
; i
>= 0; --i
)
974 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), exp
))
976 PUSH_REF (pstate
, exp
);
977 scm_putc (' ', port
);
979 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
981 if (!SCM_NULL_OR_NIL_P (exp
))
983 scm_puts (" . ", port
);
984 scm_iprin1 (exp
, port
, pstate
);
988 scm_putc (tlr
, port
);
989 pstate
->top
= floor
+ 2;
994 long n
= pstate
->length
;
996 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
997 exp
= SCM_CDR (exp
); --n
;
998 for (; scm_is_pair (exp
); exp
= SCM_CDR (exp
))
1000 register unsigned long i
;
1002 for (i
= 0; i
< pstate
->top
; ++i
)
1003 if (scm_is_eq (PSTATE_STACK_REF(pstate
, i
), exp
))
1009 scm_puts (" ...", port
);
1015 PUSH_REF(pstate
, exp
);
1016 ++pstate
->list_offset
;
1017 scm_putc (' ', port
);
1019 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
1022 if (!SCM_NULL_OR_NIL_P (exp
))
1024 scm_puts (" . ", port
);
1025 scm_iprin1 (exp
, port
, pstate
);
1028 pstate
->list_offset
-= pstate
->top
- floor
- 2;
1032 pstate
->list_offset
-= pstate
->top
- floor
- 2;
1035 scm_puts (" . ", port
);
1036 print_circref (port
, pstate
, exp
);
1043 scm_valid_oport_value_p (SCM val
)
1045 return (SCM_OPOUTPORTP (val
)
1046 || (SCM_PORT_WITH_PS_P (val
)
1047 && SCM_OPOUTPORTP (SCM_PORT_WITH_PS_PORT (val
))));
1050 /* SCM_GPROC(s_write, "write", 1, 1, 0, scm_write, g_write); */
1053 scm_write (SCM obj
, SCM port
)
1055 if (SCM_UNBNDP (port
))
1056 port
= scm_current_output_port ();
1058 SCM_ASSERT (scm_valid_oport_value_p (port
), port
, SCM_ARG2
, s_write
);
1060 scm_prin1 (obj
, port
, 1);
1065 scm_close_port (port
);
1069 return SCM_UNSPECIFIED
;
1073 /* SCM_GPROC(s_display, "display", 1, 1, 0, scm_display, g_display); */
1076 scm_display (SCM obj
, SCM port
)
1078 if (SCM_UNBNDP (port
))
1079 port
= scm_current_output_port ();
1081 SCM_ASSERT (scm_valid_oport_value_p (port
), port
, SCM_ARG2
, s_display
);
1083 scm_prin1 (obj
, port
, 0);
1088 scm_close_port (port
);
1092 return SCM_UNSPECIFIED
;
1096 SCM_DEFINE (scm_simple_format
, "simple-format", 2, 0, 1,
1097 (SCM destination
, SCM message
, SCM args
),
1098 "Write @var{message} to @var{destination}, defaulting to\n"
1099 "the current output port.\n"
1100 "@var{message} can contain @code{~A} (was @code{%s}) and\n"
1101 "@code{~S} (was @code{%S}) escapes. When printed,\n"
1102 "the escapes are replaced with corresponding members of\n"
1104 "@code{~A} formats using @code{display} and @code{~S} formats\n"
1105 "using @code{write}.\n"
1106 "If @var{destination} is @code{#t}, then use the current output\n"
1107 "port, if @var{destination} is @code{#f}, then return a string\n"
1108 "containing the formatted text. Does not add a trailing newline.")
1109 #define FUNC_NAME s_scm_simple_format
1111 SCM port
, answer
= SCM_UNSPECIFIED
;
1112 int fReturnString
= 0;
1114 size_t start
, p
, end
;
1116 if (scm_is_eq (destination
, SCM_BOOL_T
))
1118 destination
= port
= scm_current_output_port ();
1120 else if (scm_is_false (destination
))
1123 port
= scm_mkstrport (SCM_INUM0
,
1124 scm_make_string (SCM_INUM0
, SCM_UNDEFINED
),
1125 SCM_OPN
| SCM_WRTNG
,
1131 SCM_VALIDATE_OPORT_VALUE (1, destination
);
1132 port
= SCM_COERCE_OUTPORT (destination
);
1134 SCM_VALIDATE_STRING (2, message
);
1135 SCM_VALIDATE_REST_ARGUMENT (args
);
1139 end
= scm_i_string_length (message
);
1140 for (p
= start
; p
!= end
; ++p
)
1141 if (scm_i_string_ref (message
, p
) == '~')
1146 switch (scm_i_string_ref (message
, p
))
1155 scm_lfwrite_substr (message
, start
, p
, port
);
1159 scm_lfwrite_substr (message
, start
, p
- 1, port
);
1164 SCM_MISC_ERROR ("FORMAT: Unsupported format option ~~~A - use (ice-9 format) instead",
1165 scm_list_1 (SCM_MAKE_CHAR (scm_i_string_ref (message
, p
))));
1170 if (!scm_is_pair (args
))
1171 SCM_MISC_ERROR ("FORMAT: Missing argument for ~~~A",
1172 scm_list_1 (SCM_MAKE_CHAR (scm_i_string_ref (message
, p
))));
1174 scm_lfwrite_substr (message
, start
, p
- 1, port
);
1175 /* we pass destination here */
1176 scm_prin1 (SCM_CAR (args
), destination
, writingp
);
1177 args
= SCM_CDR (args
);
1181 scm_lfwrite_substr (message
, start
, p
, port
);
1182 if (!scm_is_eq (args
, SCM_EOL
))
1183 SCM_MISC_ERROR ("FORMAT: ~A superfluous arguments",
1184 scm_list_1 (scm_length (args
)));
1187 answer
= scm_strport_to_string (destination
);
1189 return scm_return_first (answer
, message
);
1194 SCM_DEFINE (scm_newline
, "newline", 0, 1, 0,
1196 "Send a newline to @var{port}.\n"
1197 "If @var{port} is omitted, send to the current output port.")
1198 #define FUNC_NAME s_scm_newline
1200 if (SCM_UNBNDP (port
))
1201 port
= scm_current_output_port ();
1203 SCM_VALIDATE_OPORT_VALUE (1, port
);
1205 scm_putc ('\n', SCM_COERCE_OUTPORT (port
));
1206 return SCM_UNSPECIFIED
;
1210 SCM_DEFINE (scm_write_char
, "write-char", 1, 1, 0,
1211 (SCM chr
, SCM port
),
1212 "Send character @var{chr} to @var{port}.")
1213 #define FUNC_NAME s_scm_write_char
1215 if (SCM_UNBNDP (port
))
1216 port
= scm_current_output_port ();
1218 SCM_VALIDATE_CHAR (1, chr
);
1219 SCM_VALIDATE_OPORT_VALUE (2, port
);
1221 scm_putc ((int) SCM_CHAR (chr
), SCM_COERCE_OUTPORT (port
));
1226 scm_close_port (port
);
1230 return SCM_UNSPECIFIED
;
1236 /* Call back to Scheme code to do the printing of special objects
1237 * (like structs). SCM_PRINTER_APPLY applies PROC to EXP and a smob
1238 * containing PORT and PSTATE. This object can be used as the port for
1239 * display/write etc to continue the current print chain. The REVEALED
1240 * field of PSTATE is set to true to indicate that the print state has
1241 * escaped to Scheme and thus has to be freed by the GC.
1244 scm_t_bits scm_tc16_port_with_ps
;
1246 /* Print exactly as the port itself would */
1249 port_with_ps_print (SCM obj
, SCM port
, scm_print_state
*pstate
)
1251 obj
= SCM_PORT_WITH_PS_PORT (obj
);
1252 return scm_ptobs
[SCM_PTOBNUM (obj
)].print (obj
, port
, pstate
);
1256 scm_printer_apply (SCM proc
, SCM exp
, SCM port
, scm_print_state
*pstate
)
1258 pstate
->revealed
= 1;
1259 return scm_call_2 (proc
, exp
,
1260 scm_i_port_with_print_state (port
, pstate
->handle
));
1263 SCM_DEFINE (scm_port_with_print_state
, "port-with-print-state", 1, 1, 0,
1264 (SCM port
, SCM pstate
),
1265 "Create a new port which behaves like @var{port}, but with an\n"
1266 "included print state @var{pstate}. @var{pstate} is optional.\n"
1267 "If @var{pstate} isn't supplied and @var{port} already has\n"
1268 "a print state, the old print state is reused.")
1269 #define FUNC_NAME s_scm_port_with_print_state
1271 SCM_VALIDATE_OPORT_VALUE (1, port
);
1272 if (!SCM_UNBNDP (pstate
))
1273 SCM_VALIDATE_PRINTSTATE (2, pstate
);
1274 return scm_i_port_with_print_state (port
, pstate
);
1278 SCM_DEFINE (scm_get_print_state
, "get-print-state", 1, 0, 0,
1280 "Return the print state of the port @var{port}. If @var{port}\n"
1281 "has no associated print state, @code{#f} is returned.")
1282 #define FUNC_NAME s_scm_get_print_state
1284 if (SCM_PORT_WITH_PS_P (port
))
1285 return SCM_PORT_WITH_PS_PS (port
);
1286 if (SCM_OUTPUT_PORT_P (port
))
1288 SCM_WRONG_TYPE_ARG (1, port
);
1297 SCM vtable
, layout
, type
;
1299 scm_init_opts (scm_print_options
, scm_print_opts
);
1301 scm_print_options (scm_list_4 (scm_from_locale_symbol ("highlight-prefix"),
1302 scm_from_locale_string ("{"),
1303 scm_from_locale_symbol ("highlight-suffix"),
1304 scm_from_locale_string ("}")));
1306 scm_gc_register_root (&print_state_pool
);
1307 scm_gc_register_root (&scm_print_state_vtable
);
1308 vtable
= scm_make_vtable_vtable (scm_nullstr
, SCM_INUM0
, SCM_EOL
);
1310 scm_make_struct_layout (scm_from_locale_string (SCM_PRINT_STATE_LAYOUT
));
1311 type
= scm_make_struct (vtable
, SCM_INUM0
, scm_list_1 (layout
));
1312 scm_set_struct_vtable_name_x (type
, scm_from_locale_symbol ("print-state"));
1313 scm_print_state_vtable
= type
;
1315 /* Don't want to bind a wrapper class in GOOPS, so pass 0 as arg1. */
1316 scm_tc16_port_with_ps
= scm_make_smob_type (0, 0);
1317 scm_set_smob_print (scm_tc16_port_with_ps
, port_with_ps_print
);
1319 #include "libguile/print.x"
1321 scm_print_opts
[SCM_PRINT_KEYWORD_STYLE_I
].val
= SCM_UNPACK (sym_reader
);