Merge remote-tracking branch 'origin/stable-2.0'
[bpt/guile.git] / libguile / print.c
1 /* Copyright (C) 1995-1999, 2000, 2001, 2002, 2003, 2004, 2006, 2008,
2 * 2009, 2010, 2011, 2012 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/programs.h"
44 #include "libguile/alist.h"
45 #include "libguile/struct.h"
46 #include "libguile/ports.h"
47 #include "libguile/root.h"
48 #include "libguile/strings.h"
49 #include "libguile/strports.h"
50 #include "libguile/vectors.h"
51 #include "libguile/numbers.h"
52 #include "libguile/vm.h"
53
54 #include "libguile/validate.h"
55 #include "libguile/print.h"
56
57 #include "libguile/private-options.h"
58
59 \f
60
61 /* Character printers. */
62
63 static size_t display_string (const void *, int, size_t, SCM,
64 scm_t_string_failed_conversion_handler);
65
66 static int display_character (scm_t_wchar, SCM,
67 scm_t_string_failed_conversion_handler);
68
69 static void write_character (scm_t_wchar, SCM, int);
70
71 static void write_character_escaped (scm_t_wchar, int, SCM);
72
73 \f
74
75 /* {Names of immediate symbols}
76 *
77 * This table must agree with the declarations in scm.h: {Immediate Symbols}.
78 */
79
80 /* This table must agree with the list of flags in tags.h. */
81 static const char *iflagnames[] =
82 {
83 "#f",
84 "#nil", /* Elisp nil value. Should print from elisp as symbol `nil'. */
85 "#<XXX UNUSED LISP FALSE -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
86 "()",
87 "#t",
88 "#<XXX UNUSED BOOLEAN 0 -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
89 "#<XXX UNUSED BOOLEAN 1 -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
90 "#<XXX UNUSED BOOLEAN 2 -- DO NOT USE -- SHOULD NEVER BE SEEN XXX>",
91 "#<unspecified>",
92 "#<undefined>",
93 "#<eof>",
94
95 /* Unbound slot marker for GOOPS. For internal use in GOOPS only. */
96 "#<unbound>",
97 };
98
99 SCM_SYMBOL (sym_reader, "reader");
100
101 scm_t_option scm_print_opts[] = {
102 { SCM_OPTION_SCM, "highlight-prefix", (scm_t_bits)SCM_BOOL_F_BITS,
103 "The string to print before highlighted values." },
104 { SCM_OPTION_SCM, "highlight-suffix", (scm_t_bits)SCM_BOOL_F_BITS,
105 "The string to print after highlighted values." },
106 { SCM_OPTION_SCM, "quote-keywordish-symbols", (scm_t_bits)SCM_BOOL_F_BITS,
107 "How to print symbols that have a colon as their first or last character. "
108 "The value '#f' does not quote the colons; '#t' quotes them; "
109 "'reader' quotes them when the reader option 'keywords' is not '#f'." },
110 { SCM_OPTION_BOOLEAN, "escape-newlines", 1,
111 "Render newlines as \\n when printing using `write'." },
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_unlocked ('#', 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_unlocked ('#', port);
305 scm_intprint (i - self, 10, port);
306 scm_putc_unlocked ('#', 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_unlocked ("#{", 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_unlocked ("}#", 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_utf8_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_unlocked ("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_unlocked (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_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_unlocked ("#<uninterned-symbol ", port);
606 scm_i_print_symbol_name (exp, port);
607 scm_putc_unlocked (' ', port);
608 scm_uintprint (SCM_UNPACK (exp), 16, port);
609 scm_putc_unlocked ('>', 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_weak_set:
625 scm_i_weak_set_print (exp, port, pstate);
626 break;
627 case scm_tc7_weak_table:
628 scm_i_weak_table_print (exp, port, pstate);
629 break;
630 case scm_tc7_fluid:
631 scm_i_fluid_print (exp, port, pstate);
632 break;
633 case scm_tc7_dynamic_state:
634 scm_i_dynamic_state_print (exp, port, pstate);
635 break;
636 case scm_tc7_frame:
637 scm_i_frame_print (exp, port, pstate);
638 break;
639 case scm_tc7_objcode:
640 scm_i_objcode_print (exp, port, pstate);
641 break;
642 case scm_tc7_vm:
643 scm_i_vm_print (exp, port, pstate);
644 break;
645 case scm_tc7_vm_cont:
646 scm_i_vm_cont_print (exp, port, pstate);
647 break;
648 case scm_tc7_prompt:
649 scm_i_prompt_print (exp, port, pstate);
650 break;
651 case scm_tc7_with_fluids:
652 scm_i_with_fluids_print (exp, port, pstate);
653 break;
654 case scm_tc7_array:
655 ENTER_NESTED_DATA (pstate, exp, circref);
656 scm_i_print_array (exp, port, pstate);
657 EXIT_NESTED_DATA (pstate);
658 break;
659 case scm_tc7_bytevector:
660 scm_i_print_bytevector (exp, port, pstate);
661 break;
662 case scm_tc7_bitvector:
663 scm_i_print_bitvector (exp, port, pstate);
664 break;
665 case scm_tc7_wvect:
666 ENTER_NESTED_DATA (pstate, exp, circref);
667 scm_puts_unlocked ("#w(", port);
668 goto common_vector_printer;
669 case scm_tc7_vector:
670 ENTER_NESTED_DATA (pstate, exp, circref);
671 scm_puts_unlocked ("#(", port);
672 common_vector_printer:
673 {
674 register long i;
675 long last = SCM_SIMPLE_VECTOR_LENGTH (exp) - 1;
676 int cutp = 0;
677 if (pstate->fancyp
678 && SCM_SIMPLE_VECTOR_LENGTH (exp) > pstate->length)
679 {
680 last = pstate->length - 1;
681 cutp = 1;
682 }
683 for (i = 0; i < last; ++i)
684 {
685 scm_iprin1 (scm_c_vector_ref (exp, i), port, pstate);
686 scm_putc_unlocked (' ', port);
687 }
688 if (i == last)
689 {
690 /* CHECK_INTS; */
691 scm_iprin1 (scm_c_vector_ref (exp, i), port, pstate);
692 }
693 if (cutp)
694 scm_puts_unlocked (" ...", port);
695 scm_putc_unlocked (')', port);
696 }
697 EXIT_NESTED_DATA (pstate);
698 break;
699 case scm_tc7_port:
700 {
701 scm_t_ptob_descriptor *ptob = SCM_PORT_DESCRIPTOR (exp);
702 if (ptob->print && ptob->print (exp, port, pstate))
703 break;
704 goto punk;
705 }
706 case scm_tc7_smob:
707 ENTER_NESTED_DATA (pstate, exp, circref);
708 SCM_SMOB_DESCRIPTOR (exp).print (exp, port, pstate);
709 EXIT_NESTED_DATA (pstate);
710 break;
711 default:
712 /* case scm_tcs_closures: */
713 punk:
714 scm_ipruk ("type", exp, port);
715 }
716 }
717 }
718
719 /* Print states are necessary for circular reference safe printing.
720 * They are also expensive to allocate. Therefore print states are
721 * kept in a pool so that they can be reused.
722 */
723
724 /* The PORT argument can also be a print-state/port pair, which will
725 * then be used instead of allocating a new print state. This is
726 * useful for continuing a chain of print calls from Scheme. */
727
728 void
729 scm_prin1 (SCM exp, SCM port, int writingp)
730 {
731 SCM handle = SCM_BOOL_F; /* Will GC protect the handle whilst unlinked */
732 SCM pstate_scm;
733 scm_print_state *pstate;
734 int old_writingp;
735
736 /* If PORT is a print-state/port pair, use that. Else create a new
737 print-state. */
738
739 if (SCM_PORT_WITH_PS_P (port))
740 {
741 pstate_scm = SCM_PORT_WITH_PS_PS (port);
742 port = SCM_PORT_WITH_PS_PORT (port);
743 }
744 else
745 {
746 /* First try to allocate a print state from the pool */
747 scm_i_pthread_mutex_lock (&print_state_mutex);
748 if (!scm_is_null (print_state_pool))
749 {
750 handle = print_state_pool;
751 print_state_pool = SCM_CDR (print_state_pool);
752 }
753 scm_i_pthread_mutex_unlock (&print_state_mutex);
754 if (scm_is_false (handle))
755 handle = scm_list_1 (make_print_state ());
756 pstate_scm = SCM_CAR (handle);
757 }
758
759 pstate = SCM_PRINT_STATE (pstate_scm);
760 old_writingp = pstate->writingp;
761 pstate->writingp = writingp;
762 scm_iprin1 (exp, port, pstate);
763 pstate->writingp = old_writingp;
764
765 /* Return print state to pool if it has been created above and
766 hasn't escaped to Scheme. */
767
768 if (scm_is_true (handle) && !pstate->revealed)
769 {
770 scm_i_pthread_mutex_lock (&print_state_mutex);
771 SCM_SETCDR (handle, print_state_pool);
772 print_state_pool = handle;
773 scm_i_pthread_mutex_unlock (&print_state_mutex);
774 }
775 }
776
777 /* Convert codepoint CH to UTF-8 and store the result in UTF8. Return
778 the number of bytes of the UTF-8-encoded string. */
779 static size_t
780 codepoint_to_utf8 (scm_t_wchar ch, scm_t_uint8 utf8[4])
781 {
782 size_t len;
783 scm_t_uint32 codepoint;
784
785 codepoint = (scm_t_uint32) ch;
786
787 if (codepoint <= 0x7f)
788 {
789 len = 1;
790 utf8[0] = (scm_t_uint8) codepoint;
791 }
792 else if (codepoint <= 0x7ffUL)
793 {
794 len = 2;
795 utf8[0] = 0xc0 | (codepoint >> 6);
796 utf8[1] = 0x80 | (codepoint & 0x3f);
797 }
798 else if (codepoint <= 0xffffUL)
799 {
800 len = 3;
801 utf8[0] = 0xe0 | (codepoint >> 12);
802 utf8[1] = 0x80 | ((codepoint >> 6) & 0x3f);
803 utf8[2] = 0x80 | (codepoint & 0x3f);
804 }
805 else
806 {
807 len = 4;
808 utf8[0] = 0xf0 | (codepoint >> 18);
809 utf8[1] = 0x80 | ((codepoint >> 12) & 0x3f);
810 utf8[2] = 0x80 | ((codepoint >> 6) & 0x3f);
811 utf8[3] = 0x80 | (codepoint & 0x3f);
812 }
813
814 return len;
815 }
816
817 #define STR_REF(s, x) \
818 (narrow_p \
819 ? (scm_t_wchar) ((unsigned char *) (s))[x] \
820 : ((scm_t_wchar *) (s))[x])
821
822 /* Write STR to PORT as UTF-8. STR is a LEN-codepoint string; it is
823 narrow if NARROW_P is true, wide otherwise. Return LEN. */
824 static size_t
825 display_string_as_utf8 (const void *str, int narrow_p, size_t len,
826 SCM port)
827 {
828 size_t printed = 0;
829
830 while (len > printed)
831 {
832 size_t utf8_len, i;
833 char *input, utf8_buf[256];
834
835 /* Convert STR to UTF-8. */
836 for (i = printed, utf8_len = 0, input = utf8_buf;
837 i < len && utf8_len + 4 < sizeof (utf8_buf);
838 i++)
839 {
840 utf8_len += codepoint_to_utf8 (STR_REF (str, i),
841 (scm_t_uint8 *) input);
842 input = utf8_buf + utf8_len;
843 }
844
845 /* INPUT was successfully converted, entirely; print the
846 result. */
847 scm_lfwrite_unlocked (utf8_buf, utf8_len, port);
848 printed += i - printed;
849 }
850
851 assert (printed == len);
852
853 return len;
854 }
855
856 /* Convert STR through PORT's output conversion descriptor and write the
857 output to PORT. Return the number of codepoints written. */
858 static size_t
859 display_string_using_iconv (const void *str, int narrow_p, size_t len,
860 SCM port,
861 scm_t_string_failed_conversion_handler strategy)
862 {
863 size_t printed;
864 scm_t_port *pt;
865
866 pt = SCM_PTAB_ENTRY (port);
867
868 printed = 0;
869
870 while (len > printed)
871 {
872 size_t done, utf8_len, input_left, output_left, i;
873 size_t codepoints_read, output_len;
874 char *input, *output;
875 char utf8_buf[256], encoded_output[256];
876 size_t offsets[256];
877
878 /* Convert STR to UTF-8. */
879 for (i = printed, utf8_len = 0, input = utf8_buf;
880 i < len && utf8_len + 4 < sizeof (utf8_buf);
881 i++)
882 {
883 offsets[utf8_len] = i;
884 utf8_len += codepoint_to_utf8 (STR_REF (str, i),
885 (scm_t_uint8 *) input);
886 input = utf8_buf + utf8_len;
887 }
888
889 input = utf8_buf;
890 input_left = utf8_len;
891
892 output = encoded_output;
893 output_left = sizeof (encoded_output);
894
895 done = iconv (pt->output_cd, &input, &input_left,
896 &output, &output_left);
897
898 output_len = sizeof (encoded_output) - output_left;
899
900 if (SCM_UNLIKELY (done == (size_t) -1))
901 {
902 int errno_save = errno;
903
904 /* Reset the `iconv' state. */
905 iconv (pt->output_cd, NULL, NULL, NULL, NULL);
906
907 /* Print the OUTPUT_LEN bytes successfully converted. */
908 scm_lfwrite_unlocked (encoded_output, output_len, port);
909
910 /* See how many input codepoints these OUTPUT_LEN bytes
911 corresponds to. */
912 codepoints_read = offsets[input - utf8_buf] - printed;
913 printed += codepoints_read;
914
915 if (errno_save == EILSEQ &&
916 strategy != SCM_FAILED_CONVERSION_ERROR)
917 {
918 /* Conversion failed somewhere in INPUT and we want to
919 escape or substitute the offending input character. */
920
921 if (strategy == SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE)
922 {
923 scm_t_wchar ch;
924
925 /* Find CH, the offending codepoint, and escape it. */
926 ch = STR_REF (str, offsets[input - utf8_buf]);
927 write_character_escaped (ch, 1, port);
928 }
929 else
930 /* STRATEGY is `SCM_FAILED_CONVERSION_QUESTION_MARK'. */
931 display_string ("?", 1, 1, port, strategy);
932
933 printed++;
934 }
935 else
936 /* Something bad happened that we can't handle: bail out. */
937 break;
938 }
939 else
940 {
941 /* INPUT was successfully converted, entirely; print the
942 result. */
943 scm_lfwrite_unlocked (encoded_output, output_len, port);
944 codepoints_read = i - printed;
945 printed += codepoints_read;
946 }
947 }
948
949 return printed;
950 }
951
952 #undef STR_REF
953
954 /* Display the LEN codepoints in STR to PORT according to STRATEGY;
955 return the number of codepoints successfully displayed. If NARROW_P,
956 then STR is interpreted as a sequence of `char', denoting a Latin-1
957 string; otherwise it's interpreted as a sequence of
958 `scm_t_wchar'. */
959 static size_t
960 display_string (const void *str, int narrow_p,
961 size_t len, SCM port,
962 scm_t_string_failed_conversion_handler strategy)
963
964 {
965 scm_t_port *pt;
966
967 pt = SCM_PTAB_ENTRY (port);
968
969 if (pt->output_cd == (iconv_t) -1)
970 /* Initialize the conversion descriptors, if needed. */
971 scm_i_set_port_encoding_x (port, pt->encoding);
972
973 /* FIXME: In 2.1, add a flag to determine whether a port is UTF-8. */
974 if (pt->output_cd == (iconv_t) -1)
975 return display_string_as_utf8 (str, narrow_p, len, port);
976 else
977 return display_string_using_iconv (str, narrow_p, len,
978 port, strategy);
979 }
980
981 /* Attempt to display CH to PORT according to STRATEGY. Return non-zero
982 if CH was successfully displayed, zero otherwise (e.g., if it was not
983 representable in PORT's encoding.) */
984 static int
985 display_character (scm_t_wchar ch, SCM port,
986 scm_t_string_failed_conversion_handler strategy)
987 {
988 return display_string (&ch, 0, 1, port, strategy) == 1;
989 }
990
991 /* Attempt to pretty-print CH, a combining character, to PORT. Return
992 zero upon failure, non-zero otherwise. The idea is to print CH above
993 a dotted circle to make it more visible. */
994 static int
995 write_combining_character (scm_t_wchar ch, SCM port)
996 {
997 scm_t_wchar str[2];
998
999 str[0] = SCM_CODEPOINT_DOTTED_CIRCLE;
1000 str[1] = ch;
1001
1002 return display_string (str, 0, 2, port, iconveh_error) == 2;
1003 }
1004
1005 /* Write CH to PORT in its escaped form, using the string escape syntax
1006 if STRING_ESCAPES_P is non-zero. */
1007 static void
1008 write_character_escaped (scm_t_wchar ch, int string_escapes_p, SCM port)
1009 {
1010 if (string_escapes_p)
1011 {
1012 /* Represent CH using the in-string escape syntax. */
1013
1014 static const char hex[] = "0123456789abcdef";
1015 static const char escapes[7] = "abtnvfr";
1016 char buf[9];
1017
1018 if (ch >= 0x07 && ch <= 0x0D && ch != 0x0A)
1019 {
1020 /* Use special escapes for some C0 controls. */
1021 buf[0] = '\\';
1022 buf[1] = escapes[ch - 0x07];
1023 scm_lfwrite_unlocked (buf, 2, port);
1024 }
1025 else if (!SCM_R6RS_ESCAPES_P)
1026 {
1027 if (ch <= 0xFF)
1028 {
1029 buf[0] = '\\';
1030 buf[1] = 'x';
1031 buf[2] = hex[ch / 16];
1032 buf[3] = hex[ch % 16];
1033 scm_lfwrite_unlocked (buf, 4, port);
1034 }
1035 else if (ch <= 0xFFFF)
1036 {
1037 buf[0] = '\\';
1038 buf[1] = 'u';
1039 buf[2] = hex[(ch & 0xF000) >> 12];
1040 buf[3] = hex[(ch & 0xF00) >> 8];
1041 buf[4] = hex[(ch & 0xF0) >> 4];
1042 buf[5] = hex[(ch & 0xF)];
1043 scm_lfwrite_unlocked (buf, 6, port);
1044 }
1045 else if (ch > 0xFFFF)
1046 {
1047 buf[0] = '\\';
1048 buf[1] = 'U';
1049 buf[2] = hex[(ch & 0xF00000) >> 20];
1050 buf[3] = hex[(ch & 0xF0000) >> 16];
1051 buf[4] = hex[(ch & 0xF000) >> 12];
1052 buf[5] = hex[(ch & 0xF00) >> 8];
1053 buf[6] = hex[(ch & 0xF0) >> 4];
1054 buf[7] = hex[(ch & 0xF)];
1055 scm_lfwrite_unlocked (buf, 8, port);
1056 }
1057 }
1058 else
1059 {
1060 /* Print an R6RS variable-length hex escape: "\xNNNN;". */
1061 scm_t_wchar ch2 = ch;
1062
1063 int i = 8;
1064 buf[i] = ';';
1065 i --;
1066 if (ch == 0)
1067 buf[i--] = '0';
1068 else
1069 while (ch2 > 0)
1070 {
1071 buf[i] = hex[ch2 & 0xF];
1072 ch2 >>= 4;
1073 i --;
1074 }
1075 buf[i] = 'x';
1076 i --;
1077 buf[i] = '\\';
1078 scm_lfwrite_unlocked (buf + i, 9 - i, port);
1079 }
1080 }
1081 else
1082 {
1083 /* Represent CH using the character escape syntax. */
1084 const char *name;
1085
1086 name = scm_i_charname (SCM_MAKE_CHAR (ch));
1087 if (name != NULL)
1088 scm_puts_unlocked (name, port);
1089 else
1090 PRINT_CHAR_ESCAPE (ch, port);
1091 }
1092 }
1093
1094 /* Write CH to PORT, escaping it if it's non-graphic or not
1095 representable in PORT's encoding. If STRING_ESCAPES_P is true and CH
1096 needs to be escaped, it is escaped using the in-string escape syntax;
1097 otherwise the character escape syntax is used. */
1098 static void
1099 write_character (scm_t_wchar ch, SCM port, int string_escapes_p)
1100 {
1101 int printed = 0;
1102 scm_t_string_failed_conversion_handler strategy;
1103
1104 strategy = scm_i_get_conversion_strategy (port);
1105
1106 if (string_escapes_p)
1107 {
1108 /* Check if CH deserves special treatment. */
1109 if (ch == '"' || ch == '\\')
1110 {
1111 display_character ('\\', port, iconveh_question_mark);
1112 display_character (ch, port, strategy);
1113 printed = 1;
1114 }
1115 else if (ch == '\n' && SCM_PRINT_ESCAPE_NEWLINES_P)
1116 {
1117 display_character ('\\', port, iconveh_question_mark);
1118 display_character ('n', port, strategy);
1119 printed = 1;
1120 }
1121 else if (ch == ' ' || ch == '\n')
1122 {
1123 display_character (ch, port, strategy);
1124 printed = 1;
1125 }
1126 }
1127 else
1128 {
1129 display_string ("#\\", 1, 2, port, iconveh_question_mark);
1130
1131 if (uc_combining_class (ch) != UC_CCC_NR)
1132 /* Character is a combining character, so attempt to
1133 pretty-print it. */
1134 printed = write_combining_character (ch, port);
1135 }
1136
1137 if (!printed
1138 && uc_is_general_category_withtable (ch,
1139 UC_CATEGORY_MASK_L |
1140 UC_CATEGORY_MASK_M |
1141 UC_CATEGORY_MASK_N |
1142 UC_CATEGORY_MASK_P |
1143 UC_CATEGORY_MASK_S))
1144 /* CH is graphic; attempt to display it. */
1145 printed = display_character (ch, port, iconveh_error);
1146
1147 if (!printed)
1148 /* CH isn't graphic or cannot be represented in PORT's encoding. */
1149 write_character_escaped (ch, string_escapes_p, port);
1150 }
1151
1152 /* Print an integer.
1153 */
1154
1155 void
1156 scm_intprint (scm_t_intmax n, int radix, SCM port)
1157 {
1158 char num_buf[SCM_INTBUFLEN];
1159 scm_lfwrite_unlocked (num_buf, scm_iint2str (n, radix, num_buf), port);
1160 }
1161
1162 void
1163 scm_uintprint (scm_t_uintmax n, int radix, SCM port)
1164 {
1165 char num_buf[SCM_INTBUFLEN];
1166 scm_lfwrite_unlocked (num_buf, scm_iuint2str (n, radix, num_buf), port);
1167 }
1168
1169 /* Print an object of unrecognized type.
1170 */
1171
1172 void
1173 scm_ipruk (char *hdr, SCM ptr, SCM port)
1174 {
1175 scm_puts_unlocked ("#<unknown-", port);
1176 scm_puts_unlocked (hdr, port);
1177 if (1) /* (scm_in_heap_p (ptr)) */ /* FIXME */
1178 {
1179 scm_puts_unlocked (" (0x", port);
1180 scm_uintprint (SCM_CELL_WORD_0 (ptr), 16, port);
1181 scm_puts_unlocked (" . 0x", port);
1182 scm_uintprint (SCM_CELL_WORD_1 (ptr), 16, port);
1183 scm_puts_unlocked (") @", port);
1184 }
1185 scm_puts_unlocked (" 0x", port);
1186 scm_uintprint (SCM_UNPACK (ptr), 16, port);
1187 scm_putc_unlocked ('>', port);
1188 }
1189
1190
1191 /* Print a list.
1192 */
1193 void
1194 scm_iprlist (char *hdr, SCM exp, int tlr, SCM port, scm_print_state *pstate)
1195 {
1196 register SCM hare, tortoise;
1197 long floor = pstate->top - 2;
1198 scm_puts_unlocked (hdr, port);
1199 /* CHECK_INTS; */
1200 if (pstate->fancyp)
1201 goto fancy_printing;
1202
1203 /* Run a hare and tortoise so that total time complexity will be
1204 O(depth * N) instead of O(N^2). */
1205 hare = SCM_CDR (exp);
1206 tortoise = exp;
1207 while (scm_is_pair (hare))
1208 {
1209 if (scm_is_eq (hare, tortoise))
1210 goto fancy_printing;
1211 hare = SCM_CDR (hare);
1212 if (!scm_is_pair (hare))
1213 break;
1214 hare = SCM_CDR (hare);
1215 tortoise = SCM_CDR (tortoise);
1216 }
1217
1218 /* No cdr cycles intrinsic to this list */
1219 scm_iprin1 (SCM_CAR (exp), port, pstate);
1220 for (exp = SCM_CDR (exp); scm_is_pair (exp); exp = SCM_CDR (exp))
1221 {
1222 register long i;
1223
1224 for (i = floor; i >= 0; --i)
1225 if (scm_is_eq (PSTATE_STACK_REF(pstate, i), exp))
1226 goto circref;
1227 PUSH_REF (pstate, exp);
1228 scm_putc_unlocked (' ', port);
1229 /* CHECK_INTS; */
1230 scm_iprin1 (SCM_CAR (exp), port, pstate);
1231 }
1232 if (!SCM_NULL_OR_NIL_P (exp))
1233 {
1234 scm_puts_unlocked (" . ", port);
1235 scm_iprin1 (exp, port, pstate);
1236 }
1237
1238 end:
1239 scm_putc_unlocked (tlr, port);
1240 pstate->top = floor + 2;
1241 return;
1242
1243 fancy_printing:
1244 {
1245 long n = pstate->length;
1246
1247 scm_iprin1 (SCM_CAR (exp), port, pstate);
1248 exp = SCM_CDR (exp); --n;
1249 for (; scm_is_pair (exp); exp = SCM_CDR (exp))
1250 {
1251 register unsigned long i;
1252
1253 for (i = 0; i < pstate->top; ++i)
1254 if (scm_is_eq (PSTATE_STACK_REF(pstate, i), exp))
1255 goto fancy_circref;
1256 if (pstate->fancyp)
1257 {
1258 if (n == 0)
1259 {
1260 scm_puts_unlocked (" ...", port);
1261 goto skip_tail;
1262 }
1263 else
1264 --n;
1265 }
1266 PUSH_REF(pstate, exp);
1267 ++pstate->list_offset;
1268 scm_putc_unlocked (' ', port);
1269 /* CHECK_INTS; */
1270 scm_iprin1 (SCM_CAR (exp), port, pstate);
1271 }
1272 }
1273 if (!SCM_NULL_OR_NIL_P (exp))
1274 {
1275 scm_puts_unlocked (" . ", port);
1276 scm_iprin1 (exp, port, pstate);
1277 }
1278 skip_tail:
1279 pstate->list_offset -= pstate->top - floor - 2;
1280 goto end;
1281
1282 fancy_circref:
1283 pstate->list_offset -= pstate->top - floor - 2;
1284
1285 circref:
1286 scm_puts_unlocked (" . ", port);
1287 print_circref (port, pstate, exp);
1288 goto end;
1289 }
1290
1291 \f
1292
1293 int
1294 scm_valid_oport_value_p (SCM val)
1295 {
1296 return (SCM_OPOUTPORTP (val)
1297 || (SCM_PORT_WITH_PS_P (val)
1298 && SCM_OPOUTPORTP (SCM_PORT_WITH_PS_PORT (val))));
1299 }
1300
1301 /* SCM_GPROC(s_write, "write", 1, 1, 0, scm_write, g_write); */
1302
1303 SCM
1304 scm_write (SCM obj, SCM port)
1305 {
1306 if (SCM_UNBNDP (port))
1307 port = scm_current_output_port ();
1308
1309 SCM_ASSERT (scm_valid_oport_value_p (port), port, SCM_ARG2, s_write);
1310
1311 scm_dynwind_begin (0);
1312 scm_dynwind_lock_port (SCM_COERCE_OUTPORT (port));
1313 scm_prin1 (obj, port, 1);
1314 scm_dynwind_end ();
1315
1316 return SCM_UNSPECIFIED;
1317 }
1318
1319
1320 /* SCM_GPROC(s_display, "display", 1, 1, 0, scm_display, g_display); */
1321
1322 SCM
1323 scm_display (SCM obj, SCM port)
1324 {
1325 if (SCM_UNBNDP (port))
1326 port = scm_current_output_port ();
1327
1328 SCM_ASSERT (scm_valid_oport_value_p (port), port, SCM_ARG2, s_display);
1329
1330 scm_dynwind_begin (0);
1331 scm_dynwind_lock_port (SCM_COERCE_OUTPORT (port));
1332 scm_prin1 (obj, port, 0);
1333 scm_dynwind_end ();
1334
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_unlocked ('\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_PORT_DESCRIPTOR (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 type;
1538
1539 type = scm_make_vtable (scm_from_locale_string (SCM_PRINT_STATE_LAYOUT),
1540 SCM_BOOL_F);
1541 scm_set_struct_vtable_name_x (type, scm_from_latin1_symbol ("print-state"));
1542 scm_print_state_vtable = type;
1543
1544 /* Don't want to bind a wrapper class in GOOPS, so pass 0 as arg1. */
1545 scm_tc16_port_with_ps = scm_make_smob_type (0, 0);
1546 scm_set_smob_print (scm_tc16_port_with_ps, port_with_ps_print);
1547
1548 #include "libguile/print.x"
1549
1550 scm_init_opts (scm_print_options, scm_print_opts);
1551 scm_print_opts[SCM_PRINT_HIGHLIGHT_PREFIX_I].val =
1552 SCM_UNPACK (scm_from_locale_string ("{"));
1553 scm_print_opts[SCM_PRINT_HIGHLIGHT_SUFFIX_I].val =
1554 SCM_UNPACK (scm_from_locale_string ("}"));
1555 scm_print_opts[SCM_PRINT_KEYWORD_STYLE_I].val = SCM_UNPACK (sym_reader);
1556 }
1557
1558 /*
1559 Local Variables:
1560 c-file-style: "gnu"
1561 End:
1562 */