1 /* classes: h_files */
2 
3 #ifndef SCM_PRINT_H
4 #define SCM_PRINT_H
5 
6 /* Copyright (C) 1995,1996,1998,2000,2001, 2003, 2004, 2006 Free Software Foundation, Inc.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this library; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22 
23 
24 
25 #include "libguile/__scm.h"
26 
27 #include "libguile/options.h"
28 
29 SCM_API scm_t_option scm_print_opts[];
30 
31 #define SCM_PRINT_CLOSURE	    (SCM_PACK (scm_print_opts[0].val))
32 #define SCM_PRINT_SOURCE_P	    ((int) scm_print_opts[1].val)
33 #define SCM_PRINT_HIGHLIGHT_PREFIX  (SCM_PACK (scm_print_opts[2].val))
34 #define SCM_PRINT_HIGHLIGHT_SUFFIX  (SCM_PACK (scm_print_opts[3].val))
35 #define SCM_PRINT_KEYWORD_STYLE_I   4
36 #define SCM_PRINT_KEYWORD_STYLE     (SCM_PACK (scm_print_opts[4].val))
37 #define SCM_N_PRINT_OPTIONS 5
38 
39 /* State information passed around during printing.
40  */
41 #define SCM_PRINT_STATE_P(obj) (SCM_STRUCTP(obj) \
42 				&& (scm_is_eq (SCM_STRUCT_VTABLE(obj), \
43 				               scm_print_state_vtable)))
44 #define SCM_PRINT_STATE(obj) ((scm_print_state *) SCM_STRUCT_DATA (obj))
45 
46 #define RESET_PRINT_STATE(pstate) \
47 do { \
48   pstate->list_offset = 0; \
49   pstate->top = 0; \
50 } while (0)
51 
52 #define SCM_WRITINGP(pstate) ((pstate)->writingp)
53 #define SCM_SET_WRITINGP(pstate, x) { (pstate)->writingp = (x); }
54 
55 #define SCM_PORT_WITH_PS_P(p)    SCM_TYP16_PREDICATE (scm_tc16_port_with_ps, p)
56 #define SCM_PORT_WITH_PS_PORT(p) SCM_CAR (SCM_CELL_OBJECT_1 (p))
57 #define SCM_PORT_WITH_PS_PS(p)   SCM_CDR (SCM_CELL_OBJECT_1 (p))
58 
59 #define SCM_COERCE_OUTPORT(p) \
60   (SCM_PORT_WITH_PS_P (p) ? SCM_PORT_WITH_PS_PORT (p) : p)
61 
62 #define SCM_PRINT_STATE_LAYOUT "sruwuwuwuwuwpwuwuwurprpw"
63 typedef struct scm_print_state {
64   SCM handle;			/* Struct handle */
65   int revealed;                 /* Has the state escaped to Scheme? */
66   unsigned long writingp;	/* Writing? */
67   unsigned long fancyp;		/* Fancy printing? */
68   unsigned long level;		/* Max level */
69   unsigned long length;		/* Max number of objects per level */
70   SCM hot_ref;			/* Hot reference */
71   unsigned long list_offset;
72   unsigned long top;		/* Top of reference stack */
73   unsigned long ceiling;	/* Max size of reference stack */
74   SCM ref_vect;	 	        /* Stack of references used during
75 				   circular reference detection;
76 				   a simple vector. */
77   SCM highlight_objects;        /* List of objects to be highlighted */
78 } scm_print_state;
79 
80 SCM_API SCM scm_print_state_vtable;
81 
82 SCM_API scm_t_bits scm_tc16_port_with_ps;
83 
84 SCM_API SCM scm_print_options (SCM setting);
85 SCM_API SCM scm_make_print_state (void);
86 SCM_API void scm_free_print_state (SCM print_state);
87 SCM scm_i_port_with_print_state (SCM port, SCM print_state);
88 SCM_API void scm_intprint (scm_t_intmax n, int radix, SCM port);
89 SCM_API void scm_uintprint (scm_t_uintmax n, int radix, SCM port);
90 SCM_API void scm_ipruk (char *hdr, SCM ptr, SCM port);
91 SCM_API void scm_iprlist (char *hdr, SCM exp, int tlr, SCM port, scm_print_state *pstate);
92 SCM_API void scm_print_symbol_name (const char *str, size_t len, SCM port);
93 SCM_API void scm_prin1 (SCM exp, SCM port, int writingp);
94 SCM_API void scm_iprin1 (SCM exp, SCM port, scm_print_state *pstate);
95 SCM_API SCM scm_write (SCM obj, SCM port);
96 SCM_API SCM scm_display (SCM obj, SCM port);
97 SCM_API SCM scm_simple_format (SCM port, SCM message, SCM args);
98 SCM_API SCM scm_newline (SCM port);
99 SCM_API SCM scm_write_char (SCM chr, SCM port);
100 SCM_API SCM scm_printer_apply (SCM proc, SCM exp, SCM port, scm_print_state *);
101 SCM_API SCM scm_port_with_print_state (SCM port, SCM pstate);
102 SCM_API SCM scm_get_print_state (SCM port);
103 SCM_API int scm_valid_oport_value_p (SCM val);
104 SCM_API void scm_init_print (void);
105 
106 #ifdef GUILE_DEBUG
107 SCM_API SCM scm_current_pstate (void);
108 #endif
109 
110 #endif  /* SCM_PRINT_H */
111 
112 /*
113   Local Variables:
114   c-file-style: "gnu"
115   End:
116 */
117