merge strictness branch from 2.0
[bpt/guile.git] / libguile / print.c
1 /* Copyright (C) 1995-1999, 2000, 2001, 2002, 2003, 2004, 2006, 2008,
2 * 2009, 2010, 2011 Free Software Foundation, Inc.
3 *
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.
8 *
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.
13 *
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
17 * 02110-1301 USA
18 */
19
20
21 \f
22 #ifdef HAVE_CONFIG_H
23 # include <config.h>
24 #endif
25
26 #include <errno.h>
27 #include <iconv.h>
28 #include <stdio.h>
29 #include <assert.h>
30
31 #include <uniconv.h>
32 #include <unictype.h>
33
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"
54
55 #include "libguile/validate.h"
56 #include "libguile/print.h"
57
58 #include "libguile/private-options.h"
59
60 \f
61
62 /* Character printers. */
63
64 static size_t display_string (const void *, int, size_t, SCM,
65 scm_t_string_failed_conversion_handler);
66
67 static int display_character (scm_t_wchar, SCM,
68 scm_t_string_failed_conversion_handler);
69
70 static void write_character (scm_t_wchar, SCM, int);
71
72 static void write_character_escaped (scm_t_wchar, int, SCM);
73
74 \f
75
76 /* {Names of immediate symbols}
77 *
78 * This table must agree with the declarations in scm.h: {Immediate Symbols}.
79 */
80
81 /* This table must agree with the list of flags in tags.h. */
82 static const char *iflagnames[] =
83 {
84 "#f",
85 "#nil", /* Elisp nil value. Should print from elisp as symbol `nil'. */
86 "#<XXX UNUSED LISP FALSE -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
87 "()",
88 "#t",
89 "#<XXX UNUSED BOOLEAN 0 -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
90 "#<XXX UNUSED BOOLEAN 1 -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
91 "#<XXX UNUSED BOOLEAN 2 -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
92 "#<unspecified>",
93 "#<undefined>",
94 "#<eof>",
95
96 /* Unbound slot marker for GOOPS. For internal use in GOOPS only. */
97 "#<unbound>",
98 };
99
100 SCM_SYMBOL (sym_reader, "reader");
101
102 scm_t_option scm_print_opts[] = {
103 { SCM_OPTION_SCM, "highlight-prefix", (scm_t_bits)SCM_BOOL_F_BITS,
104 "The string to print before highlighted values." },
105 { SCM_OPTION_SCM, "highlight-suffix", (scm_t_bits)SCM_BOOL_F_BITS,
106 "The string to print after highlighted values." },
107 { SCM_OPTION_SCM, "quote-keywordish-symbols", (scm_t_bits)SCM_BOOL_F_BITS,
108 "How to print symbols that have a colon as their first or last character. "
109 "The value '#f' does not quote the colons; '#t' quotes them; "
110 "'reader' quotes them when the reader option 'keywords' is not '#f'."
111 },
112 { 0 },
113 };
114
115 SCM_DEFINE (scm_print_options, "print-options-interface", 0, 1, 0,
116 (SCM setting),
117 "Option interface for the print options. Instead of using\n"
118 "this procedure directly, use the procedures\n"
119 "@code{print-enable}, @code{print-disable}, @code{print-set!}\n"
120 "and @code{print-options}.")
121 #define FUNC_NAME s_scm_print_options
122 {
123 SCM ans = scm_options (setting,
124 scm_print_opts,
125 FUNC_NAME);
126 return ans;
127 }
128 #undef FUNC_NAME
129
130 \f
131 /* {Printing of Scheme Objects}
132 */
133
134 /* Detection of circular references.
135 *
136 * Due to other constraints in the implementation, this code has bad
137 * time complexity (O (depth * N)), The printer code can be
138 * rewritten to be O(N).
139 */
140 #define PUSH_REF(pstate, obj) \
141 do \
142 { \
143 PSTATE_STACK_SET (pstate, pstate->top, obj); \
144 pstate->top++; \
145 if (pstate->top == pstate->ceiling) \
146 grow_ref_stack (pstate); \
147 } while(0)
148
149 #define ENTER_NESTED_DATA(pstate, obj, label) \
150 do \
151 { \
152 register unsigned long i; \
153 for (i = 0; i < pstate->top; ++i) \
154 if (scm_is_eq (PSTATE_STACK_REF (pstate, i), (obj))) \
155 goto label; \
156 if (pstate->fancyp) \
157 { \
158 if (pstate->top - pstate->list_offset >= pstate->level) \
159 { \
160 scm_putc ('#', port); \
161 return; \
162 } \
163 } \
164 PUSH_REF(pstate, obj); \
165 } while(0)
166
167 #define EXIT_NESTED_DATA(pstate) \
168 do \
169 { \
170 --pstate->top; \
171 PSTATE_STACK_SET (pstate, pstate->top, SCM_UNDEFINED); \
172 } \
173 while (0)
174
175 SCM scm_print_state_vtable = SCM_BOOL_F;
176 static SCM print_state_pool = SCM_EOL;
177 scm_i_pthread_mutex_t print_state_mutex = SCM_I_PTHREAD_MUTEX_INITIALIZER;
178
179 #ifdef GUILE_DEBUG /* Used for debugging purposes */
180
181 SCM_DEFINE (scm_current_pstate, "current-pstate", 0, 0, 0,
182 (),
183 "Return the current-pstate -- the car of the\n"
184 "@code{print_state_pool}. @code{current-pstate} is only\n"
185 "included in @code{--enable-guile-debug} builds.")
186 #define FUNC_NAME s_scm_current_pstate
187 {
188 if (!scm_is_null (print_state_pool))
189 return SCM_CAR (print_state_pool);
190 else
191 return SCM_BOOL_F;
192 }
193 #undef FUNC_NAME
194
195 #endif
196
197 #define PSTATE_SIZE 50L
198
199 static SCM
200 make_print_state (void)
201 {
202 SCM print_state
203 = scm_make_struct (scm_print_state_vtable, SCM_INUM0, SCM_EOL);
204 scm_print_state *pstate = SCM_PRINT_STATE (print_state);
205 pstate->ref_vect = scm_c_make_vector (PSTATE_SIZE, SCM_UNDEFINED);
206 pstate->ceiling = SCM_SIMPLE_VECTOR_LENGTH (pstate->ref_vect);
207 pstate->highlight_objects = SCM_EOL;
208 return print_state;
209 }
210
211 SCM
212 scm_make_print_state ()
213 {
214 SCM answer = SCM_BOOL_F;
215
216 /* First try to allocate a print state from the pool */
217 scm_i_pthread_mutex_lock (&print_state_mutex);
218 if (!scm_is_null (print_state_pool))
219 {
220 answer = SCM_CAR (print_state_pool);
221 print_state_pool = SCM_CDR (print_state_pool);
222 }
223 scm_i_pthread_mutex_unlock (&print_state_mutex);
224
225 return scm_is_false (answer) ? make_print_state () : answer;
226 }
227
228 void
229 scm_free_print_state (SCM print_state)
230 {
231 SCM handle;
232 scm_print_state *pstate = SCM_PRINT_STATE (print_state);
233 /* Cleanup before returning print state to pool.
234 * It is better to do it here. Doing it in scm_prin1
235 * would cost more since that function is called much more
236 * often.
237 */
238 pstate->fancyp = 0;
239 pstate->revealed = 0;
240 pstate->highlight_objects = SCM_EOL;
241 scm_i_pthread_mutex_lock (&print_state_mutex);
242 handle = scm_cons (print_state, print_state_pool);
243 print_state_pool = handle;
244 scm_i_pthread_mutex_unlock (&print_state_mutex);
245 }
246
247 SCM
248 scm_i_port_with_print_state (SCM port, SCM print_state)
249 {
250 if (SCM_UNBNDP (print_state))
251 {
252 if (SCM_PORT_WITH_PS_P (port))
253 return port;
254 else
255 print_state = scm_make_print_state ();
256 /* port does not need to be coerced since it doesn't have ps */
257 }
258 else
259 port = SCM_COERCE_OUTPORT (port);
260 SCM_RETURN_NEWSMOB (scm_tc16_port_with_ps,
261 SCM_UNPACK (scm_cons (port, print_state)));
262 }
263
264 static void
265 grow_ref_stack (scm_print_state *pstate)
266 {
267 SCM old_vect = pstate->ref_vect;
268 size_t old_size = SCM_SIMPLE_VECTOR_LENGTH (old_vect);
269 size_t new_size = 2 * pstate->ceiling;
270 SCM new_vect = scm_c_make_vector (new_size, SCM_UNDEFINED);
271 unsigned long int i;
272
273 for (i = 0; i != old_size; ++i)
274 SCM_SIMPLE_VECTOR_SET (new_vect, i, SCM_SIMPLE_VECTOR_REF (old_vect, i));
275
276 pstate->ref_vect = new_vect;
277 pstate->ceiling = new_size;
278 }
279
280 #define PSTATE_STACK_REF(p,i) SCM_SIMPLE_VECTOR_REF((p)->ref_vect, (i))
281 #define PSTATE_STACK_SET(p,i,v) SCM_SIMPLE_VECTOR_SET((p)->ref_vect, (i), (v))
282
283 static void
284 print_circref (SCM port, scm_print_state *pstate, SCM ref)
285 {
286 register long i;
287 long self = pstate->top - 1;
288 i = pstate->top - 1;
289 if (scm_is_pair (PSTATE_STACK_REF (pstate, i)))
290 {
291 while (i > 0)
292 {
293 if (!scm_is_pair (PSTATE_STACK_REF (pstate, i-1))
294 || !scm_is_eq (SCM_CDR (PSTATE_STACK_REF (pstate, i-1)),
295 SCM_CDR (PSTATE_STACK_REF (pstate, i))))
296 break;
297 --i;
298 }
299 self = i;
300 }
301 for (i = pstate->top - 1; 1; --i)
302 if (scm_is_eq (PSTATE_STACK_REF(pstate, i), ref))
303 break;
304 scm_putc ('#', port);
305 scm_intprint (i - self, 10, port);
306 scm_putc ('#', port);
307 }
308
309 /* Print the name of a symbol. */
310
311 static int
312 quote_keywordish_symbols (void)
313 {
314 SCM option = SCM_PRINT_KEYWORD_STYLE;
315
316 if (scm_is_false (option))
317 return 0;
318 if (scm_is_eq (option, sym_reader))
319 return scm_is_true (SCM_PACK (SCM_KEYWORD_STYLE));
320 return 1;
321 }
322
323 #define INITIAL_IDENTIFIER_MASK \
324 (UC_CATEGORY_MASK_Lu | UC_CATEGORY_MASK_Ll | UC_CATEGORY_MASK_Lt \
325 | UC_CATEGORY_MASK_Lm | UC_CATEGORY_MASK_Lo | UC_CATEGORY_MASK_Mn \
326 | UC_CATEGORY_MASK_Nl | UC_CATEGORY_MASK_No | UC_CATEGORY_MASK_Pd \
327 | UC_CATEGORY_MASK_Pc | UC_CATEGORY_MASK_Po | UC_CATEGORY_MASK_Sc \
328 | UC_CATEGORY_MASK_Sm | UC_CATEGORY_MASK_Sk | UC_CATEGORY_MASK_So \
329 | UC_CATEGORY_MASK_Co)
330
331 #define SUBSEQUENT_IDENTIFIER_MASK \
332 (INITIAL_IDENTIFIER_MASK \
333 | UC_CATEGORY_MASK_Nd | UC_CATEGORY_MASK_Mc | UC_CATEGORY_MASK_Me)
334
335 static int
336 symbol_has_extended_read_syntax (SCM sym)
337 {
338 size_t pos, len = scm_i_symbol_length (sym);
339 scm_t_wchar c;
340
341 /* The empty symbol. */
342 if (len == 0)
343 return 1;
344
345 c = scm_i_symbol_ref (sym, 0);
346
347 /* Single dot; conflicts with dotted-pair notation. */
348 if (len == 1 && c == '.')
349 return 1;
350
351 /* Other initial-character constraints. */
352 if (c == '\'' || c == '`' || c == ',' || c == '"' || c == ';' || c == '#')
353 return 1;
354
355 /* Keywords can be identified by trailing colons too. */
356 if (c == ':' || scm_i_symbol_ref (sym, len - 1) == ':')
357 return quote_keywordish_symbols ();
358
359 /* Number-ish symbols. */
360 if (scm_is_true (scm_i_string_to_number (scm_symbol_to_string (sym), 10)))
361 return 1;
362
363 /* Other disallowed first characters. */
364 if (!uc_is_general_category_withtable (c, INITIAL_IDENTIFIER_MASK))
365 return 1;
366
367 /* Otherwise, any character that's in the identifier category mask is
368 fine to pass through as-is, provided it's not one of the ASCII
369 delimiters like `;'. */
370 for (pos = 1; pos < len; pos++)
371 {
372 c = scm_i_symbol_ref (sym, pos);
373 if (!uc_is_general_category_withtable (c, SUBSEQUENT_IDENTIFIER_MASK))
374 return 1;
375 else if (c == '"' || c == ';' || c == '#')
376 return 1;
377 }
378
379 return 0;
380 }
381
382 static void
383 print_normal_symbol (SCM sym, SCM port)
384 {
385 scm_display (scm_symbol_to_string (sym), port);
386 }
387
388 static void
389 print_extended_symbol (SCM sym, SCM port)
390 {
391 size_t pos, len;
392 scm_t_string_failed_conversion_handler strategy;
393
394 len = scm_i_symbol_length (sym);
395 strategy = scm_i_get_conversion_strategy (port);
396
397 scm_lfwrite ("#{", 2, port);
398
399 for (pos = 0; pos < len; pos++)
400 {
401 scm_t_wchar c = scm_i_symbol_ref (sym, pos);
402
403 if (uc_is_general_category_withtable (c,
404 SUBSEQUENT_IDENTIFIER_MASK
405 | UC_CATEGORY_MASK_Zs))
406 {
407 if (!display_character (c, port, strategy))
408 scm_encoding_error ("print_extended_symbol", errno,
409 "cannot convert to output locale",
410 port, SCM_MAKE_CHAR (c));
411 }
412 else
413 {
414 display_string ("\\x", 1, 2, port, iconveh_question_mark);
415 scm_intprint (c, 16, port);
416 display_character (';', port, iconveh_question_mark);
417 }
418 }
419
420 scm_lfwrite ("}#", 2, port);
421 }
422
423 /* FIXME: allow R6RS hex escapes instead of #{...}#. */
424 void
425 scm_i_print_symbol_name (SCM sym, SCM port)
426 {
427 if (symbol_has_extended_read_syntax (sym))
428 print_extended_symbol (sym, port);
429 else
430 print_normal_symbol (sym, port);
431 }
432
433 void
434 scm_print_symbol_name (const char *str, size_t len, SCM port)
435 {
436 SCM symbol = scm_from_locale_symboln (str, len);
437 scm_i_print_symbol_name (symbol, port);
438 }
439
440 /* Print generally. Handles both write and display according to PSTATE.
441 */
442 SCM_GPROC(s_write, "write", 1, 1, 0, scm_write, g_write);
443 SCM_GPROC(s_display, "display", 1, 1, 0, scm_display, g_display);
444
445 static void iprin1 (SCM exp, SCM port, scm_print_state *pstate);
446
447
448 /* Print a character as an octal or hex escape. */
449 #define PRINT_CHAR_ESCAPE(i, port) \
450 do \
451 { \
452 if (!SCM_R6RS_ESCAPES_P) \
453 scm_intprint (i, 8, port); \
454 else \
455 { \
456 scm_puts ("x", port); \
457 scm_intprint (i, 16, port); \
458 } \
459 } \
460 while (0)
461
462
463 void
464 scm_iprin1 (SCM exp, SCM port, scm_print_state *pstate)
465 {
466 if (pstate->fancyp
467 && scm_is_true (scm_memq (exp, pstate->highlight_objects)))
468 {
469 scm_display (SCM_PRINT_HIGHLIGHT_PREFIX, port);
470 iprin1 (exp, port, pstate);
471 scm_display (SCM_PRINT_HIGHLIGHT_SUFFIX, port);
472 }
473 else
474 iprin1 (exp, port, pstate);
475 }
476
477 static void
478 iprin1 (SCM exp, SCM port, scm_print_state *pstate)
479 {
480 switch (SCM_ITAG3 (exp))
481 {
482 case scm_tc3_tc7_1:
483 case scm_tc3_tc7_2:
484 /* These tc3 tags should never occur in an immediate value. They are
485 * only used in cell types of non-immediates, i. e. the value returned
486 * by SCM_CELL_TYPE (exp) can use these tags.
487 */
488 scm_ipruk ("immediate", exp, port);
489 break;
490 case scm_tc3_int_1:
491 case scm_tc3_int_2:
492 scm_intprint (SCM_I_INUM (exp), 10, port);
493 break;
494 case scm_tc3_imm24:
495 if (SCM_CHARP (exp))
496 {
497 if (SCM_WRITINGP (pstate))
498 write_character (SCM_CHAR (exp), port, 0);
499 else
500 {
501 if (!display_character (SCM_CHAR (exp), port,
502 scm_i_get_conversion_strategy (port)))
503 scm_encoding_error (__func__, errno,
504 "cannot convert to output locale",
505 port, exp);
506 }
507 }
508 else if (SCM_IFLAGP (exp)
509 && ((size_t) SCM_IFLAGNUM (exp) < (sizeof iflagnames / sizeof (char *))))
510 {
511 scm_puts (iflagnames [SCM_IFLAGNUM (exp)], port);
512 }
513 else
514 {
515 /* unknown immediate value */
516 scm_ipruk ("immediate", exp, port);
517 }
518 break;
519 case scm_tc3_cons:
520 switch (SCM_TYP7 (exp))
521 {
522 case scm_tcs_struct:
523 {
524 ENTER_NESTED_DATA (pstate, exp, circref);
525 if (SCM_OBJ_CLASS_FLAGS (exp) & SCM_CLASSF_GOOPS)
526 {
527 SCM pwps, print = pstate->writingp ? g_write : g_display;
528 if (SCM_UNPACK (print) == 0)
529 goto print_struct;
530 pwps = scm_i_port_with_print_state (port, pstate->handle);
531 pstate->revealed = 1;
532 scm_call_generic_2 (print, exp, pwps);
533 }
534 else
535 {
536 print_struct:
537 scm_print_struct (exp, port, pstate);
538 }
539 EXIT_NESTED_DATA (pstate);
540 }
541 break;
542 case scm_tcs_cons_imcar:
543 case scm_tcs_cons_nimcar:
544 ENTER_NESTED_DATA (pstate, exp, circref);
545 scm_iprlist ("(", exp, ')', port, pstate);
546 EXIT_NESTED_DATA (pstate);
547 break;
548 circref:
549 print_circref (port, pstate, exp);
550 break;
551 case scm_tc7_number:
552 switch SCM_TYP16 (exp) {
553 case scm_tc16_big:
554 scm_bigprint (exp, port, pstate);
555 break;
556 case scm_tc16_real:
557 scm_print_real (exp, port, pstate);
558 break;
559 case scm_tc16_complex:
560 scm_print_complex (exp, port, pstate);
561 break;
562 case scm_tc16_fraction:
563 scm_i_print_fraction (exp, port, pstate);
564 break;
565 }
566 break;
567 case scm_tc7_string:
568 if (SCM_WRITINGP (pstate))
569 {
570 size_t len, i;
571
572 display_character ('"', port, iconveh_question_mark);
573 len = scm_i_string_length (exp);
574 for (i = 0; i < len; ++i)
575 write_character (scm_i_string_ref (exp, i), port, 1);
576
577 display_character ('"', port, iconveh_question_mark);
578 scm_remember_upto_here_1 (exp);
579 }
580 else
581 {
582 size_t len, printed;
583
584 len = scm_i_string_length (exp);
585 printed = display_string (scm_i_string_data (exp),
586 scm_i_is_narrow_string (exp),
587 len, port,
588 scm_i_get_conversion_strategy (port));
589 if (SCM_UNLIKELY (printed < len))
590 scm_encoding_error (__func__, errno,
591 "cannot convert to output locale",
592 port, scm_c_string_ref (exp, printed));
593 }
594
595 scm_remember_upto_here_1 (exp);
596 break;
597 case scm_tc7_symbol:
598 if (scm_i_symbol_is_interned (exp))
599 {
600 scm_i_print_symbol_name (exp, port);
601 scm_remember_upto_here_1 (exp);
602 }
603 else
604 {
605 scm_puts ("#<uninterned-symbol ", port);
606 scm_i_print_symbol_name (exp, port);
607 scm_putc (' ', port);
608 scm_uintprint (SCM_UNPACK (exp), 16, port);
609 scm_putc ('>', port);
610 }
611 break;
612 case scm_tc7_variable:
613 scm_i_variable_print (exp, port, pstate);
614 break;
615 case scm_tc7_program:
616 scm_i_program_print (exp, port, pstate);
617 break;
618 case scm_tc7_pointer:
619 scm_i_pointer_print (exp, port, pstate);
620 break;
621 case scm_tc7_hashtable:
622 scm_i_hashtable_print (exp, port, pstate);
623 break;
624 case scm_tc7_fluid:
625 scm_i_fluid_print (exp, port, pstate);
626 break;
627 case scm_tc7_dynamic_state:
628 scm_i_dynamic_state_print (exp, port, pstate);
629 break;
630 case scm_tc7_frame:
631 scm_i_frame_print (exp, port, pstate);
632 break;
633 case scm_tc7_objcode:
634 scm_i_objcode_print (exp, port, pstate);
635 break;
636 case scm_tc7_vm:
637 scm_i_vm_print (exp, port, pstate);
638 break;
639 case scm_tc7_vm_cont:
640 scm_i_vm_cont_print (exp, port, pstate);
641 break;
642 case scm_tc7_prompt:
643 scm_i_prompt_print (exp, port, pstate);
644 break;
645 case scm_tc7_with_fluids:
646 scm_i_with_fluids_print (exp, port, pstate);
647 break;
648 case scm_tc7_wvect:
649 ENTER_NESTED_DATA (pstate, exp, circref);
650 if (SCM_IS_WHVEC (exp))
651 scm_puts ("#wh(", port);
652 else
653 scm_puts ("#w(", port);
654 goto common_vector_printer;
655
656 case scm_tc7_bytevector:
657 scm_i_print_bytevector (exp, port, pstate);
658 break;
659 case scm_tc7_vector:
660 ENTER_NESTED_DATA (pstate, exp, circref);
661 scm_puts ("#(", port);
662 common_vector_printer:
663 {
664 register long i;
665 long last = SCM_SIMPLE_VECTOR_LENGTH (exp) - 1;
666 int cutp = 0;
667 if (pstate->fancyp
668 && SCM_SIMPLE_VECTOR_LENGTH (exp) > pstate->length)
669 {
670 last = pstate->length - 1;
671 cutp = 1;
672 }
673 if (SCM_I_WVECTP (exp))
674 {
675 /* Elements of weak vectors may not be accessed via the
676 `SIMPLE_VECTOR_REF ()' macro. */
677 for (i = 0; i < last; ++i)
678 {
679 scm_iprin1 (scm_c_vector_ref (exp, i),
680 port, pstate);
681 scm_putc (' ', port);
682 }
683 }
684 else
685 {
686 for (i = 0; i < last; ++i)
687 {
688 scm_iprin1 (SCM_SIMPLE_VECTOR_REF (exp, i), port, pstate);
689 scm_putc (' ', port);
690 }
691 }
692
693 if (i == last)
694 {
695 /* CHECK_INTS; */
696 scm_iprin1 (scm_c_vector_ref (exp, i), port, pstate);
697 }
698 if (cutp)
699 scm_puts (" ...", port);
700 scm_putc (')', port);
701 }
702 EXIT_NESTED_DATA (pstate);
703 break;
704 case scm_tc7_port:
705 {
706 register long i = SCM_PTOBNUM (exp);
707 if (i < scm_numptob
708 && scm_ptobs[i].print
709 && (scm_ptobs[i].print) (exp, port, pstate))
710 break;
711 goto punk;
712 }
713 case scm_tc7_smob:
714 ENTER_NESTED_DATA (pstate, exp, circref);
715 SCM_SMOB_DESCRIPTOR (exp).print (exp, port, pstate);
716 EXIT_NESTED_DATA (pstate);
717 break;
718 default:
719 /* case scm_tcs_closures: */
720 punk:
721 scm_ipruk ("type", exp, port);
722 }
723 }
724 }
725
726 /* Print states are necessary for circular reference safe printing.
727 * They are also expensive to allocate. Therefore print states are
728 * kept in a pool so that they can be reused.
729 */
730
731 /* The PORT argument can also be a print-state/port pair, which will
732 * then be used instead of allocating a new print state. This is
733 * useful for continuing a chain of print calls from Scheme. */
734
735 void
736 scm_prin1 (SCM exp, SCM port, int writingp)
737 {
738 SCM handle = SCM_BOOL_F; /* Will GC protect the handle whilst unlinked */
739 SCM pstate_scm;
740 scm_print_state *pstate;
741 int old_writingp;
742
743 /* If PORT is a print-state/port pair, use that. Else create a new
744 print-state. */
745
746 if (SCM_PORT_WITH_PS_P (port))
747 {
748 pstate_scm = SCM_PORT_WITH_PS_PS (port);
749 port = SCM_PORT_WITH_PS_PORT (port);
750 }
751 else
752 {
753 /* First try to allocate a print state from the pool */
754 scm_i_pthread_mutex_lock (&print_state_mutex);
755 if (!scm_is_null (print_state_pool))
756 {
757 handle = print_state_pool;
758 print_state_pool = SCM_CDR (print_state_pool);
759 }
760 scm_i_pthread_mutex_unlock (&print_state_mutex);
761 if (scm_is_false (handle))
762 handle = scm_list_1 (make_print_state ());
763 pstate_scm = SCM_CAR (handle);
764 }
765
766 pstate = SCM_PRINT_STATE (pstate_scm);
767 old_writingp = pstate->writingp;
768 pstate->writingp = writingp;
769 scm_iprin1 (exp, port, pstate);
770 pstate->writingp = old_writingp;
771
772 /* Return print state to pool if it has been created above and
773 hasn't escaped to Scheme. */
774
775 if (scm_is_true (handle) && !pstate->revealed)
776 {
777 scm_i_pthread_mutex_lock (&print_state_mutex);
778 SCM_SETCDR (handle, print_state_pool);
779 print_state_pool = handle;
780 scm_i_pthread_mutex_unlock (&print_state_mutex);
781 }
782 }
783
784 /* Convert codepoint CH to UTF-8 and store the result in UTF8. Return
785 the number of bytes of the UTF-8-encoded string. */
786 static size_t
787 codepoint_to_utf8 (scm_t_wchar ch, scm_t_uint8 utf8[4])
788 {
789 size_t len;
790 scm_t_uint32 codepoint;
791
792 codepoint = (scm_t_uint32) ch;
793
794 if (codepoint <= 0x7f)
795 {
796 len = 1;
797 utf8[0] = (scm_t_uint8) codepoint;
798 }
799 else if (codepoint <= 0x7ffUL)
800 {
801 len = 2;
802 utf8[0] = 0xc0 | (codepoint >> 6);
803 utf8[1] = 0x80 | (codepoint & 0x3f);
804 }
805 else if (codepoint <= 0xffffUL)
806 {
807 len = 3;
808 utf8[0] = 0xe0 | (codepoint >> 12);
809 utf8[1] = 0x80 | ((codepoint >> 6) & 0x3f);
810 utf8[2] = 0x80 | (codepoint & 0x3f);
811 }
812 else
813 {
814 len = 4;
815 utf8[0] = 0xf0 | (codepoint >> 18);
816 utf8[1] = 0x80 | ((codepoint >> 12) & 0x3f);
817 utf8[2] = 0x80 | ((codepoint >> 6) & 0x3f);
818 utf8[3] = 0x80 | (codepoint & 0x3f);
819 }
820
821 return len;
822 }
823
824 #define STR_REF(s, x) \
825 (narrow_p \
826 ? (scm_t_wchar) ((unsigned char *) (s))[x] \
827 : ((scm_t_wchar *) (s))[x])
828
829 /* Write STR to PORT as UTF-8. STR is a LEN-codepoint string; it is
830 narrow if NARROW_P is true, wide otherwise. Return LEN. */
831 static size_t
832 display_string_as_utf8 (const void *str, int narrow_p, size_t len,
833 SCM port)
834 {
835 size_t printed = 0;
836
837 while (len > printed)
838 {
839 size_t utf8_len, i;
840 char *input, utf8_buf[256];
841
842 /* Convert STR to UTF-8. */
843 for (i = printed, utf8_len = 0, input = utf8_buf;
844 i < len && utf8_len + 4 < sizeof (utf8_buf);
845 i++)
846 {
847 utf8_len += codepoint_to_utf8 (STR_REF (str, i),
848 (scm_t_uint8 *) input);
849 input = utf8_buf + utf8_len;
850 }
851
852 /* INPUT was successfully converted, entirely; print the
853 result. */
854 scm_lfwrite (utf8_buf, utf8_len, port);
855 printed += i - printed;
856 }
857
858 assert (printed == len);
859
860 return len;
861 }
862
863 /* Convert STR through PORT's output conversion descriptor and write the
864 output to PORT. Return the number of codepoints written. */
865 static size_t
866 display_string_using_iconv (const void *str, int narrow_p, size_t len,
867 SCM port,
868 scm_t_string_failed_conversion_handler strategy)
869 {
870 size_t printed;
871 scm_t_port *pt;
872
873 pt = SCM_PTAB_ENTRY (port);
874
875 printed = 0;
876
877 while (len > printed)
878 {
879 size_t done, utf8_len, input_left, output_left, i;
880 size_t codepoints_read, output_len;
881 char *input, *output;
882 char utf8_buf[256], encoded_output[256];
883 size_t offsets[256];
884
885 /* Convert STR to UTF-8. */
886 for (i = printed, utf8_len = 0, input = utf8_buf;
887 i < len && utf8_len + 4 < sizeof (utf8_buf);
888 i++)
889 {
890 offsets[utf8_len] = i;
891 utf8_len += codepoint_to_utf8 (STR_REF (str, i),
892 (scm_t_uint8 *) input);
893 input = utf8_buf + utf8_len;
894 }
895
896 input = utf8_buf;
897 input_left = utf8_len;
898
899 output = encoded_output;
900 output_left = sizeof (encoded_output);
901
902 done = iconv (pt->output_cd, &input, &input_left,
903 &output, &output_left);
904
905 output_len = sizeof (encoded_output) - output_left;
906
907 if (SCM_UNLIKELY (done == (size_t) -1))
908 {
909 int errno_save = errno;
910
911 /* Reset the `iconv' state. */
912 iconv (pt->output_cd, NULL, NULL, NULL, NULL);
913
914 /* Print the OUTPUT_LEN bytes successfully converted. */
915 scm_lfwrite (encoded_output, output_len, port);
916
917 /* See how many input codepoints these OUTPUT_LEN bytes
918 corresponds to. */
919 codepoints_read = offsets[input - utf8_buf] - printed;
920 printed += codepoints_read;
921
922 if (errno_save == EILSEQ &&
923 strategy != SCM_FAILED_CONVERSION_ERROR)
924 {
925 /* Conversion failed somewhere in INPUT and we want to
926 escape or substitute the offending input character. */
927
928 if (strategy == SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE)
929 {
930 scm_t_wchar ch;
931
932 /* Find CH, the offending codepoint, and escape it. */
933 ch = STR_REF (str, offsets[input - utf8_buf]);
934 write_character_escaped (ch, 1, port);
935 }
936 else
937 /* STRATEGY is `SCM_FAILED_CONVERSION_QUESTION_MARK'. */
938 display_string ("?", 1, 1, port, strategy);
939
940 printed++;
941 }
942 else
943 /* Something bad happened that we can't handle: bail out. */
944 break;
945 }
946 else
947 {
948 /* INPUT was successfully converted, entirely; print the
949 result. */
950 scm_lfwrite (encoded_output, output_len, port);
951 codepoints_read = i - printed;
952 printed += codepoints_read;
953 }
954 }
955
956 return printed;
957 }
958
959 #undef STR_REF
960
961 /* Display the LEN codepoints in STR to PORT according to STRATEGY;
962 return the number of codepoints successfully displayed. If NARROW_P,
963 then STR is interpreted as a sequence of `char', denoting a Latin-1
964 string; otherwise it's interpreted as a sequence of
965 `scm_t_wchar'. */
966 static size_t
967 display_string (const void *str, int narrow_p,
968 size_t len, SCM port,
969 scm_t_string_failed_conversion_handler strategy)
970
971 {
972 scm_t_port *pt;
973
974 pt = SCM_PTAB_ENTRY (port);
975
976 if (pt->output_cd == (iconv_t) -1)
977 /* Initialize the conversion descriptors, if needed. */
978 scm_i_set_port_encoding_x (port, pt->encoding);
979
980 /* FIXME: In 2.1, add a flag to determine whether a port is UTF-8. */
981 if (pt->output_cd == (iconv_t) -1)
982 return display_string_as_utf8 (str, narrow_p, len, port);
983 else
984 return display_string_using_iconv (str, narrow_p, len,
985 port, strategy);
986 }
987
988 /* Attempt to display CH to PORT according to STRATEGY. Return non-zero
989 if CH was successfully displayed, zero otherwise (e.g., if it was not
990 representable in PORT's encoding.) */
991 static int
992 display_character (scm_t_wchar ch, SCM port,
993 scm_t_string_failed_conversion_handler strategy)
994 {
995 return display_string (&ch, 0, 1, port, strategy) == 1;
996 }
997
998 /* Attempt to pretty-print CH, a combining character, to PORT. Return
999 zero upon failure, non-zero otherwise. The idea is to print CH above
1000 a dotted circle to make it more visible. */
1001 static int
1002 write_combining_character (scm_t_wchar ch, SCM port)
1003 {
1004 scm_t_wchar str[2];
1005
1006 str[0] = SCM_CODEPOINT_DOTTED_CIRCLE;
1007 str[1] = ch;
1008
1009 return display_string (str, 0, 2, port, iconveh_error) == 2;
1010 }
1011
1012 /* Write CH to PORT in its escaped form, using the string escape syntax
1013 if STRING_ESCAPES_P is non-zero. */
1014 static void
1015 write_character_escaped (scm_t_wchar ch, int string_escapes_p, SCM port)
1016 {
1017 if (string_escapes_p)
1018 {
1019 /* Represent CH using the in-string escape syntax. */
1020
1021 static const char hex[] = "0123456789abcdef";
1022 static const char escapes[7] = "abtnvfr";
1023 char buf[9];
1024
1025 if (ch >= 0x07 && ch <= 0x0D && ch != 0x0A)
1026 {
1027 /* Use special escapes for some C0 controls. */
1028 buf[0] = '\\';
1029 buf[1] = escapes[ch - 0x07];
1030 scm_lfwrite (buf, 2, port);
1031 }
1032 else if (!SCM_R6RS_ESCAPES_P)
1033 {
1034 if (ch <= 0xFF)
1035 {
1036 buf[0] = '\\';
1037 buf[1] = 'x';
1038 buf[2] = hex[ch / 16];
1039 buf[3] = hex[ch % 16];
1040 scm_lfwrite (buf, 4, port);
1041 }
1042 else if (ch <= 0xFFFF)
1043 {
1044 buf[0] = '\\';
1045 buf[1] = 'u';
1046 buf[2] = hex[(ch & 0xF000) >> 12];
1047 buf[3] = hex[(ch & 0xF00) >> 8];
1048 buf[4] = hex[(ch & 0xF0) >> 4];
1049 buf[5] = hex[(ch & 0xF)];
1050 scm_lfwrite (buf, 6, port);
1051 }
1052 else if (ch > 0xFFFF)
1053 {
1054 buf[0] = '\\';
1055 buf[1] = 'U';
1056 buf[2] = hex[(ch & 0xF00000) >> 20];
1057 buf[3] = hex[(ch & 0xF0000) >> 16];
1058 buf[4] = hex[(ch & 0xF000) >> 12];
1059 buf[5] = hex[(ch & 0xF00) >> 8];
1060 buf[6] = hex[(ch & 0xF0) >> 4];
1061 buf[7] = hex[(ch & 0xF)];
1062 scm_lfwrite (buf, 8, port);
1063 }
1064 }
1065 else
1066 {
1067 /* Print an R6RS variable-length hex escape: "\xNNNN;". */
1068 scm_t_wchar ch2 = ch;
1069
1070 int i = 8;
1071 buf[i] = ';';
1072 i --;
1073 if (ch == 0)
1074 buf[i--] = '0';
1075 else
1076 while (ch2 > 0)
1077 {
1078 buf[i] = hex[ch2 & 0xF];
1079 ch2 >>= 4;
1080 i --;
1081 }
1082 buf[i] = 'x';
1083 i --;
1084 buf[i] = '\\';
1085 scm_lfwrite (buf + i, 9 - i, port);
1086 }
1087 }
1088 else
1089 {
1090 /* Represent CH using the character escape syntax. */
1091 const char *name;
1092
1093 name = scm_i_charname (SCM_MAKE_CHAR (ch));
1094 if (name != NULL)
1095 scm_puts (name, port);
1096 else
1097 PRINT_CHAR_ESCAPE (ch, port);
1098 }
1099 }
1100
1101 /* Write CH to PORT, escaping it if it's non-graphic or not
1102 representable in PORT's encoding. If STRING_ESCAPES_P is true and CH
1103 needs to be escaped, it is escaped using the in-string escape syntax;
1104 otherwise the character escape syntax is used. */
1105 static void
1106 write_character (scm_t_wchar ch, SCM port, int string_escapes_p)
1107 {
1108 int printed = 0;
1109 scm_t_string_failed_conversion_handler strategy;
1110
1111 strategy = scm_i_get_conversion_strategy (port);
1112
1113 if (string_escapes_p)
1114 {
1115 /* Check if CH deserves special treatment. */
1116 if (ch == '"' || ch == '\\')
1117 {
1118 display_character ('\\', port, iconveh_question_mark);
1119 display_character (ch, port, strategy);
1120 printed = 1;
1121 }
1122 else if (ch == ' ' || ch == '\n')
1123 {
1124 display_character (ch, port, strategy);
1125 printed = 1;
1126 }
1127 }
1128 else
1129 {
1130 display_string ("#\\", 1, 2, port, iconveh_question_mark);
1131
1132 if (uc_combining_class (ch) != UC_CCC_NR)
1133 /* Character is a combining character, so attempt to
1134 pretty-print it. */
1135 printed = write_combining_character (ch, port);
1136 }
1137
1138 if (!printed
1139 && uc_is_general_category_withtable (ch,
1140 UC_CATEGORY_MASK_L |
1141 UC_CATEGORY_MASK_M |
1142 UC_CATEGORY_MASK_N |
1143 UC_CATEGORY_MASK_P |
1144 UC_CATEGORY_MASK_S))
1145 /* CH is graphic; attempt to display it. */
1146 printed = display_character (ch, port, iconveh_error);
1147
1148 if (!printed)
1149 /* CH isn't graphic or cannot be represented in PORT's encoding. */
1150 write_character_escaped (ch, string_escapes_p, port);
1151 }
1152
1153 /* Print an integer.
1154 */
1155
1156 void
1157 scm_intprint (scm_t_intmax n, int radix, SCM port)
1158 {
1159 char num_buf[SCM_INTBUFLEN];
1160 scm_lfwrite (num_buf, scm_iint2str (n, radix, num_buf), port);
1161 }
1162
1163 void
1164 scm_uintprint (scm_t_uintmax n, int radix, SCM port)
1165 {
1166 char num_buf[SCM_INTBUFLEN];
1167 scm_lfwrite (num_buf, scm_iuint2str (n, radix, num_buf), port);
1168 }
1169
1170 /* Print an object of unrecognized type.
1171 */
1172
1173 void
1174 scm_ipruk (char *hdr, SCM ptr, SCM port)
1175 {
1176 scm_puts ("#<unknown-", port);
1177 scm_puts (hdr, port);
1178 if (1) /* (scm_in_heap_p (ptr)) */ /* FIXME */
1179 {
1180 scm_puts (" (0x", port);
1181 scm_uintprint (SCM_CELL_WORD_0 (ptr), 16, port);
1182 scm_puts (" . 0x", port);
1183 scm_uintprint (SCM_CELL_WORD_1 (ptr), 16, port);
1184 scm_puts (") @", port);
1185 }
1186 scm_puts (" 0x", port);
1187 scm_uintprint (SCM_UNPACK (ptr), 16, port);
1188 scm_putc ('>', port);
1189 }
1190
1191
1192 /* Print a list.
1193 */
1194 void
1195 scm_iprlist (char *hdr, SCM exp, int tlr, SCM port, scm_print_state *pstate)
1196 {
1197 register SCM hare, tortoise;
1198 long floor = pstate->top - 2;
1199 scm_puts (hdr, port);
1200 /* CHECK_INTS; */
1201 if (pstate->fancyp)
1202 goto fancy_printing;
1203
1204 /* Run a hare and tortoise so that total time complexity will be
1205 O(depth * N) instead of O(N^2). */
1206 hare = SCM_CDR (exp);
1207 tortoise = exp;
1208 while (scm_is_pair (hare))
1209 {
1210 if (scm_is_eq (hare, tortoise))
1211 goto fancy_printing;
1212 hare = SCM_CDR (hare);
1213 if (!scm_is_pair (hare))
1214 break;
1215 hare = SCM_CDR (hare);
1216 tortoise = SCM_CDR (tortoise);
1217 }
1218
1219 /* No cdr cycles intrinsic to this list */
1220 scm_iprin1 (SCM_CAR (exp), port, pstate);
1221 for (exp = SCM_CDR (exp); scm_is_pair (exp); exp = SCM_CDR (exp))
1222 {
1223 register long i;
1224
1225 for (i = floor; i >= 0; --i)
1226 if (scm_is_eq (PSTATE_STACK_REF(pstate, i), exp))
1227 goto circref;
1228 PUSH_REF (pstate, exp);
1229 scm_putc (' ', port);
1230 /* CHECK_INTS; */
1231 scm_iprin1 (SCM_CAR (exp), port, pstate);
1232 }
1233 if (!SCM_NULL_OR_NIL_P (exp))
1234 {
1235 scm_puts (" . ", port);
1236 scm_iprin1 (exp, port, pstate);
1237 }
1238
1239 end:
1240 scm_putc (tlr, port);
1241 pstate->top = floor + 2;
1242 return;
1243
1244 fancy_printing:
1245 {
1246 long n = pstate->length;
1247
1248 scm_iprin1 (SCM_CAR (exp), port, pstate);
1249 exp = SCM_CDR (exp); --n;
1250 for (; scm_is_pair (exp); exp = SCM_CDR (exp))
1251 {
1252 register unsigned long i;
1253
1254 for (i = 0; i < pstate->top; ++i)
1255 if (scm_is_eq (PSTATE_STACK_REF(pstate, i), exp))
1256 goto fancy_circref;
1257 if (pstate->fancyp)
1258 {
1259 if (n == 0)
1260 {
1261 scm_puts (" ...", port);
1262 goto skip_tail;
1263 }
1264 else
1265 --n;
1266 }
1267 PUSH_REF(pstate, exp);
1268 ++pstate->list_offset;
1269 scm_putc (' ', port);
1270 /* CHECK_INTS; */
1271 scm_iprin1 (SCM_CAR (exp), port, pstate);
1272 }
1273 }
1274 if (!SCM_NULL_OR_NIL_P (exp))
1275 {
1276 scm_puts (" . ", port);
1277 scm_iprin1 (exp, port, pstate);
1278 }
1279 skip_tail:
1280 pstate->list_offset -= pstate->top - floor - 2;
1281 goto end;
1282
1283 fancy_circref:
1284 pstate->list_offset -= pstate->top - floor - 2;
1285
1286 circref:
1287 scm_puts (" . ", port);
1288 print_circref (port, pstate, exp);
1289 goto end;
1290 }
1291
1292 \f
1293
1294 int
1295 scm_valid_oport_value_p (SCM val)
1296 {
1297 return (SCM_OPOUTPORTP (val)
1298 || (SCM_PORT_WITH_PS_P (val)
1299 && SCM_OPOUTPORTP (SCM_PORT_WITH_PS_PORT (val))));
1300 }
1301
1302 /* SCM_GPROC(s_write, "write", 1, 1, 0, scm_write, g_write); */
1303
1304 SCM
1305 scm_write (SCM obj, SCM port)
1306 {
1307 if (SCM_UNBNDP (port))
1308 port = scm_current_output_port ();
1309
1310 SCM_ASSERT (scm_valid_oport_value_p (port), port, SCM_ARG2, s_write);
1311
1312 scm_prin1 (obj, port, 1);
1313 return SCM_UNSPECIFIED;
1314 }
1315
1316
1317 /* SCM_GPROC(s_display, "display", 1, 1, 0, scm_display, g_display); */
1318
1319 SCM
1320 scm_display (SCM obj, SCM port)
1321 {
1322 if (SCM_UNBNDP (port))
1323 port = scm_current_output_port ();
1324
1325 SCM_ASSERT (scm_valid_oport_value_p (port), port, SCM_ARG2, s_display);
1326
1327 scm_prin1 (obj, port, 0);
1328 return SCM_UNSPECIFIED;
1329 }
1330
1331
1332 SCM_DEFINE (scm_simple_format, "simple-format", 2, 0, 1,
1333 (SCM destination, SCM message, SCM args),
1334 "Write @var{message} to @var{destination}, defaulting to\n"
1335 "the current output port.\n"
1336 "@var{message} can contain @code{~A} (was @code{%s}) and\n"
1337 "@code{~S} (was @code{%S}) escapes. When printed,\n"
1338 "the escapes are replaced with corresponding members of\n"
1339 "@var{ARGS}:\n"
1340 "@code{~A} formats using @code{display} and @code{~S} formats\n"
1341 "using @code{write}.\n"
1342 "If @var{destination} is @code{#t}, then use the current output\n"
1343 "port, if @var{destination} is @code{#f}, then return a string\n"
1344 "containing the formatted text. Does not add a trailing newline.")
1345 #define FUNC_NAME s_scm_simple_format
1346 {
1347 SCM port, answer = SCM_UNSPECIFIED;
1348 int fReturnString = 0;
1349 int writingp;
1350 size_t start, p, end;
1351
1352 if (scm_is_eq (destination, SCM_BOOL_T))
1353 {
1354 destination = port = scm_current_output_port ();
1355 }
1356 else if (scm_is_false (destination))
1357 {
1358 fReturnString = 1;
1359 port = scm_mkstrport (SCM_INUM0, SCM_BOOL_F,
1360 SCM_OPN | SCM_WRTNG,
1361 FUNC_NAME);
1362 destination = port;
1363 }
1364 else
1365 {
1366 SCM_VALIDATE_OPORT_VALUE (1, destination);
1367 port = SCM_COERCE_OUTPORT (destination);
1368 }
1369 SCM_VALIDATE_STRING (2, message);
1370 SCM_VALIDATE_REST_ARGUMENT (args);
1371
1372 p = 0;
1373 start = 0;
1374 end = scm_i_string_length (message);
1375 for (p = start; p != end; ++p)
1376 if (scm_i_string_ref (message, p) == '~')
1377 {
1378 if (++p == end)
1379 break;
1380
1381 switch (scm_i_string_ref (message, p))
1382 {
1383 case 'A': case 'a':
1384 writingp = 0;
1385 break;
1386 case 'S': case 's':
1387 writingp = 1;
1388 break;
1389 case '~':
1390 scm_lfwrite_substr (message, start, p, port);
1391 start = p + 1;
1392 continue;
1393 case '%':
1394 scm_lfwrite_substr (message, start, p - 1, port);
1395 scm_newline (port);
1396 start = p + 1;
1397 continue;
1398 default:
1399 SCM_MISC_ERROR ("FORMAT: Unsupported format option ~~~A - use (ice-9 format) instead",
1400 scm_list_1 (SCM_MAKE_CHAR (scm_i_string_ref (message, p))));
1401
1402 }
1403
1404
1405 if (!scm_is_pair (args))
1406 SCM_MISC_ERROR ("FORMAT: Missing argument for ~~~A",
1407 scm_list_1 (SCM_MAKE_CHAR (scm_i_string_ref (message, p))));
1408
1409 scm_lfwrite_substr (message, start, p - 1, port);
1410 /* we pass destination here */
1411 scm_prin1 (SCM_CAR (args), destination, writingp);
1412 args = SCM_CDR (args);
1413 start = p + 1;
1414 }
1415
1416 scm_lfwrite_substr (message, start, p, port);
1417 if (!scm_is_eq (args, SCM_EOL))
1418 SCM_MISC_ERROR ("FORMAT: ~A superfluous arguments",
1419 scm_list_1 (scm_length (args)));
1420
1421 if (fReturnString)
1422 answer = scm_strport_to_string (destination);
1423
1424 return scm_return_first (answer, message);
1425 }
1426 #undef FUNC_NAME
1427
1428
1429 SCM_DEFINE (scm_newline, "newline", 0, 1, 0,
1430 (SCM port),
1431 "Send a newline to @var{port}.\n"
1432 "If @var{port} is omitted, send to the current output port.")
1433 #define FUNC_NAME s_scm_newline
1434 {
1435 if (SCM_UNBNDP (port))
1436 port = scm_current_output_port ();
1437
1438 SCM_VALIDATE_OPORT_VALUE (1, port);
1439
1440 scm_putc ('\n', SCM_COERCE_OUTPORT (port));
1441 return SCM_UNSPECIFIED;
1442 }
1443 #undef FUNC_NAME
1444
1445 SCM_DEFINE (scm_write_char, "write-char", 1, 1, 0,
1446 (SCM chr, SCM port),
1447 "Send character @var{chr} to @var{port}.")
1448 #define FUNC_NAME s_scm_write_char
1449 {
1450 if (SCM_UNBNDP (port))
1451 port = scm_current_output_port ();
1452
1453 SCM_VALIDATE_CHAR (1, chr);
1454 SCM_VALIDATE_OPORT_VALUE (2, port);
1455
1456 port = SCM_COERCE_OUTPORT (port);
1457 if (!display_character (SCM_CHAR (chr), port,
1458 scm_i_get_conversion_strategy (port)))
1459 scm_encoding_error (__func__, errno,
1460 "cannot convert to output locale",
1461 port, chr);
1462
1463 return SCM_UNSPECIFIED;
1464 }
1465 #undef FUNC_NAME
1466
1467 \f
1468
1469 /* Call back to Scheme code to do the printing of special objects
1470 * (like structs). SCM_PRINTER_APPLY applies PROC to EXP and a smob
1471 * containing PORT and PSTATE. This object can be used as the port for
1472 * display/write etc to continue the current print chain. The REVEALED
1473 * field of PSTATE is set to true to indicate that the print state has
1474 * escaped to Scheme and thus has to be freed by the GC.
1475 */
1476
1477 scm_t_bits scm_tc16_port_with_ps;
1478
1479 /* Print exactly as the port itself would */
1480
1481 static int
1482 port_with_ps_print (SCM obj, SCM port, scm_print_state *pstate)
1483 {
1484 obj = SCM_PORT_WITH_PS_PORT (obj);
1485 return scm_ptobs[SCM_PTOBNUM (obj)].print (obj, port, pstate);
1486 }
1487
1488 SCM
1489 scm_printer_apply (SCM proc, SCM exp, SCM port, scm_print_state *pstate)
1490 {
1491 pstate->revealed = 1;
1492 return scm_call_2 (proc, exp,
1493 scm_i_port_with_print_state (port, pstate->handle));
1494 }
1495
1496 SCM_DEFINE (scm_port_with_print_state, "port-with-print-state", 1, 1, 0,
1497 (SCM port, SCM pstate),
1498 "Create a new port which behaves like @var{port}, but with an\n"
1499 "included print state @var{pstate}. @var{pstate} is optional.\n"
1500 "If @var{pstate} isn't supplied and @var{port} already has\n"
1501 "a print state, the old print state is reused.")
1502 #define FUNC_NAME s_scm_port_with_print_state
1503 {
1504 SCM_VALIDATE_OPORT_VALUE (1, port);
1505 if (!SCM_UNBNDP (pstate))
1506 SCM_VALIDATE_PRINTSTATE (2, pstate);
1507 return scm_i_port_with_print_state (port, pstate);
1508 }
1509 #undef FUNC_NAME
1510
1511 SCM_DEFINE (scm_get_print_state, "get-print-state", 1, 0, 0,
1512 (SCM port),
1513 "Return the print state of the port @var{port}. If @var{port}\n"
1514 "has no associated print state, @code{#f} is returned.")
1515 #define FUNC_NAME s_scm_get_print_state
1516 {
1517 if (SCM_PORT_WITH_PS_P (port))
1518 return SCM_PORT_WITH_PS_PS (port);
1519 if (SCM_OUTPUT_PORT_P (port))
1520 return SCM_BOOL_F;
1521 SCM_WRONG_TYPE_ARG (1, port);
1522 }
1523 #undef FUNC_NAME
1524
1525 \f
1526
1527 void
1528 scm_init_print ()
1529 {
1530 SCM vtable, layout, type;
1531
1532 scm_init_opts (scm_print_options, scm_print_opts);
1533
1534 scm_print_options (scm_list_4 (scm_from_latin1_symbol ("highlight-prefix"),
1535 scm_from_locale_string ("{"),
1536 scm_from_latin1_symbol ("highlight-suffix"),
1537 scm_from_locale_string ("}")));
1538
1539 scm_gc_register_root (&print_state_pool);
1540 scm_gc_register_root (&scm_print_state_vtable);
1541 vtable = scm_make_vtable_vtable (scm_nullstr, SCM_INUM0, SCM_EOL);
1542 layout =
1543 scm_make_struct_layout (scm_from_locale_string (SCM_PRINT_STATE_LAYOUT));
1544 type = scm_make_struct (vtable, SCM_INUM0, scm_list_1 (layout));
1545 scm_set_struct_vtable_name_x (type, scm_from_latin1_symbol ("print-state"));
1546 scm_print_state_vtable = type;
1547
1548 /* Don't want to bind a wrapper class in GOOPS, so pass 0 as arg1. */
1549 scm_tc16_port_with_ps = scm_make_smob_type (0, 0);
1550 scm_set_smob_print (scm_tc16_port_with_ps, port_with_ps_print);
1551
1552 #include "libguile/print.x"
1553
1554 scm_print_opts[SCM_PRINT_KEYWORD_STYLE_I].val = SCM_UNPACK (sym_reader);
1555 }
1556
1557 /*
1558 Local Variables:
1559 c-file-style: "gnu"
1560 End:
1561 */