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 Free Software Foundation, Inc.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2, or (at your option)
  11  * any later version.
  12  *
  13  * This program 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
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this software; see the file COPYING.  If not, write to
  20  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  21  * Boston, MA 02111-1307 USA
  22  *
  23  * As a special exception, the Free Software Foundation gives permission
  24  * for additional uses of the text contained in its release of GUILE.
  25  *
  26  * The exception is that, if you link the GUILE library with other files
  27  * to produce an executable, this does not by itself cause the
  28  * resulting executable to be covered by the GNU General Public License.
  29  * Your use of that executable is in no way restricted on account of
  30  * linking the GUILE library code into it.
  31  *
  32  * This exception does not however invalidate any other reasons why
  33  * the executable file might be covered by the GNU General Public License.
  34  *
  35  * This exception applies only to the code released by the
  36  * Free Software Foundation under the name GUILE.  If you copy
  37  * code from other Free Software Foundation releases into a copy of
  38  * GUILE, as the General Public License permits, the exception does
  39  * not apply to the code that you add in this way.  To avoid misleading
  40  * anyone as to the status of such modified files, you must delete
  41  * this exception notice from them.
  42  *
  43  * If you write modifications of your own for GUILE, it is your choice
  44  * whether to permit this exception to apply to your modifications.
  45  * If you do not wish that, delete this exception notice.  */
  46
  47 \f
  48
  49 #include "libguile/__scm.h"
  50
  51 #include "libguile/options.h"
  52 \f
  53 extern scm_t_option scm_print_opts[];
  54
  55 #define SCM_PRINT_CLOSURE       (SCM_PACK (scm_print_opts[0].val))
  56 #define SCM_PRINT_SOURCE_P      ((int) scm_print_opts[1].val)
  57 #define SCM_N_PRINT_OPTIONS 2
  58
  59 /* State information passed around during printing.
  60  */
  61 #define SCM_PRINT_STATE_P(obj) (SCM_STRUCTP(obj) \
  62                                 && (SCM_EQ_P (SCM_STRUCT_VTABLE(obj), \
  63                                               scm_print_state_vtable)))
  64 #define SCM_PRINT_STATE(obj) ((scm_print_state *) SCM_STRUCT_DATA (obj))
  65
  66 #define RESET_PRINT_STATE(pstate) \
  67 do { \
  68   pstate->list_offset = 0; \
  69   pstate->top = 0; \
  70 } while (0)
  71
  72 #define SCM_WRITINGP(pstate) ((pstate)->writingp)
  73 #define SCM_SET_WRITINGP(pstate, x) { (pstate)->writingp = (x); }
  74
  75 #define SCM_PORT_WITH_PS_P(p)    SCM_TYP16_PREDICATE (scm_tc16_port_with_ps, p)
  76 #define SCM_PORT_WITH_PS_PORT(p) SCM_CAR (SCM_CELL_OBJECT_1 (p))
  77 #define SCM_PORT_WITH_PS_PS(p)   SCM_CDR (SCM_CELL_OBJECT_1 (p))
  78
  79 #define SCM_COERCE_OUTPORT(p) \
  80   (SCM_PORT_WITH_PS_P (p) ? SCM_PORT_WITH_PS_PORT (p) : p)
  81
  82 #define SCM_PRINT_STATE_LAYOUT "sruwuwuwuwuwpwuwuwuruopr"
  83 typedef struct scm_print_state {
  84   SCM handle;                   /* Struct handle */
  85   int revealed;                 /* Has the state escaped to Scheme? */
  86   unsigned long writingp;       /* Writing? */
  87   unsigned long fancyp;         /* Fancy printing? */
  88   unsigned long level;          /* Max level */
  89   unsigned long length;         /* Max number of objects per level */
  90   SCM hot_ref;                  /* Hot reference */
  91   unsigned long list_offset;
  92   unsigned long top;            /* Top of reference stack */
  93   unsigned long ceiling;        /* Max size of reference stack */
  94   SCM *ref_stack;               /* Stack of references used during
  95                                    circular reference detection */
  96   SCM ref_vect;
  97 } scm_print_state;
  98
  99 extern SCM scm_print_state_vtable;
 100
 101 extern scm_t_bits scm_tc16_port_with_ps;
 102
 103 extern SCM scm_print_options (SCM setting);
 104 SCM scm_make_print_state (void);
 105 void scm_free_print_state (SCM print_state);
 106 extern void scm_intprint (long n, int radix, SCM port);
 107 extern void scm_ipruk (char *hdr, SCM ptr, SCM port);
 108 extern void scm_iprlist (char *hdr, SCM exp, int tlr, SCM port, scm_print_state *pstate);
 109 extern void scm_print_symbol_name (const char *str, size_t len, SCM port);
 110 extern void scm_prin1 (SCM exp, SCM port, int writingp);
 111 extern void scm_iprin1 (SCM exp, SCM port, scm_print_state *pstate);
 112 extern SCM scm_write (SCM obj, SCM port);
 113 extern SCM scm_display (SCM obj, SCM port);
 114 extern SCM scm_simple_format (SCM port, SCM message, SCM args);
 115 extern SCM scm_newline (SCM port);
 116 extern SCM scm_write_char (SCM chr, SCM port);
 117 extern SCM scm_printer_apply (SCM proc, SCM exp, SCM port, scm_print_state *);
 118 extern SCM scm_port_with_print_state (SCM port, SCM pstate);
 119 extern SCM scm_get_print_state (SCM port);
 120 extern int scm_valid_oport_value_p (SCM val);
 121 extern void scm_init_print (void);
 122
 123 #ifdef GUILE_DEBUG
 124 extern SCM scm_current_pstate (void);
 125 #endif
 126
 127 #endif  /* SCM_PRINT_H */
 128
 129 /*
 130   Local Variables:
 131   c-file-style: "gnu"
 132   End:
 133 */