1 /* Copyright (C) 1995-1999,2000,2001, 2002, 2003 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
5 * License as published by the Free Software Foundation; either
6 * version 2.1 of the License, or (at your option) any later version.
8 * This library is distributed in the hope that it will be useful,
9 * but 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include "libguile/_scm.h"
24 #include "libguile/chars.h"
25 #include "libguile/continuations.h"
26 #include "libguile/smob.h"
27 #include "libguile/eval.h"
28 #include "libguile/macros.h"
29 #include "libguile/procprop.h"
30 #include "libguile/read.h"
31 #include "libguile/weaks.h"
32 #include "libguile/unif.h"
33 #include "libguile/alist.h"
34 #include "libguile/struct.h"
35 #include "libguile/objects.h"
36 #include "libguile/ports.h"
37 #include "libguile/root.h"
38 #include "libguile/strings.h"
39 #include "libguile/strports.h"
40 #include "libguile/vectors.h"
41 #include "libguile/lang.h"
42 #include "libguile/numbers.h"
44 #include "libguile/validate.h"
45 #include "libguile/print.h"
48 /* {Names of immediate symbols}
50 * This table must agree with the declarations in scm.h: {Immediate Symbols}.
53 /* This table must agree with the list of flags in tags.h. */
54 static const char *iflagnames
[] =
63 /* Unbound slot marker for GOOPS. For internal use in GOOPS only. */
66 /* Elisp nil value. This is its Scheme name; whenever it's printed in
67 * Elisp, it should appear as the symbol `nil'. */
71 scm_t_option scm_print_opts
[] = {
72 { SCM_OPTION_SCM
, "closure-hook", SCM_UNPACK (SCM_BOOL_F
),
73 "Hook for printing closures (should handle macros as well)." },
74 { SCM_OPTION_BOOLEAN
, "source", 0,
75 "Print closures with source." }
78 SCM_DEFINE (scm_print_options
, "print-options-interface", 0, 1, 0,
80 "Option interface for the print options. Instead of using\n"
81 "this procedure directly, use the procedures\n"
82 "@code{print-enable}, @code{print-disable}, @code{print-set!}\n"
83 "and @code{print-options}.")
84 #define FUNC_NAME s_scm_print_options
86 SCM ans
= scm_options (setting
,
95 /* {Printing of Scheme Objects}
98 /* Detection of circular references.
100 * Due to other constraints in the implementation, this code has bad
101 * time complexity (O (depth * N)), The printer code can be
102 * rewritten to be O(N).
104 #define PUSH_REF(pstate, obj) \
106 pstate->ref_stack[pstate->top++] = (obj); \
107 if (pstate->top == pstate->ceiling) \
108 grow_ref_stack (pstate); \
111 #define ENTER_NESTED_DATA(pstate, obj, label) \
113 register unsigned long i; \
114 for (i = 0; i < pstate->top; ++i) \
115 if (scm_is_eq (pstate->ref_stack[i], (obj))) \
117 if (pstate->fancyp) \
119 if (pstate->top - pstate->list_offset >= pstate->level) \
121 scm_putc ('#', port); \
125 PUSH_REF(pstate, obj); \
128 #define EXIT_NESTED_DATA(pstate) { --pstate->top; }
130 SCM scm_print_state_vtable
= SCM_BOOL_F
;
131 static SCM print_state_pool
= SCM_EOL
;
132 SCM_MUTEX (print_state_mutex
);
134 #ifdef GUILE_DEBUG /* Used for debugging purposes */
136 SCM_DEFINE (scm_current_pstate
, "current-pstate", 0, 0, 0,
138 "Return the current-pstate -- the car of the\n"
139 "@code{print_state_pool}. @code{current-pstate} is only\n"
140 "included in @code{--enable-guile-debug} builds.")
141 #define FUNC_NAME s_scm_current_pstate
143 if (!SCM_NULLP (print_state_pool
))
144 return SCM_CAR (print_state_pool
);
152 #define PSTATE_SIZE 50L
155 make_print_state (void)
158 = scm_make_struct (scm_print_state_vtable
, SCM_INUM0
, SCM_EOL
);
159 scm_print_state
*pstate
= SCM_PRINT_STATE (print_state
);
160 pstate
->ref_vect
= scm_c_make_vector (PSTATE_SIZE
, SCM_UNDEFINED
);
161 pstate
->ref_stack
= SCM_WRITABLE_VELTS (pstate
->ref_vect
);
162 pstate
->ceiling
= SCM_VECTOR_LENGTH (pstate
->ref_vect
);
167 scm_make_print_state ()
169 SCM answer
= SCM_BOOL_F
;
171 /* First try to allocate a print state from the pool */
172 scm_i_plugin_mutex_lock (&print_state_mutex
);
173 if (!SCM_NULLP (print_state_pool
))
175 answer
= SCM_CAR (print_state_pool
);
176 print_state_pool
= SCM_CDR (print_state_pool
);
178 scm_i_plugin_mutex_unlock (&print_state_mutex
);
180 return scm_is_false (answer
) ? make_print_state () : answer
;
184 scm_free_print_state (SCM print_state
)
187 scm_print_state
*pstate
= SCM_PRINT_STATE (print_state
);
188 /* Cleanup before returning print state to pool.
189 * It is better to do it here. Doing it in scm_prin1
190 * would cost more since that function is called much more
194 pstate
->revealed
= 0;
195 scm_i_plugin_mutex_lock (&print_state_mutex
);
196 handle
= scm_cons (print_state
, print_state_pool
);
197 print_state_pool
= handle
;
198 scm_i_plugin_mutex_unlock (&print_state_mutex
);
202 scm_i_port_with_print_state (SCM port
, SCM print_state
)
204 if (SCM_UNBNDP (print_state
))
206 if (SCM_PORT_WITH_PS_P (port
))
209 print_state
= scm_make_print_state ();
210 /* port does not need to be coerced since it doesn't have ps */
213 port
= SCM_COERCE_OUTPORT (port
);
214 SCM_RETURN_NEWSMOB (scm_tc16_port_with_ps
,
215 SCM_UNPACK (scm_cons (port
, print_state
)));
219 grow_ref_stack (scm_print_state
*pstate
)
221 unsigned long int old_size
= SCM_VECTOR_LENGTH (pstate
->ref_vect
);
222 SCM
const *old_elts
= SCM_VELTS (pstate
->ref_vect
);
223 unsigned long int new_size
= 2 * pstate
->ceiling
;
224 SCM new_vect
= scm_c_make_vector (new_size
, SCM_UNDEFINED
);
227 for (i
= 0; i
!= old_size
; ++i
)
228 SCM_VECTOR_SET (new_vect
, i
, old_elts
[i
]);
230 pstate
->ref_vect
= new_vect
;
231 pstate
->ref_stack
= SCM_WRITABLE_VELTS(new_vect
);
232 pstate
->ceiling
= new_size
;
237 print_circref (SCM port
, scm_print_state
*pstate
, SCM ref
)
240 long self
= pstate
->top
- 1;
242 if (SCM_CONSP (pstate
->ref_stack
[i
]))
246 if (!SCM_CONSP (pstate
->ref_stack
[i
- 1])
247 || !scm_is_eq (SCM_CDR (pstate
->ref_stack
[i
- 1]),
248 pstate
->ref_stack
[i
]))
254 for (i
= pstate
->top
- 1; 1; --i
)
255 if (scm_is_eq (pstate
->ref_stack
[i
], ref
))
257 scm_putc ('#', port
);
258 scm_intprint (i
- self
, 10, port
);
259 scm_putc ('#', port
);
262 /* Print the name of a symbol. */
265 scm_print_symbol_name (const char *str
, size_t len
, SCM port
)
267 /* This points to the first character that has not yet been written to the
270 /* This points to the character we're currently looking at. */
272 /* If the name contains weird characters, we'll escape them with
273 * backslashes and set this flag; it indicates that we should surround the
274 * name with "#{" and "}#". */
276 /* Backslashes are not sufficient to make a name weird, but if a name is
277 * weird because of other characters, backslahes need to be escaped too.
278 * The first time we see a backslash, we set maybe_weird, and mw_pos points
279 * to the backslash. Then if the name turns out to be weird, we re-process
280 * everything starting from mw_pos.
281 * We could instead make backslashes always weird. This is not necessary
282 * to ensure that the output is (read)-able, but it would make this code
283 * simpler and faster. */
287 if (len
== 0 || str
[0] == '\'' || str
[0] == '`' || str
[0] == ',' ||
288 str
[0] == ':' || str
[len
-1] == ':' || (str
[0] == '.' && len
== 1) ||
289 scm_is_true (scm_i_mem2number(str
, len
, 10)))
291 scm_lfwrite ("#{", 2, port
);
295 for (end
= pos
; end
< len
; ++end
)
298 #ifdef BRACKETS_AS_PARENS
307 case SCM_WHITE_SPACES
:
308 case SCM_LINE_INCREMENTORS
:
317 scm_lfwrite ("#{", 2, port
);
321 scm_lfwrite (str
+ pos
, end
- pos
, port
);
326 scm_lfwrite (buf
, 2, port
);
343 scm_lfwrite (str
+ pos
, end
- pos
, port
);
345 scm_lfwrite ("}#", 2, port
);
348 /* Print generally. Handles both write and display according to PSTATE.
350 SCM_GPROC(s_write
, "write", 1, 1, 0, scm_write
, g_write
);
351 SCM_GPROC(s_display
, "display", 1, 1, 0, scm_display
, g_display
);
354 scm_iprin1 (SCM exp
, SCM port
, scm_print_state
*pstate
)
356 switch (SCM_ITAG3 (exp
))
358 case scm_tc3_closure
:
361 /* These tc3 tags should never occur in an immediate value. They are
362 * only used in cell types of non-immediates, i. e. the value returned
363 * by SCM_CELL_TYPE (exp) can use these tags.
365 scm_ipruk ("immediate", exp
, port
);
369 scm_intprint (SCM_I_INUM (exp
), 10, port
);
374 long i
= SCM_CHAR (exp
);
376 if (SCM_WRITINGP (pstate
))
378 scm_puts ("#\\", port
);
379 if ((i
>= 0) && (i
<= ' ') && scm_charnames
[i
])
380 scm_puts (scm_charnames
[i
], port
);
382 else if (i
== '\177')
383 scm_puts (scm_charnames
[scm_n_charnames
- 1], port
);
385 else if (i
< 0 || i
> '\177')
386 scm_intprint (i
, 8, port
);
393 else if (SCM_IFLAGP (exp
)
394 && ((size_t) SCM_IFLAGNUM (exp
) < (sizeof iflagnames
/ sizeof (char *))))
396 scm_puts (iflagnames
[SCM_IFLAGNUM (exp
)], port
);
398 else if (SCM_ISYMP (exp
))
400 scm_i_print_isym (exp
, port
);
402 else if (SCM_ILOCP (exp
))
404 scm_i_print_iloc (exp
, port
);
408 /* unknown immediate value */
409 scm_ipruk ("immediate", exp
, port
);
413 switch (SCM_TYP7 (exp
))
417 ENTER_NESTED_DATA (pstate
, exp
, circref
);
418 if (SCM_OBJ_CLASS_FLAGS (exp
) & SCM_CLASSF_GOOPS
)
420 SCM pwps
, print
= pstate
->writingp
? g_write
: g_display
;
423 pwps
= scm_i_port_with_print_state (port
, pstate
->handle
);
424 pstate
->revealed
= 1;
425 scm_call_generic_2 (print
, exp
, pwps
);
430 scm_print_struct (exp
, port
, pstate
);
432 EXIT_NESTED_DATA (pstate
);
435 case scm_tcs_cons_imcar
:
436 case scm_tcs_cons_nimcar
:
437 ENTER_NESTED_DATA (pstate
, exp
, circref
);
438 scm_iprlist ("(", exp
, ')', port
, pstate
);
439 EXIT_NESTED_DATA (pstate
);
442 print_circref (port
, pstate
, exp
);
444 case scm_tcs_closures
:
445 if (scm_is_false (scm_procedure_p (SCM_PRINT_CLOSURE
))
446 || scm_is_false (scm_printer_apply (SCM_PRINT_CLOSURE
,
449 SCM formals
= SCM_CLOSURE_FORMALS (exp
);
450 scm_puts ("#<procedure", port
);
451 scm_putc (' ', port
);
452 scm_iprin1 (scm_procedure_name (exp
), port
, pstate
);
453 scm_putc (' ', port
);
454 if (SCM_PRINT_SOURCE_P
)
456 SCM env
= SCM_ENV (exp
);
457 SCM xenv
= SCM_EXTEND_ENV (formals
, SCM_EOL
, env
);
458 SCM src
= scm_i_unmemocopy_body (SCM_CODE (exp
), xenv
);
459 ENTER_NESTED_DATA (pstate
, exp
, circref
);
460 scm_iprin1 (src
, port
, pstate
);
461 EXIT_NESTED_DATA (pstate
);
464 scm_iprin1 (formals
, port
, pstate
);
465 scm_putc ('>', port
);
469 switch SCM_TYP16 (exp
) {
471 scm_bigprint (exp
, port
, pstate
);
474 scm_print_real (exp
, port
, pstate
);
476 case scm_tc16_complex
:
477 scm_print_complex (exp
, port
, pstate
);
479 case scm_tc16_fraction
:
480 scm_i_print_fraction (exp
, port
, pstate
);
485 if (SCM_WRITINGP (pstate
))
489 scm_putc ('"', port
);
490 for (i
= 0; i
< SCM_STRING_LENGTH (exp
); ++i
)
492 unsigned char ch
= SCM_STRING_CHARS (exp
)[i
];
493 if ((ch
< 32 && ch
!= '\n') || (127 <= ch
&& ch
< 148))
495 static char const hex
[]="0123456789abcdef";
496 scm_putc ('\\', port
);
497 scm_putc ('x', port
);
498 scm_putc (hex
[ch
/ 16], port
);
499 scm_putc (hex
[ch
% 16], port
);
503 if (ch
== '"' || ch
== '\\')
504 scm_putc ('\\', port
);
508 scm_putc ('"', port
);
511 scm_lfwrite (SCM_STRING_CHARS (exp
), SCM_STRING_LENGTH (exp
),
515 if (SCM_SYMBOL_INTERNED_P (exp
))
517 scm_print_symbol_name (SCM_SYMBOL_CHARS (exp
),
518 SCM_SYMBOL_LENGTH (exp
),
520 scm_remember_upto_here_1 (exp
);
524 scm_puts ("#<uninterned-symbol ", port
);
525 scm_print_symbol_name (SCM_SYMBOL_CHARS (exp
),
526 SCM_SYMBOL_LENGTH (exp
),
528 scm_putc (' ', port
);
529 scm_intprint ((long)exp
, 16, port
);
530 scm_putc ('>', port
);
533 case scm_tc7_variable
:
534 scm_i_variable_print (exp
, port
, pstate
);
537 ENTER_NESTED_DATA (pstate
, exp
, circref
);
538 if (SCM_IS_WHVEC (exp
))
539 scm_puts ("#wh(", port
);
541 scm_puts ("#w(", port
);
542 goto common_vector_printer
;
545 ENTER_NESTED_DATA (pstate
, exp
, circref
);
546 scm_puts ("#(", port
);
547 common_vector_printer
:
550 long last
= SCM_VECTOR_LENGTH (exp
) - 1;
552 if (pstate
->fancyp
&& SCM_VECTOR_LENGTH (exp
) > pstate
->length
)
554 last
= pstate
->length
- 1;
557 for (i
= 0; i
< last
; ++i
)
560 scm_iprin1 (SCM_VELTS (exp
)[i
], port
, pstate
);
561 scm_putc (' ', port
);
566 scm_iprin1 (SCM_VELTS (exp
)[i
], port
, pstate
);
569 scm_puts (" ...", port
);
570 scm_putc (')', port
);
572 EXIT_NESTED_DATA (pstate
);
583 #if SCM_SIZEOF_LONG_LONG != 0
586 scm_raprin1 (exp
, port
, pstate
);
590 scm_puts (SCM_SUBR_GENERIC (exp
)
591 ? "#<primitive-generic "
592 : "#<primitive-procedure ",
594 scm_puts (SCM_SYMBOL_CHARS (SCM_SNAME (exp
)), port
);
595 scm_putc ('>', port
);
600 SCM proc
= SCM_CCLO_SUBR (exp
);
601 if (scm_is_eq (proc
, scm_f_gsubr_apply
))
603 /* Print gsubrs as primitives */
604 SCM name
= scm_procedure_name (exp
);
605 scm_puts ("#<primitive-procedure", port
);
606 if (scm_is_true (name
))
608 scm_putc (' ', port
);
609 scm_puts (SCM_SYMBOL_CHARS (name
), port
);
614 scm_puts ("#<compiled-closure ", port
);
615 scm_iprin1 (proc
, port
, pstate
);
617 scm_putc ('>', port
);
622 scm_puts ("#<procedure-with-setter", port
);
624 SCM name
= scm_procedure_name (exp
);
625 if (scm_is_true (name
))
627 scm_putc (' ', port
);
628 scm_display (name
, port
);
631 scm_putc ('>', port
);
635 register long i
= SCM_PTOBNUM (exp
);
637 && scm_ptobs
[i
].print
638 && (scm_ptobs
[i
].print
) (exp
, port
, pstate
))
643 ENTER_NESTED_DATA (pstate
, exp
, circref
);
644 SCM_SMOB_DESCRIPTOR (exp
).print (exp
, port
, pstate
);
645 EXIT_NESTED_DATA (pstate
);
649 scm_ipruk ("type", exp
, port
);
654 /* Print states are necessary for circular reference safe printing.
655 * They are also expensive to allocate. Therefore print states are
656 * kept in a pool so that they can be reused.
659 /* The PORT argument can also be a print-state/port pair, which will
660 * then be used instead of allocating a new print state. This is
661 * useful for continuing a chain of print calls from Scheme. */
664 scm_prin1 (SCM exp
, SCM port
, int writingp
)
666 SCM handle
= SCM_BOOL_F
; /* Will GC protect the handle whilst unlinked */
668 scm_print_state
*pstate
;
671 /* If PORT is a print-state/port pair, use that. Else create a new
674 if (SCM_PORT_WITH_PS_P (port
))
676 pstate_scm
= SCM_PORT_WITH_PS_PS (port
);
677 port
= SCM_PORT_WITH_PS_PORT (port
);
681 /* First try to allocate a print state from the pool */
682 scm_i_plugin_mutex_lock (&print_state_mutex
);
683 if (!SCM_NULLP (print_state_pool
))
685 handle
= print_state_pool
;
686 print_state_pool
= SCM_CDR (print_state_pool
);
688 scm_i_plugin_mutex_unlock (&print_state_mutex
);
689 if (scm_is_false (handle
))
690 handle
= scm_list_1 (make_print_state ());
691 pstate_scm
= SCM_CAR (handle
);
694 pstate
= SCM_PRINT_STATE (pstate_scm
);
695 old_writingp
= pstate
->writingp
;
696 pstate
->writingp
= writingp
;
697 scm_iprin1 (exp
, port
, pstate
);
698 pstate
->writingp
= old_writingp
;
700 /* Return print state to pool if it has been created above and
701 hasn't escaped to Scheme. */
703 if (scm_is_true (handle
) && !pstate
->revealed
)
705 scm_i_plugin_mutex_lock (&print_state_mutex
);
706 SCM_SETCDR (handle
, print_state_pool
);
707 print_state_pool
= handle
;
708 scm_i_plugin_mutex_unlock (&print_state_mutex
);
717 scm_intprint (long n
, int radix
, SCM port
)
719 char num_buf
[SCM_INTBUFLEN
];
720 scm_lfwrite (num_buf
, scm_iint2str (n
, radix
, num_buf
), port
);
723 /* Print an object of unrecognized type.
727 scm_ipruk (char *hdr
, SCM ptr
, SCM port
)
729 scm_puts ("#<unknown-", port
);
730 scm_puts (hdr
, port
);
731 if (scm_in_heap_p (ptr
))
733 scm_puts (" (0x", port
);
734 scm_intprint (SCM_CELL_WORD_0 (ptr
), 16, port
);
735 scm_puts (" . 0x", port
);
736 scm_intprint (SCM_CELL_WORD_1 (ptr
), 16, port
);
737 scm_puts (") @", port
);
739 scm_puts (" 0x", port
);
740 scm_intprint (SCM_UNPACK (ptr
), 16, port
);
741 scm_putc ('>', port
);
748 scm_iprlist (char *hdr
, SCM exp
, int tlr
, SCM port
, scm_print_state
*pstate
)
750 register SCM hare
, tortoise
;
751 long floor
= pstate
->top
- 2;
752 scm_puts (hdr
, port
);
757 /* Run a hare and tortoise so that total time complexity will be
758 O(depth * N) instead of O(N^2). */
759 hare
= SCM_CDR (exp
);
761 while (SCM_CONSP (hare
))
763 if (scm_is_eq (hare
, tortoise
))
765 hare
= SCM_CDR (hare
);
766 if (!SCM_CONSP (hare
))
768 hare
= SCM_CDR (hare
);
769 tortoise
= SCM_CDR (tortoise
);
772 /* No cdr cycles intrinsic to this list */
773 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
774 for (exp
= SCM_CDR (exp
); SCM_CONSP (exp
); exp
= SCM_CDR (exp
))
778 for (i
= floor
; i
>= 0; --i
)
779 if (scm_is_eq (pstate
->ref_stack
[i
], exp
))
781 PUSH_REF (pstate
, exp
);
782 scm_putc (' ', port
);
784 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
786 if (!SCM_NULL_OR_NIL_P (exp
))
788 scm_puts (" . ", port
);
789 scm_iprin1 (exp
, port
, pstate
);
793 scm_putc (tlr
, port
);
794 pstate
->top
= floor
+ 2;
799 long n
= pstate
->length
;
801 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
802 exp
= SCM_CDR (exp
); --n
;
803 for (; SCM_CONSP (exp
); exp
= SCM_CDR (exp
))
805 register unsigned long i
;
807 for (i
= 0; i
< pstate
->top
; ++i
)
808 if (scm_is_eq (pstate
->ref_stack
[i
], exp
))
814 scm_puts (" ...", port
);
820 PUSH_REF(pstate
, exp
);
821 ++pstate
->list_offset
;
822 scm_putc (' ', port
);
824 scm_iprin1 (SCM_CAR (exp
), port
, pstate
);
827 if (!SCM_NULL_OR_NIL_P (exp
))
829 scm_puts (" . ", port
);
830 scm_iprin1 (exp
, port
, pstate
);
833 pstate
->list_offset
-= pstate
->top
- floor
- 2;
837 pstate
->list_offset
-= pstate
->top
- floor
- 2;
840 scm_puts (" . ", port
);
841 print_circref (port
, pstate
, exp
);
848 scm_valid_oport_value_p (SCM val
)
850 return (SCM_OPOUTPORTP (val
)
851 || (SCM_PORT_WITH_PS_P (val
)
852 && SCM_OPOUTPORTP (SCM_PORT_WITH_PS_PORT (val
))));
855 /* SCM_GPROC(s_write, "write", 1, 1, 0, scm_write, g_write); */
858 scm_write (SCM obj
, SCM port
)
860 if (SCM_UNBNDP (port
))
863 SCM_ASSERT (scm_valid_oport_value_p (port
), port
, SCM_ARG2
, s_write
);
865 scm_prin1 (obj
, port
, 1);
869 scm_close_port (port
);
872 return SCM_UNSPECIFIED
;
876 /* SCM_GPROC(s_display, "display", 1, 1, 0, scm_display, g_display); */
879 scm_display (SCM obj
, SCM port
)
881 if (SCM_UNBNDP (port
))
884 SCM_ASSERT (scm_valid_oport_value_p (port
), port
, SCM_ARG2
, s_display
);
886 scm_prin1 (obj
, port
, 0);
890 scm_close_port (port
);
893 return SCM_UNSPECIFIED
;
897 SCM_DEFINE (scm_simple_format
, "simple-format", 2, 0, 1,
898 (SCM destination
, SCM message
, SCM args
),
899 "Write @var{message} to @var{destination}, defaulting to\n"
900 "the current output port.\n"
901 "@var{message} can contain @code{~A} (was @code{%s}) and\n"
902 "@code{~S} (was @code{%S}) escapes. When printed,\n"
903 "the escapes are replaced with corresponding members of\n"
905 "@code{~A} formats using @code{display} and @code{~S} formats\n"
906 "using @code{write}.\n"
907 "If @var{destination} is @code{#t}, then use the current output\n"
908 "port, if @var{destination} is @code{#f}, then return a string\n"
909 "containing the formatted text. Does not add a trailing newline.")
910 #define FUNC_NAME s_scm_simple_format
912 SCM port
, answer
= SCM_UNSPECIFIED
;
913 int fReturnString
= 0;
919 if (scm_is_eq (destination
, SCM_BOOL_T
))
921 destination
= port
= scm_cur_outp
;
923 else if (scm_is_false (destination
))
926 port
= scm_mkstrport (SCM_INUM0
,
927 scm_make_string (SCM_INUM0
, SCM_UNDEFINED
),
934 SCM_VALIDATE_OPORT_VALUE (1, destination
);
935 port
= SCM_COERCE_OUTPORT (destination
);
937 SCM_VALIDATE_STRING (2, message
);
938 SCM_VALIDATE_REST_ARGUMENT (args
);
940 start
= SCM_STRING_CHARS (message
);
941 end
= start
+ SCM_STRING_LENGTH (message
);
942 for (p
= start
; p
!= end
; ++p
)
957 scm_lfwrite (start
, p
- start
, port
);
961 scm_lfwrite (start
, p
- start
- 1, port
);
966 SCM_MISC_ERROR ("FORMAT: Unsupported format option ~~~A - use (ice-9 format) instead",
967 scm_list_1 (SCM_MAKE_CHAR (*p
)));
972 if (!SCM_CONSP (args
))
973 SCM_MISC_ERROR ("FORMAT: Missing argument for ~~~A",
974 scm_list_1 (SCM_MAKE_CHAR (*p
)));
976 scm_lfwrite (start
, p
- start
- 1, port
);
977 /* we pass destination here */
978 scm_prin1 (SCM_CAR (args
), destination
, writingp
);
979 args
= SCM_CDR (args
);
983 scm_lfwrite (start
, p
- start
, port
);
984 if (!scm_is_eq (args
, SCM_EOL
))
985 SCM_MISC_ERROR ("FORMAT: ~A superfluous arguments",
986 scm_list_1 (scm_length (args
)));
989 answer
= scm_strport_to_string (destination
);
991 return scm_return_first (answer
, message
);
996 SCM_DEFINE (scm_newline
, "newline", 0, 1, 0,
998 "Send a newline to @var{port}.\n"
999 "If @var{port} is omitted, send to the current output port.")
1000 #define FUNC_NAME s_scm_newline
1002 if (SCM_UNBNDP (port
))
1003 port
= scm_cur_outp
;
1005 SCM_VALIDATE_OPORT_VALUE (1, port
);
1007 scm_putc ('\n', SCM_COERCE_OUTPORT (port
));
1008 return SCM_UNSPECIFIED
;
1012 SCM_DEFINE (scm_write_char
, "write-char", 1, 1, 0,
1013 (SCM chr
, SCM port
),
1014 "Send character @var{chr} to @var{port}.")
1015 #define FUNC_NAME s_scm_write_char
1017 if (SCM_UNBNDP (port
))
1018 port
= scm_cur_outp
;
1020 SCM_VALIDATE_CHAR (1, chr
);
1021 SCM_VALIDATE_OPORT_VALUE (2, port
);
1023 scm_putc ((int) SCM_CHAR (chr
), SCM_COERCE_OUTPORT (port
));
1027 scm_close_port (port
);
1030 return SCM_UNSPECIFIED
;
1036 /* Call back to Scheme code to do the printing of special objects
1037 * (like structs). SCM_PRINTER_APPLY applies PROC to EXP and a smob
1038 * containing PORT and PSTATE. This object can be used as the port for
1039 * display/write etc to continue the current print chain. The REVEALED
1040 * field of PSTATE is set to true to indicate that the print state has
1041 * escaped to Scheme and thus has to be freed by the GC.
1044 scm_t_bits scm_tc16_port_with_ps
;
1046 /* Print exactly as the port itself would */
1049 port_with_ps_print (SCM obj
, SCM port
, scm_print_state
*pstate
)
1051 obj
= SCM_PORT_WITH_PS_PORT (obj
);
1052 return scm_ptobs
[SCM_PTOBNUM (obj
)].print (obj
, port
, pstate
);
1056 scm_printer_apply (SCM proc
, SCM exp
, SCM port
, scm_print_state
*pstate
)
1058 pstate
->revealed
= 1;
1059 return scm_call_2 (proc
, exp
,
1060 scm_i_port_with_print_state (port
, pstate
->handle
));
1063 SCM_DEFINE (scm_port_with_print_state
, "port-with-print-state", 1, 1, 0,
1064 (SCM port
, SCM pstate
),
1065 "Create a new port which behaves like @var{port}, but with an\n"
1066 "included print state @var{pstate}. @var{pstate} is optional.\n"
1067 "If @var{pstate} isn't supplied and @var{port} already has\n"
1068 "a print state, the old print state is reused.")
1069 #define FUNC_NAME s_scm_port_with_print_state
1071 SCM_VALIDATE_OPORT_VALUE (1, port
);
1072 if (!SCM_UNBNDP (pstate
))
1073 SCM_VALIDATE_PRINTSTATE (2, pstate
);
1074 return scm_i_port_with_print_state (port
, pstate
);
1078 SCM_DEFINE (scm_get_print_state
, "get-print-state", 1, 0, 0,
1080 "Return the print state of the port @var{port}. If @var{port}\n"
1081 "has no associated print state, @code{#f} is returned.")
1082 #define FUNC_NAME s_scm_get_print_state
1084 if (SCM_PORT_WITH_PS_P (port
))
1085 return SCM_PORT_WITH_PS_PS (port
);
1086 if (SCM_OUTPUT_PORT_P (port
))
1088 SCM_WRONG_TYPE_ARG (1, port
);
1097 SCM vtable
, layout
, type
;
1099 scm_init_opts (scm_print_options
, scm_print_opts
, SCM_N_PRINT_OPTIONS
);
1101 scm_gc_register_root (&print_state_pool
);
1102 scm_gc_register_root (&scm_print_state_vtable
);
1103 vtable
= scm_make_vtable_vtable (scm_nullstr
, SCM_INUM0
, SCM_EOL
);
1104 layout
= scm_make_struct_layout (scm_makfrom0str (SCM_PRINT_STATE_LAYOUT
));
1105 type
= scm_make_struct (vtable
, SCM_INUM0
, scm_list_1 (layout
));
1106 scm_set_struct_vtable_name_x (type
, scm_str2symbol ("print-state"));
1107 scm_print_state_vtable
= type
;
1109 /* Don't want to bind a wrapper class in GOOPS, so pass 0 as arg1. */
1110 scm_tc16_port_with_ps
= scm_make_smob_type (0, 0);
1111 scm_set_smob_mark (scm_tc16_port_with_ps
, scm_markcdr
);
1112 scm_set_smob_print (scm_tc16_port_with_ps
, port_with_ps_print
);
1114 #include "libguile/print.x"