Merge remote-tracking branch 'origin/stable-2.0'
[bpt/guile.git] / libguile / print.c
CommitLineData
f4bc4e59
LC
1/* Copyright (C) 1995-1999, 2000, 2001, 2002, 2003, 2004, 2006, 2008,
2 * 2009, 2010, 2011 Free Software Foundation, Inc.
3 *
73be1d9e 4 * This library is free software; you can redistribute it and/or
53befeb7
NJ
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.
0f2d19dd 8 *
53befeb7
NJ
9 * This library is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
73be1d9e
MV
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
0f2d19dd 13 *
73be1d9e
MV
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
53befeb7
NJ
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17 * 02110-1301 USA
73be1d9e 18 */
1bbd0b84 19
1bbd0b84 20
0f2d19dd 21\f
dbb605f5
LC
22#ifdef HAVE_CONFIG_H
23# include <config.h>
24#endif
0f2d19dd 25
e6e2e95a 26#include <errno.h>
f4bc4e59
LC
27#include <iconv.h>
28#include <stdio.h>
29#include <assert.h>
30
eca29b02 31#include <uniconv.h>
904a78f1 32#include <unictype.h>
e6e2e95a 33
a0599745
MD
34#include "libguile/_scm.h"
35#include "libguile/chars.h"
a002f1a2 36#include "libguile/continuations.h"
a0599745 37#include "libguile/smob.h"
bbb2ecd1 38#include "libguile/control.h"
a0599745
MD
39#include "libguile/eval.h"
40#include "libguile/macros.h"
41#include "libguile/procprop.h"
42#include "libguile/read.h"
2fb924f6 43#include "libguile/programs.h"
a0599745
MD
44#include "libguile/alist.h"
45#include "libguile/struct.h"
a0599745
MD
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"
327967ef 51#include "libguile/numbers.h"
6f3b0cc2 52#include "libguile/vm.h"
a0599745
MD
53
54#include "libguile/validate.h"
55#include "libguile/print.h"
22fc179a
HWN
56
57#include "libguile/private-options.h"
58
0f2d19dd
JB
59\f
60
07f49ac7
LC
61/* Character printers. */
62
f4bc4e59
LC
63static size_t display_string (const void *, int, size_t, SCM,
64 scm_t_string_failed_conversion_handler);
65
07f49ac7
LC
66static int display_character (scm_t_wchar, SCM,
67 scm_t_string_failed_conversion_handler);
f4bc4e59 68
07f49ac7
LC
69static void write_character (scm_t_wchar, SCM, int);
70
f4bc4e59
LC
71static void write_character_escaped (scm_t_wchar, int, SCM);
72
07f49ac7
LC
73\f
74
0f2d19dd
JB
75/* {Names of immediate symbols}
76 *
77 * This table must agree with the declarations in scm.h: {Immediate Symbols}.
78 */
79
e17d318f
DH
80/* This table must agree with the list of flags in tags.h. */
81static const char *iflagnames[] =
82{
83 "#f",
45f4cbdf
MW
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 "()",
e17d318f 87 "#t",
f60c2c4e
MW
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>",
45f4cbdf 91 "#<unspecified>",
e17d318f
DH
92 "#<undefined>",
93 "#<eof>",
e17d318f
DH
94
95 /* Unbound slot marker for GOOPS. For internal use in GOOPS only. */
96 "#<unbound>",
e17d318f
DH
97};
98
475fa9a5
MV
99SCM_SYMBOL (sym_reader, "reader");
100
92c2555f 101scm_t_option scm_print_opts[] = {
210c0325 102 { SCM_OPTION_SCM, "highlight-prefix", (scm_t_bits)SCM_BOOL_F_BITS,
81ae25da 103 "The string to print before highlighted values." },
210c0325 104 { SCM_OPTION_SCM, "highlight-suffix", (scm_t_bits)SCM_BOOL_F_BITS,
475fa9a5 105 "The string to print after highlighted values." },
210c0325 106 { SCM_OPTION_SCM, "quote-keywordish-symbols", (scm_t_bits)SCM_BOOL_F_BITS,
475fa9a5
MV
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'."
62560650
HWN
110 },
111 { 0 },
e6e4c9af
MD
112};
113
a1ec6916 114SCM_DEFINE (scm_print_options, "print-options-interface", 0, 1, 0,
1bbd0b84 115 (SCM setting),
71331188 116 "Option interface for the print options. Instead of using\n"
1dd05fd8
MG
117 "this procedure directly, use the procedures\n"
118 "@code{print-enable}, @code{print-disable}, @code{print-set!}\n"
119 "and @code{print-options}.")
1bbd0b84 120#define FUNC_NAME s_scm_print_options
e6e4c9af 121{
a51ea417 122 SCM ans = scm_options (setting,
b7ff98dd 123 scm_print_opts,
1bbd0b84 124 FUNC_NAME);
e6e4c9af
MD
125 return ans;
126}
1bbd0b84 127#undef FUNC_NAME
e6e4c9af 128
0f2d19dd
JB
129\f
130/* {Printing of Scheme Objects}
131 */
132
a51ea417 133/* Detection of circular references.
c62fbfe1
MD
134 *
135 * Due to other constraints in the implementation, this code has bad
5d46ebe3
MD
136 * time complexity (O (depth * N)), The printer code can be
137 * rewritten to be O(N).
a51ea417 138 */
dbb5de29
NJ
139#define PUSH_REF(pstate, obj) \
140do \
141{ \
142 PSTATE_STACK_SET (pstate, pstate->top, obj); \
143 pstate->top++; \
144 if (pstate->top == pstate->ceiling) \
145 grow_ref_stack (pstate); \
1bbd0b84 146} while(0)
a51ea417 147
dbb5de29
NJ
148#define ENTER_NESTED_DATA(pstate, obj, label) \
149do \
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 { \
0607ebbf 159 scm_putc_unlocked ('#', port); \
dbb5de29
NJ
160 return; \
161 } \
162 } \
163 PUSH_REF(pstate, obj); \
1bbd0b84 164} while(0)
a51ea417 165
dbb5de29
NJ
166#define EXIT_NESTED_DATA(pstate) \
167do \
168{ \
169 --pstate->top; \
170 PSTATE_STACK_SET (pstate, pstate->top, SCM_UNDEFINED); \
171} \
172while (0)
c62fbfe1 173
d5cf5324
DH
174SCM scm_print_state_vtable = SCM_BOOL_F;
175static SCM print_state_pool = SCM_EOL;
9de87eea 176scm_i_pthread_mutex_t print_state_mutex = SCM_I_PTHREAD_MUTEX_INITIALIZER;
c4f37e80 177
f843a84c 178#ifdef GUILE_DEBUG /* Used for debugging purposes */
1cc91f1b 179
3b3b36dd 180SCM_DEFINE (scm_current_pstate, "current-pstate", 0, 0, 0,
1bbd0b84 181 (),
d5cf5324 182 "Return the current-pstate -- the car of the\n"
5352393c
MG
183 "@code{print_state_pool}. @code{current-pstate} is only\n"
184 "included in @code{--enable-guile-debug} builds.")
1bbd0b84 185#define FUNC_NAME s_scm_current_pstate
c62fbfe1 186{
d2e53ed6 187 if (!scm_is_null (print_state_pool))
d5cf5324 188 return SCM_CAR (print_state_pool);
a0adfbf0 189 else
0a284a4e 190 return SCM_BOOL_F;
c62fbfe1 191}
1bbd0b84
GB
192#undef FUNC_NAME
193
c62fbfe1
MD
194#endif
195
196#define PSTATE_SIZE 50L
197
698c0295 198static SCM
1bbd0b84 199make_print_state (void)
698c0295 200{
d5cf5324
DH
201 SCM print_state
202 = scm_make_struct (scm_print_state_vtable, SCM_INUM0, SCM_EOL);
bf685b6d 203 scm_print_state *pstate = SCM_PRINT_STATE (print_state);
00ffa0e7 204 pstate->ref_vect = scm_c_make_vector (PSTATE_SIZE, SCM_UNDEFINED);
4057a3e0 205 pstate->ceiling = SCM_SIMPLE_VECTOR_LENGTH (pstate->ref_vect);
d232520a 206 pstate->highlight_objects = SCM_EOL;
698c0295
MD
207 return print_state;
208}
1cc91f1b 209
c62fbfe1
MD
210SCM
211scm_make_print_state ()
c62fbfe1 212{
230d095f 213 SCM answer = SCM_BOOL_F;
698c0295
MD
214
215 /* First try to allocate a print state from the pool */
9de87eea 216 scm_i_pthread_mutex_lock (&print_state_mutex);
d2e53ed6 217 if (!scm_is_null (print_state_pool))
698c0295 218 {
d5cf5324
DH
219 answer = SCM_CAR (print_state_pool);
220 print_state_pool = SCM_CDR (print_state_pool);
698c0295 221 }
9de87eea 222 scm_i_pthread_mutex_unlock (&print_state_mutex);
698c0295 223
7888309b 224 return scm_is_false (answer) ? make_print_state () : answer;
c62fbfe1 225}
a51ea417 226
698c0295 227void
6e8d25a6 228scm_free_print_state (SCM print_state)
698c0295
MD
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;
bb35f315 238 pstate->revealed = 0;
d232520a 239 pstate->highlight_objects = SCM_EOL;
9de87eea 240 scm_i_pthread_mutex_lock (&print_state_mutex);
16d4699b 241 handle = scm_cons (print_state, print_state_pool);
d5cf5324 242 print_state_pool = handle;
9de87eea 243 scm_i_pthread_mutex_unlock (&print_state_mutex);
dfd03fb9
MD
244}
245
246SCM
247scm_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)));
698c0295 261}
1cc91f1b 262
a51ea417 263static void
1bbd0b84 264grow_ref_stack (scm_print_state *pstate)
a51ea417 265{
4057a3e0
MV
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;
00ffa0e7 269 SCM new_vect = scm_c_make_vector (new_size, SCM_UNDEFINED);
b17004b8
DH
270 unsigned long int i;
271
272 for (i = 0; i != old_size; ++i)
4057a3e0 273 SCM_SIMPLE_VECTOR_SET (new_vect, i, SCM_SIMPLE_VECTOR_REF (old_vect, i));
b17004b8
DH
274
275 pstate->ref_vect = new_vect;
bf685b6d 276 pstate->ceiling = new_size;
a51ea417
MD
277}
278
509759dd
MV
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))
1cc91f1b 281
a51ea417 282static void
34d19ef6 283print_circref (SCM port, scm_print_state *pstate, SCM ref)
a51ea417 284{
c014a02e
ML
285 register long i;
286 long self = pstate->top - 1;
c62fbfe1 287 i = pstate->top - 1;
509759dd 288 if (scm_is_pair (PSTATE_STACK_REF (pstate, i)))
c62fbfe1
MD
289 {
290 while (i > 0)
291 {
509759dd
MV
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))))
c62fbfe1
MD
295 break;
296 --i;
297 }
298 self = i;
299 }
300 for (i = pstate->top - 1; 1; --i)
509759dd 301 if (scm_is_eq (PSTATE_STACK_REF(pstate, i), ref))
c62fbfe1 302 break;
0607ebbf 303 scm_putc_unlocked ('#', port);
c62fbfe1 304 scm_intprint (i - self, 10, port);
0607ebbf 305 scm_putc_unlocked ('#', port);
a51ea417
MD
306}
307
6662998f
MV
308/* Print the name of a symbol. */
309
475fa9a5 310static int
15671c6e 311quote_keywordish_symbols (void)
475fa9a5 312{
15671c6e 313 SCM option = SCM_PRINT_KEYWORD_STYLE;
475fa9a5 314
475fa9a5
MV
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
2e9fc9fc
AW
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
15671c6e
AW
334static int
335symbol_has_extended_read_syntax (SCM sym)
6662998f 336{
15671c6e
AW
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. */
2e9fc9fc 351 if (c == '\'' || c == '`' || c == ',' || c == '"' || c == ';' || c == '#')
15671c6e
AW
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
2e9fc9fc
AW
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++)
6662998f 370 {
2e9fc9fc
AW
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;
6662998f 376 }
c6b49e89 377
15671c6e
AW
378 return 0;
379}
380
381static void
382print_normal_symbol (SCM sym, SCM port)
383{
384 scm_display (scm_symbol_to_string (sym), port);
385}
386
15671c6e
AW
387static void
388print_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
f209aeee 396 scm_lfwrite_unlocked ("#{", 2, port);
15671c6e
AW
397
398 for (pos = 0; pos < len; pos++)
399 {
400 scm_t_wchar c = scm_i_symbol_ref (sym, pos);
401
2e9fc9fc
AW
402 if (uc_is_general_category_withtable (c,
403 SUBSEQUENT_IDENTIFIER_MASK
404 | UC_CATEGORY_MASK_Zs))
15671c6e 405 {
15671c6e
AW
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));
2e9fc9fc
AW
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);
15671c6e
AW
416 }
417 }
418
f209aeee 419 scm_lfwrite_unlocked ("}#", 2, port);
15671c6e
AW
420}
421
422/* FIXME: allow R6RS hex escapes instead of #{...}#. */
423void
424scm_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);
6662998f
MV
430}
431
e23106d5
MG
432void
433scm_print_symbol_name (const char *str, size_t len, SCM port)
434{
25d50a05 435 SCM symbol = scm_from_utf8_symboln (str, len);
ab33782c 436 scm_i_print_symbol_name (symbol, port);
e23106d5
MG
437}
438
c62fbfe1 439/* Print generally. Handles both write and display according to PSTATE.
0f2d19dd 440 */
8b840115
MD
441SCM_GPROC(s_write, "write", 1, 1, 0, scm_write, g_write);
442SCM_GPROC(s_display, "display", 1, 1, 0, scm_display, g_display);
1cc91f1b 443
d232520a
MV
444static void iprin1 (SCM exp, SCM port, scm_print_state *pstate);
445
dea901d6
MG
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 { \
0607ebbf 455 scm_puts_unlocked ("x", port); \
dea901d6
MG
456 scm_intprint (i, 16, port); \
457 } \
458 } \
459 while (0)
460
461
0f2d19dd 462void
1bbd0b84 463scm_iprin1 (SCM exp, SCM port, scm_print_state *pstate)
d232520a
MV
464{
465 if (pstate->fancyp
466 && scm_is_true (scm_memq (exp, pstate->highlight_objects)))
467 {
81ae25da 468 scm_display (SCM_PRINT_HIGHLIGHT_PREFIX, port);
d232520a 469 iprin1 (exp, port, pstate);
81ae25da 470 scm_display (SCM_PRINT_HIGHLIGHT_SUFFIX, port);
d232520a
MV
471 }
472 else
473 iprin1 (exp, port, pstate);
474}
475
476static void
477iprin1 (SCM exp, SCM port, scm_print_state *pstate)
0f2d19dd 478{
54778cd3 479 switch (SCM_ITAG3 (exp))
0f2d19dd 480 {
e34f941a
DH
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:
e11e83f3 491 scm_intprint (SCM_I_INUM (exp), 10, port);
0f2d19dd 492 break;
e34f941a 493 case scm_tc3_imm24:
7866a09b 494 if (SCM_CHARP (exp))
0f2d19dd 495 {
b7f3516f 496 if (SCM_WRITINGP (pstate))
07f49ac7
LC
497 write_character (SCM_CHAR (exp), port, 0);
498 else
b7f3516f 499 {
07f49ac7
LC
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",
6851d3be 504 port, exp);
b7f3516f 505 }
0f2d19dd 506 }
a51ea417 507 else if (SCM_IFLAGP (exp)
e17d318f
DH
508 && ((size_t) SCM_IFLAGNUM (exp) < (sizeof iflagnames / sizeof (char *))))
509 {
0607ebbf 510 scm_puts_unlocked (iflagnames [SCM_IFLAGNUM (exp)], port);
e17d318f 511 }
0f2d19dd 512 else
e34f941a
DH
513 {
514 /* unknown immediate value */
515 scm_ipruk ("immediate", exp, port);
516 }
0f2d19dd 517 break;
e34f941a 518 case scm_tc3_cons:
0f2d19dd
JB
519 switch (SCM_TYP7 (exp))
520 {
904a077d
MV
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;
b2b33168 527 if (SCM_UNPACK (print) == 0)
904a077d 528 goto print_struct;
dfd03fb9 529 pwps = scm_i_port_with_print_state (port, pstate->handle);
7663c008 530 pstate->revealed = 1;
fa075d40 531 scm_call_2 (print, exp, pwps);
904a077d
MV
532 }
533 else
534 {
535 print_struct:
536 scm_print_struct (exp, port, pstate);
537 }
538 EXIT_NESTED_DATA (pstate);
539 }
540 break;
0f2d19dd
JB
541 case scm_tcs_cons_imcar:
542 case scm_tcs_cons_nimcar:
c62fbfe1
MD
543 ENTER_NESTED_DATA (pstate, exp, circref);
544 scm_iprlist ("(", exp, ')', port, pstate);
545 EXIT_NESTED_DATA (pstate);
a51ea417
MD
546 break;
547 circref:
c62fbfe1 548 print_circref (port, pstate, exp);
0f2d19dd 549 break;
534c55a9
DH
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;
f92e85f7
MV
561 case scm_tc16_fraction:
562 scm_i_print_fraction (exp, port, pstate);
563 break;
534c55a9
DH
564 }
565 break;
9c44cd45
MG
566 case scm_tc7_string:
567 if (SCM_WRITINGP (pstate))
568 {
07f49ac7 569 size_t len, i;
9c44cd45 570
f4bc4e59 571 display_character ('"', port, iconveh_question_mark);
9c44cd45
MG
572 len = scm_i_string_length (exp);
573 for (i = 0; i < len; ++i)
07f49ac7
LC
574 write_character (scm_i_string_ref (exp, i), port, 1);
575
f4bc4e59 576 display_character ('"', port, iconveh_question_mark);
9c44cd45
MG
577 scm_remember_upto_here_1 (exp);
578 }
579 else
f4bc4e59
LC
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))
f4bc4e59
LC
589 scm_encoding_error (__func__, errno,
590 "cannot convert to output locale",
6851d3be 591 port, scm_c_string_ref (exp, printed));
f4bc4e59
LC
592 }
593
9c44cd45
MG
594 scm_remember_upto_here_1 (exp);
595 break;
28b06554 596 case scm_tc7_symbol:
cc95e00a 597 if (scm_i_symbol_is_interned (exp))
9ff28a13 598 {
e23106d5 599 scm_i_print_symbol_name (exp, port);
9ff28a13
MV
600 scm_remember_upto_here_1 (exp);
601 }
602 else
603 {
0607ebbf 604 scm_puts_unlocked ("#<uninterned-symbol ", port);
e23106d5 605 scm_i_print_symbol_name (exp, port);
0607ebbf 606 scm_putc_unlocked (' ', port);
0345e278 607 scm_uintprint (SCM_UNPACK (exp), 16, port);
0607ebbf 608 scm_putc_unlocked ('>', port);
9ff28a13 609 }
6662998f 610 break;
e5aca4b5
MV
611 case scm_tc7_variable:
612 scm_i_variable_print (exp, port, pstate);
613 break;
2fb924f6
AW
614 case scm_tc7_program:
615 scm_i_program_print (exp, port, pstate);
616 break;
5b46a8c2
LC
617 case scm_tc7_pointer:
618 scm_i_pointer_print (exp, port, pstate);
e2c2a699 619 break;
c99de5aa
AW
620 case scm_tc7_hashtable:
621 scm_i_hashtable_print (exp, port, pstate);
622 break;
26b26354
AW
623 case scm_tc7_weak_set:
624 scm_i_weak_set_print (exp, port, pstate);
625 break;
7005c60f
AW
626 case scm_tc7_weak_table:
627 scm_i_weak_table_print (exp, port, pstate);
628 break;
9ea31741
AW
629 case scm_tc7_fluid:
630 scm_i_fluid_print (exp, port, pstate);
631 break;
45cf2428
AW
632 case scm_tc7_dynamic_state:
633 scm_i_dynamic_state_print (exp, port, pstate);
634 break;
6f3b0cc2
AW
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;
bbb2ecd1
AW
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;
0f2d19dd 653 case scm_tc7_wvect:
c62fbfe1 654 ENTER_NESTED_DATA (pstate, exp, circref);
0607ebbf 655 scm_puts_unlocked ("#w(", port);
0f2d19dd
JB
656 goto common_vector_printer;
657
807e5a66
LC
658 case scm_tc7_bytevector:
659 scm_i_print_bytevector (exp, port, pstate);
660 break;
0f2d19dd 661 case scm_tc7_vector:
c62fbfe1 662 ENTER_NESTED_DATA (pstate, exp, circref);
0607ebbf 663 scm_puts_unlocked ("#(", port);
0f2d19dd 664 common_vector_printer:
9fbaf27c 665 {
c014a02e 666 register long i;
4057a3e0 667 long last = SCM_SIMPLE_VECTOR_LENGTH (exp) - 1;
9fbaf27c 668 int cutp = 0;
4057a3e0
MV
669 if (pstate->fancyp
670 && SCM_SIMPLE_VECTOR_LENGTH (exp) > pstate->length)
9fbaf27c
MD
671 {
672 last = pstate->length - 1;
673 cutp = 1;
674 }
a141db86
AW
675 for (i = 0; i < last; ++i)
676 {
677 scm_iprin1 (scm_c_vector_ref (exp, i), port, pstate);
0607ebbf 678 scm_putc_unlocked (' ', port);
a141db86 679 }
9fbaf27c
MD
680 if (i == last)
681 {
682 /* CHECK_INTS; */
c367c4b4 683 scm_iprin1 (scm_c_vector_ref (exp, i), port, pstate);
9fbaf27c
MD
684 }
685 if (cutp)
0607ebbf
AW
686 scm_puts_unlocked (" ...", port);
687 scm_putc_unlocked (')', port);
9fbaf27c 688 }
c62fbfe1 689 EXIT_NESTED_DATA (pstate);
0f2d19dd 690 break;
0f2d19dd 691 case scm_tc7_port:
5ca6dc39 692 {
62bd5d66
AW
693 scm_t_ptob_descriptor *ptob = SCM_PORT_DESCRIPTOR (exp);
694 if (ptob->print && ptob->print (exp, port, pstate))
a51ea417 695 break;
5ca6dc39
JB
696 goto punk;
697 }
698 case scm_tc7_smob:
7a7f7c53
DH
699 ENTER_NESTED_DATA (pstate, exp, circref);
700 SCM_SMOB_DESCRIPTOR (exp).print (exp, port, pstate);
701 EXIT_NESTED_DATA (pstate);
702 break;
0f2d19dd 703 default:
314b8716 704 /* case scm_tcs_closures: */
a51ea417
MD
705 punk:
706 scm_ipruk ("type", exp, port);
0f2d19dd
JB
707 }
708 }
709}
710
c62fbfe1
MD
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 */
1cc91f1b 715
bb35f315
MV
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
a51ea417 720void
1bbd0b84 721scm_prin1 (SCM exp, SCM port, int writingp)
a51ea417 722{
c4f37e80
MV
723 SCM handle = SCM_BOOL_F; /* Will GC protect the handle whilst unlinked */
724 SCM pstate_scm;
c62fbfe1 725 scm_print_state *pstate;
15635be5 726 int old_writingp;
c62fbfe1 727
bb35f315
MV
728 /* If PORT is a print-state/port pair, use that. Else create a new
729 print-state. */
c4f37e80 730
0c95b57d 731 if (SCM_PORT_WITH_PS_P (port))
bb35f315 732 {
52235e71
MD
733 pstate_scm = SCM_PORT_WITH_PS_PS (port);
734 port = SCM_PORT_WITH_PS_PORT (port);
bb35f315
MV
735 }
736 else
c62fbfe1 737 {
c4f37e80 738 /* First try to allocate a print state from the pool */
9de87eea 739 scm_i_pthread_mutex_lock (&print_state_mutex);
d2e53ed6 740 if (!scm_is_null (print_state_pool))
c4f37e80 741 {
d5cf5324
DH
742 handle = print_state_pool;
743 print_state_pool = SCM_CDR (print_state_pool);
c4f37e80 744 }
9de87eea 745 scm_i_pthread_mutex_unlock (&print_state_mutex);
7888309b 746 if (scm_is_false (handle))
d5cf5324 747 handle = scm_list_1 (make_print_state ());
c4f37e80 748 pstate_scm = SCM_CAR (handle);
c62fbfe1 749 }
c62fbfe1 750
c4f37e80 751 pstate = SCM_PRINT_STATE (pstate_scm);
15635be5 752 old_writingp = pstate->writingp;
c62fbfe1
MD
753 pstate->writingp = writingp;
754 scm_iprin1 (exp, port, pstate);
15635be5 755 pstate->writingp = old_writingp;
c62fbfe1 756
bb35f315
MV
757 /* Return print state to pool if it has been created above and
758 hasn't escaped to Scheme. */
759
7888309b 760 if (scm_is_true (handle) && !pstate->revealed)
c4f37e80 761 {
9de87eea 762 scm_i_pthread_mutex_lock (&print_state_mutex);
d5cf5324
DH
763 SCM_SETCDR (handle, print_state_pool);
764 print_state_pool = handle;
9de87eea 765 scm_i_pthread_mutex_unlock (&print_state_mutex);
c4f37e80 766 }
a51ea417
MD
767}
768
f4bc4e59
LC
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. */
771static size_t
772codepoint_to_utf8 (scm_t_wchar ch, scm_t_uint8 utf8[4])
9c44cd45 773{
f4bc4e59
LC
774 size_t len;
775 scm_t_uint32 codepoint;
776
777 codepoint = (scm_t_uint32) ch;
07f49ac7 778
f4bc4e59 779 if (codepoint <= 0x7f)
07f49ac7 780 {
f4bc4e59
LC
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);
07f49ac7
LC
796 }
797 else
798 {
f4bc4e59
LC
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
f4bc4e59
LC
809#define STR_REF(s, x) \
810 (narrow_p \
811 ? (scm_t_wchar) ((unsigned char *) (s))[x] \
812 : ((scm_t_wchar *) (s))[x])
813
7b292a9d
LC
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. */
816static size_t
817display_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. */
f209aeee 839 scm_lfwrite_unlocked (utf8_buf, utf8_len, port);
7b292a9d
LC
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. */
850static size_t
851display_string_using_iconv (const void *str, int narrow_p, size_t len,
852 SCM port,
853 scm_t_string_failed_conversion_handler strategy)
854{
f4bc4e59
LC
855 size_t printed;
856 scm_t_port *pt;
857
858 pt = SCM_PTAB_ENTRY (port);
859
f4bc4e59
LC
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++)
07f49ac7 874 {
f4bc4e59
LC
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);
07f49ac7 889
f4bc4e59
LC
890 output_len = sizeof (encoded_output) - output_left;
891
892 if (SCM_UNLIKELY (done == (size_t) -1))
893 {
b2548e23
AW
894 int errno_save = errno;
895
f4bc4e59
LC
896 /* Reset the `iconv' state. */
897 iconv (pt->output_cd, NULL, NULL, NULL, NULL);
898
7174bc08 899 /* Print the OUTPUT_LEN bytes successfully converted. */
f209aeee 900 scm_lfwrite_unlocked (encoded_output, output_len, port);
7174bc08
LC
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
b2548e23 907 if (errno_save == EILSEQ &&
f4bc4e59 908 strategy != SCM_FAILED_CONVERSION_ERROR)
07f49ac7 909 {
f4bc4e59
LC
910 /* Conversion failed somewhere in INPUT and we want to
911 escape or substitute the offending input character. */
912
f4bc4e59 913 if (strategy == SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE)
f1ee6d54 914 {
f4bc4e59
LC
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);
f1ee6d54 920 }
07f49ac7 921 else
f4bc4e59
LC
922 /* STRATEGY is `SCM_FAILED_CONVERSION_QUESTION_MARK'. */
923 display_string ("?", 1, 1, port, strategy);
9c44cd45 924
f4bc4e59
LC
925 printed++;
926 }
927 else
928 /* Something bad happened that we can't handle: bail out. */
929 break;
07f49ac7
LC
930 }
931 else
f4bc4e59
LC
932 {
933 /* INPUT was successfully converted, entirely; print the
934 result. */
f209aeee 935 scm_lfwrite_unlocked (encoded_output, output_len, port);
f4bc4e59
LC
936 codepoints_read = i - printed;
937 printed += codepoints_read;
938 }
07f49ac7
LC
939 }
940
941 return printed;
7b292a9d
LC
942}
943
f4bc4e59 944#undef STR_REF
7b292a9d
LC
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'. */
951static size_t
952display_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);
f4bc4e59
LC
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.) */
976static int
977display_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;
07f49ac7
LC
981}
982
33d92fe6
LC
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. */
986static int
987write_combining_character (scm_t_wchar ch, SCM port)
988{
f4bc4e59
LC
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}
33d92fe6 996
f4bc4e59
LC
997/* Write CH to PORT in its escaped form, using the string escape syntax
998 if STRING_ESCAPES_P is non-zero. */
999static void
1000write_character_escaped (scm_t_wchar ch, int string_escapes_p, SCM port)
1001{
1002 if (string_escapes_p)
33d92fe6 1003 {
f4bc4e59
LC
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)
33d92fe6 1011 {
f4bc4e59
LC
1012 /* Use special escapes for some C0 controls. */
1013 buf[0] = '\\';
1014 buf[1] = escapes[ch - 0x07];
f209aeee 1015 scm_lfwrite_unlocked (buf, 2, port);
f4bc4e59
LC
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];
f209aeee 1025 scm_lfwrite_unlocked (buf, 4, port);
f4bc4e59
LC
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)];
f209aeee 1035 scm_lfwrite_unlocked (buf, 6, port);
f4bc4e59
LC
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)];
f209aeee 1047 scm_lfwrite_unlocked (buf, 8, port);
f4bc4e59 1048 }
33d92fe6
LC
1049 }
1050 else
f4bc4e59
LC
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] = '\\';
f209aeee 1070 scm_lfwrite_unlocked (buf + i, 9 - i, port);
f4bc4e59 1071 }
33d92fe6
LC
1072 }
1073 else
f4bc4e59
LC
1074 {
1075 /* Represent CH using the character escape syntax. */
1076 const char *name;
33d92fe6 1077
f4bc4e59
LC
1078 name = scm_i_charname (SCM_MAKE_CHAR (ch));
1079 if (name != NULL)
0607ebbf 1080 scm_puts_unlocked (name, port);
f4bc4e59
LC
1081 else
1082 PRINT_CHAR_ESCAPE (ch, port);
1083 }
33d92fe6
LC
1084}
1085
07f49ac7
LC
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. */
1090static void
1091write_character (scm_t_wchar ch, SCM port, int string_escapes_p)
1092{
1093 int printed = 0;
f4bc4e59
LC
1094 scm_t_string_failed_conversion_handler strategy;
1095
1096 strategy = scm_i_get_conversion_strategy (port);
07f49ac7
LC
1097
1098 if (string_escapes_p)
1099 {
1100 /* Check if CH deserves special treatment. */
1101 if (ch == '"' || ch == '\\')
1102 {
f4bc4e59
LC
1103 display_character ('\\', port, iconveh_question_mark);
1104 display_character (ch, port, strategy);
07f49ac7
LC
1105 printed = 1;
1106 }
1107 else if (ch == ' ' || ch == '\n')
1108 {
f4bc4e59 1109 display_character (ch, port, strategy);
07f49ac7
LC
1110 printed = 1;
1111 }
1112 }
1113 else
33d92fe6 1114 {
f4bc4e59 1115 display_string ("#\\", 1, 2, port, iconveh_question_mark);
33d92fe6
LC
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 }
07f49ac7
LC
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)
f4bc4e59
LC
1134 /* CH isn't graphic or cannot be represented in PORT's encoding. */
1135 write_character_escaped (ch, string_escapes_p, port);
9c44cd45 1136}
0f2d19dd
JB
1137
1138/* Print an integer.
1139 */
1cc91f1b 1140
0f2d19dd 1141void
a406c9e9 1142scm_intprint (scm_t_intmax n, int radix, SCM port)
0f2d19dd
JB
1143{
1144 char num_buf[SCM_INTBUFLEN];
f209aeee 1145 scm_lfwrite_unlocked (num_buf, scm_iint2str (n, radix, num_buf), port);
0f2d19dd
JB
1146}
1147
a406c9e9
MV
1148void
1149scm_uintprint (scm_t_uintmax n, int radix, SCM port)
1150{
1151 char num_buf[SCM_INTBUFLEN];
f209aeee 1152 scm_lfwrite_unlocked (num_buf, scm_iuint2str (n, radix, num_buf), port);
a406c9e9
MV
1153}
1154
0f2d19dd
JB
1155/* Print an object of unrecognized type.
1156 */
1cc91f1b 1157
0f2d19dd 1158void
1bbd0b84 1159scm_ipruk (char *hdr, SCM ptr, SCM port)
0f2d19dd 1160{
0607ebbf
AW
1161 scm_puts_unlocked ("#<unknown-", port);
1162 scm_puts_unlocked (hdr, port);
26224b3f 1163 if (1) /* (scm_in_heap_p (ptr)) */ /* FIXME */
0f2d19dd 1164 {
0607ebbf 1165 scm_puts_unlocked (" (0x", port);
0345e278 1166 scm_uintprint (SCM_CELL_WORD_0 (ptr), 16, port);
0607ebbf 1167 scm_puts_unlocked (" . 0x", port);
0345e278 1168 scm_uintprint (SCM_CELL_WORD_1 (ptr), 16, port);
0607ebbf 1169 scm_puts_unlocked (") @", port);
0f2d19dd 1170 }
0607ebbf 1171 scm_puts_unlocked (" 0x", port);
0345e278 1172 scm_uintprint (SCM_UNPACK (ptr), 16, port);
0607ebbf 1173 scm_putc_unlocked ('>', port);
0f2d19dd
JB
1174}
1175
1cc91f1b 1176
904a077d 1177/* Print a list.
22a52da1 1178 */
0f2d19dd 1179void
34d19ef6 1180scm_iprlist (char *hdr, SCM exp, int tlr, SCM port, scm_print_state *pstate)
0f2d19dd 1181{
c62fbfe1 1182 register SCM hare, tortoise;
c014a02e 1183 long floor = pstate->top - 2;
0607ebbf 1184 scm_puts_unlocked (hdr, port);
0f2d19dd 1185 /* CHECK_INTS; */
c62fbfe1
MD
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;
d2e53ed6 1193 while (scm_is_pair (hare))
c62fbfe1 1194 {
bc36d050 1195 if (scm_is_eq (hare, tortoise))
c62fbfe1
MD
1196 goto fancy_printing;
1197 hare = SCM_CDR (hare);
d2e53ed6 1198 if (!scm_is_pair (hare))
c62fbfe1
MD
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);
d2e53ed6 1206 for (exp = SCM_CDR (exp); scm_is_pair (exp); exp = SCM_CDR (exp))
0f2d19dd 1207 {
c014a02e 1208 register long i;
5ca6dc39 1209
c62fbfe1 1210 for (i = floor; i >= 0; --i)
509759dd 1211 if (scm_is_eq (PSTATE_STACK_REF(pstate, i), exp))
c62fbfe1
MD
1212 goto circref;
1213 PUSH_REF (pstate, exp);
0607ebbf 1214 scm_putc_unlocked (' ', port);
0f2d19dd 1215 /* CHECK_INTS; */
c62fbfe1 1216 scm_iprin1 (SCM_CAR (exp), port, pstate);
0f2d19dd 1217 }
c96d76b8 1218 if (!SCM_NULL_OR_NIL_P (exp))
0f2d19dd 1219 {
0607ebbf 1220 scm_puts_unlocked (" . ", port);
c62fbfe1 1221 scm_iprin1 (exp, port, pstate);
0f2d19dd 1222 }
c62fbfe1 1223
a51ea417 1224end:
0607ebbf 1225 scm_putc_unlocked (tlr, port);
c62fbfe1 1226 pstate->top = floor + 2;
a51ea417 1227 return;
c62fbfe1
MD
1228
1229fancy_printing:
1230 {
c014a02e 1231 long n = pstate->length;
c62fbfe1
MD
1232
1233 scm_iprin1 (SCM_CAR (exp), port, pstate);
1234 exp = SCM_CDR (exp); --n;
d2e53ed6 1235 for (; scm_is_pair (exp); exp = SCM_CDR (exp))
c62fbfe1 1236 {
c014a02e 1237 register unsigned long i;
5ca6dc39 1238
c62fbfe1 1239 for (i = 0; i < pstate->top; ++i)
509759dd 1240 if (scm_is_eq (PSTATE_STACK_REF(pstate, i), exp))
c62fbfe1
MD
1241 goto fancy_circref;
1242 if (pstate->fancyp)
1243 {
1244 if (n == 0)
1245 {
0607ebbf 1246 scm_puts_unlocked (" ...", port);
c62fbfe1
MD
1247 goto skip_tail;
1248 }
1249 else
1250 --n;
1251 }
1252 PUSH_REF(pstate, exp);
1253 ++pstate->list_offset;
0607ebbf 1254 scm_putc_unlocked (' ', port);
c62fbfe1
MD
1255 /* CHECK_INTS; */
1256 scm_iprin1 (SCM_CAR (exp), port, pstate);
1257 }
1258 }
c96d76b8 1259 if (!SCM_NULL_OR_NIL_P (exp))
c62fbfe1 1260 {
0607ebbf 1261 scm_puts_unlocked (" . ", port);
c62fbfe1
MD
1262 scm_iprin1 (exp, port, pstate);
1263 }
1264skip_tail:
1265 pstate->list_offset -= pstate->top - floor - 2;
a51ea417 1266 goto end;
a51ea417 1267
c62fbfe1
MD
1268fancy_circref:
1269 pstate->list_offset -= pstate->top - floor - 2;
1270
1271circref:
0607ebbf 1272 scm_puts_unlocked (" . ", port);
c62fbfe1
MD
1273 print_circref (port, pstate, exp);
1274 goto end;
0f2d19dd
JB
1275}
1276
1277\f
1278
bb35f315
MV
1279int
1280scm_valid_oport_value_p (SCM val)
1281{
368cf54d
GB
1282 return (SCM_OPOUTPORTP (val)
1283 || (SCM_PORT_WITH_PS_P (val)
1284 && SCM_OPOUTPORTP (SCM_PORT_WITH_PS_PORT (val))));
bb35f315
MV
1285}
1286
8b840115 1287/* SCM_GPROC(s_write, "write", 1, 1, 0, scm_write, g_write); */
1cc91f1b 1288
0f2d19dd 1289SCM
1bbd0b84 1290scm_write (SCM obj, SCM port)
0f2d19dd
JB
1291{
1292 if (SCM_UNBNDP (port))
9de87eea 1293 port = scm_current_output_port ();
3eb7e6ee
JB
1294
1295 SCM_ASSERT (scm_valid_oport_value_p (port), port, SCM_ARG2, s_write);
bb35f315 1296
215fe3a8
AW
1297 scm_dynwind_begin (0);
1298 scm_dynwind_lock_port (port);
a51ea417 1299 scm_prin1 (obj, port, 1);
215fe3a8
AW
1300 scm_dynwind_end ();
1301
0f2d19dd
JB
1302 return SCM_UNSPECIFIED;
1303}
1304
1305
8b840115 1306/* SCM_GPROC(s_display, "display", 1, 1, 0, scm_display, g_display); */
1cc91f1b 1307
0f2d19dd 1308SCM
1bbd0b84 1309scm_display (SCM obj, SCM port)
0f2d19dd
JB
1310{
1311 if (SCM_UNBNDP (port))
9de87eea 1312 port = scm_current_output_port ();
3eb7e6ee
JB
1313
1314 SCM_ASSERT (scm_valid_oport_value_p (port), port, SCM_ARG2, s_display);
bb35f315 1315
215fe3a8
AW
1316 scm_dynwind_begin (0);
1317 scm_dynwind_lock_port (port);
a51ea417 1318 scm_prin1 (obj, port, 0);
215fe3a8
AW
1319 scm_dynwind_end ();
1320
0f2d19dd
JB
1321 return SCM_UNSPECIFIED;
1322}
1323
70d63753
GB
1324
1325SCM_DEFINE (scm_simple_format, "simple-format", 2, 0, 1,
1326 (SCM destination, SCM message, SCM args),
eca65e90
MG
1327 "Write @var{message} to @var{destination}, defaulting to\n"
1328 "the current output port.\n"
1329 "@var{message} can contain @code{~A} (was @code{%s}) and\n"
1330 "@code{~S} (was @code{%S}) escapes. When printed,\n"
1331 "the escapes are replaced with corresponding members of\n"
1332 "@var{ARGS}:\n"
1333 "@code{~A} formats using @code{display} and @code{~S} formats\n"
1334 "using @code{write}.\n"
1335 "If @var{destination} is @code{#t}, then use the current output\n"
1336 "port, if @var{destination} is @code{#f}, then return a string\n"
1337 "containing the formatted text. Does not add a trailing newline.")
70d63753
GB
1338#define FUNC_NAME s_scm_simple_format
1339{
dfd03fb9 1340 SCM port, answer = SCM_UNSPECIFIED;
70d63753
GB
1341 int fReturnString = 0;
1342 int writingp;
889975e5 1343 size_t start, p, end;
70d63753 1344
bc36d050 1345 if (scm_is_eq (destination, SCM_BOOL_T))
daba1a71 1346 {
9de87eea 1347 destination = port = scm_current_output_port ();
daba1a71 1348 }
7888309b 1349 else if (scm_is_false (destination))
daba1a71
MD
1350 {
1351 fReturnString = 1;
0b2c2ba3 1352 port = scm_mkstrport (SCM_INUM0, SCM_BOOL_F,
dfd03fb9
MD
1353 SCM_OPN | SCM_WRTNG,
1354 FUNC_NAME);
1355 destination = port;
daba1a71
MD
1356 }
1357 else
1358 {
1359 SCM_VALIDATE_OPORT_VALUE (1, destination);
dfd03fb9 1360 port = SCM_COERCE_OUTPORT (destination);
daba1a71
MD
1361 }
1362 SCM_VALIDATE_STRING (2, message);
af45e3b0 1363 SCM_VALIDATE_REST_ARGUMENT (args);
70d63753 1364
889975e5
MG
1365 p = 0;
1366 start = 0;
1367 end = scm_i_string_length (message);
b24b5e13 1368 for (p = start; p != end; ++p)
889975e5 1369 if (scm_i_string_ref (message, p) == '~')
70d63753 1370 {
b24b5e13 1371 if (++p == end)
6662998f
MV
1372 break;
1373
889975e5 1374 switch (scm_i_string_ref (message, p))
6662998f
MV
1375 {
1376 case 'A': case 'a':
1377 writingp = 0;
1378 break;
1379 case 'S': case 's':
1380 writingp = 1;
1381 break;
1382 case '~':
889975e5 1383 scm_lfwrite_substr (message, start, p, port);
6662998f
MV
1384 start = p + 1;
1385 continue;
1386 case '%':
889975e5 1387 scm_lfwrite_substr (message, start, p - 1, port);
dfd03fb9 1388 scm_newline (port);
6662998f
MV
1389 start = p + 1;
1390 continue;
1391 default:
1afff620 1392 SCM_MISC_ERROR ("FORMAT: Unsupported format option ~~~A - use (ice-9 format) instead",
889975e5 1393 scm_list_1 (SCM_MAKE_CHAR (scm_i_string_ref (message, p))));
6662998f
MV
1394
1395 }
70d63753 1396
6662998f 1397
d2e53ed6 1398 if (!scm_is_pair (args))
1afff620 1399 SCM_MISC_ERROR ("FORMAT: Missing argument for ~~~A",
889975e5 1400 scm_list_1 (SCM_MAKE_CHAR (scm_i_string_ref (message, p))));
6662998f 1401
889975e5 1402 scm_lfwrite_substr (message, start, p - 1, port);
dfd03fb9 1403 /* we pass destination here */
70d63753
GB
1404 scm_prin1 (SCM_CAR (args), destination, writingp);
1405 args = SCM_CDR (args);
1406 start = p + 1;
1407 }
6662998f 1408
889975e5 1409 scm_lfwrite_substr (message, start, p, port);
bc36d050 1410 if (!scm_is_eq (args, SCM_EOL))
1afff620
KN
1411 SCM_MISC_ERROR ("FORMAT: ~A superfluous arguments",
1412 scm_list_1 (scm_length (args)));
70d63753
GB
1413
1414 if (fReturnString)
1415 answer = scm_strport_to_string (destination);
1416
daba1a71 1417 return scm_return_first (answer, message);
70d63753
GB
1418}
1419#undef FUNC_NAME
1420
1421
3b3b36dd 1422SCM_DEFINE (scm_newline, "newline", 0, 1, 0,
b450f070 1423 (SCM port),
8f85c0c6
NJ
1424 "Send a newline to @var{port}.\n"
1425 "If @var{port} is omitted, send to the current output port.")
1bbd0b84 1426#define FUNC_NAME s_scm_newline
0f2d19dd
JB
1427{
1428 if (SCM_UNBNDP (port))
9de87eea 1429 port = scm_current_output_port ();
3eb7e6ee 1430
34d19ef6 1431 SCM_VALIDATE_OPORT_VALUE (1, port);
bb35f315 1432
0607ebbf 1433 scm_putc_unlocked ('\n', SCM_COERCE_OUTPORT (port));
0f2d19dd
JB
1434 return SCM_UNSPECIFIED;
1435}
1bbd0b84 1436#undef FUNC_NAME
0f2d19dd 1437
3b3b36dd 1438SCM_DEFINE (scm_write_char, "write-char", 1, 1, 0,
b450f070 1439 (SCM chr, SCM port),
eca65e90 1440 "Send character @var{chr} to @var{port}.")
1bbd0b84 1441#define FUNC_NAME s_scm_write_char
0f2d19dd
JB
1442{
1443 if (SCM_UNBNDP (port))
9de87eea 1444 port = scm_current_output_port ();
3eb7e6ee 1445
34d19ef6
HWN
1446 SCM_VALIDATE_CHAR (1, chr);
1447 SCM_VALIDATE_OPORT_VALUE (2, port);
07f49ac7
LC
1448
1449 port = SCM_COERCE_OUTPORT (port);
1450 if (!display_character (SCM_CHAR (chr), port,
1451 scm_i_get_conversion_strategy (port)))
1452 scm_encoding_error (__func__, errno,
1453 "cannot convert to output locale",
6851d3be 1454 port, chr);
07f49ac7 1455
0f2d19dd
JB
1456 return SCM_UNSPECIFIED;
1457}
1bbd0b84 1458#undef FUNC_NAME
0f2d19dd 1459
0f2d19dd
JB
1460\f
1461
bb35f315 1462/* Call back to Scheme code to do the printing of special objects
c19bc088
MD
1463 * (like structs). SCM_PRINTER_APPLY applies PROC to EXP and a smob
1464 * containing PORT and PSTATE. This object can be used as the port for
1465 * display/write etc to continue the current print chain. The REVEALED
1466 * field of PSTATE is set to true to indicate that the print state has
1467 * escaped to Scheme and thus has to be freed by the GC.
1468 */
1469
92c2555f 1470scm_t_bits scm_tc16_port_with_ps;
c19bc088
MD
1471
1472/* Print exactly as the port itself would */
1473
1474static int
e841c3e0 1475port_with_ps_print (SCM obj, SCM port, scm_print_state *pstate)
c19bc088
MD
1476{
1477 obj = SCM_PORT_WITH_PS_PORT (obj);
62bd5d66 1478 return SCM_PORT_DESCRIPTOR (obj)->print (obj, port, pstate);
c19bc088 1479}
c4f37e80
MV
1480
1481SCM
1bbd0b84 1482scm_printer_apply (SCM proc, SCM exp, SCM port, scm_print_state *pstate)
c4f37e80 1483{
bb35f315 1484 pstate->revealed = 1;
dfd03fb9
MD
1485 return scm_call_2 (proc, exp,
1486 scm_i_port_with_print_state (port, pstate->handle));
c19bc088
MD
1487}
1488
dfd03fb9 1489SCM_DEFINE (scm_port_with_print_state, "port-with-print-state", 1, 1, 0,
1bbd0b84 1490 (SCM port, SCM pstate),
71331188 1491 "Create a new port which behaves like @var{port}, but with an\n"
dfd03fb9
MD
1492 "included print state @var{pstate}. @var{pstate} is optional.\n"
1493 "If @var{pstate} isn't supplied and @var{port} already has\n"
1494 "a print state, the old print state is reused.")
1bbd0b84 1495#define FUNC_NAME s_scm_port_with_print_state
c19bc088 1496{
34d19ef6 1497 SCM_VALIDATE_OPORT_VALUE (1, port);
dfd03fb9
MD
1498 if (!SCM_UNBNDP (pstate))
1499 SCM_VALIDATE_PRINTSTATE (2, pstate);
1500 return scm_i_port_with_print_state (port, pstate);
c19bc088 1501}
1bbd0b84 1502#undef FUNC_NAME
c19bc088 1503
a1ec6916 1504SCM_DEFINE (scm_get_print_state, "get-print-state", 1, 0, 0,
1bbd0b84 1505 (SCM port),
71331188
MG
1506 "Return the print state of the port @var{port}. If @var{port}\n"
1507 "has no associated print state, @code{#f} is returned.")
1bbd0b84 1508#define FUNC_NAME s_scm_get_print_state
c19bc088 1509{
368cf54d
GB
1510 if (SCM_PORT_WITH_PS_P (port))
1511 return SCM_PORT_WITH_PS_PS (port);
f5f2dcff 1512 if (SCM_OUTPUT_PORT_P (port))
368cf54d 1513 return SCM_BOOL_F;
276dd677 1514 SCM_WRONG_TYPE_ARG (1, port);
c4f37e80 1515}
1bbd0b84 1516#undef FUNC_NAME
bb35f315 1517
c4f37e80 1518\f
1cc91f1b 1519
0f2d19dd
JB
1520void
1521scm_init_print ()
0f2d19dd 1522{
231dd356 1523 SCM type;
d5cf5324 1524
62560650 1525 scm_init_opts (scm_print_options, scm_print_opts);
d5cf5324 1526
4a655e50 1527 scm_print_options (scm_list_4 (scm_from_latin1_symbol ("highlight-prefix"),
81ae25da 1528 scm_from_locale_string ("{"),
4a655e50 1529 scm_from_latin1_symbol ("highlight-suffix"),
81ae25da
MV
1530 scm_from_locale_string ("}")));
1531
231dd356
AW
1532 type = scm_make_vtable (scm_from_locale_string (SCM_PRINT_STATE_LAYOUT),
1533 SCM_BOOL_F);
4a655e50 1534 scm_set_struct_vtable_name_x (type, scm_from_latin1_symbol ("print-state"));
bb35f315 1535 scm_print_state_vtable = type;
c4f37e80 1536
c19bc088
MD
1537 /* Don't want to bind a wrapper class in GOOPS, so pass 0 as arg1. */
1538 scm_tc16_port_with_ps = scm_make_smob_type (0, 0);
e841c3e0 1539 scm_set_smob_print (scm_tc16_port_with_ps, port_with_ps_print);
81ae25da 1540
a0599745 1541#include "libguile/print.x"
475fa9a5
MV
1542
1543 scm_print_opts[SCM_PRINT_KEYWORD_STYLE_I].val = SCM_UNPACK (sym_reader);
0f2d19dd 1544}
89e00824
ML
1545
1546/*
1547 Local Variables:
1548 c-file-style: "gnu"
1549 End:
1550*/