libguile/print.h

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