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