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