libguile/print.h

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