libguile/print.h

   1 /* classes: h_files */
   2
   3 #ifndef PRINTH
   4 #define PRINTH
   5 /*      Copyright (C) 1995,1996 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 \f
  46
  47 #include "libguile/__scm.h"
  48
  49 #include "libguile/options.h"
  50 \f
  51 extern scm_option scm_print_opts[];
  52
  53 #define SCM_PRINT_CLOSURE       ((SCM) scm_print_opts[0].val)
  54 #define SCM_PRINT_SOURCE_P      ((int) scm_print_opts[1].val)
  55 #define SCM_N_PRINT_OPTIONS 2
  56
  57 /* State information passed around during printing.
  58  */
  59 #define SCM_PRINT_STATE_P(obj) (SCM_STRUCTP(obj) \
  60                                 && (SCM_STRUCT_VTABLE(obj) \
  61                                     == scm_print_state_vtable))
  62 #define SCM_PRINT_STATE(obj) ((scm_print_state *) SCM_STRUCT_DATA (obj))
  63
  64 #define RESET_PRINT_STATE(pstate) \
  65 { \
  66   pstate->list_offset = 0; \
  67   pstate->top = 0; \
  68 }
  69
  70 #define SCM_WRITINGP(pstate) ((pstate)->writingp)
  71 #define SCM_SET_WRITINGP(pstate, x) { (pstate)->writingp = (x); }
  72
  73 #define SCM_COERCE_OUTPORT(p) ((SCM_NIMP (p) \
  74                                 && SCM_CONSP (p) \
  75                                 && SCM_PRINT_STATE_P (SCM_CDR (p))) \
  76                                ? SCM_CAR (p) \
  77                                : p)
  78
  79 #define SCM_PRINT_STATE_LAYOUT "sruwuwuwuwuwpwuwuwuruopr"
  80 typedef struct scm_print_state {
  81   SCM handle;                   /* Struct handle */
  82   int revealed;                 /* Has the state escaped to Scheme? */
  83   unsigned long writingp;       /* Writing? */
  84   unsigned long fancyp;         /* Fancy printing? */
  85   unsigned long level;          /* Max level */
  86   unsigned long length;         /* Max number of objects per level */
  87   SCM hot_ref;                  /* Hot reference */
  88   unsigned long list_offset;
  89   unsigned long top;            /* Top of reference stack */
  90   unsigned long ceiling;        /* Max size of reference stack */
  91   SCM *ref_stack;               /* Stack of references used during
  92                                    circular reference detection */
  93   SCM ref_vect;
  94 } scm_print_state;
  95
  96 extern SCM scm_print_state_vtable;
  97
  98 extern SCM scm_print_options SCM_P ((SCM setting));
  99 SCM scm_make_print_state SCM_P ((void));
 100 void scm_free_print_state SCM_P ((SCM print_state));
 101 extern void scm_intprint SCM_P ((long n, int radix, SCM port));
 102 extern void scm_ipruk SCM_P ((char *hdr, SCM ptr, SCM port));
 103 extern void scm_iprlist SCM_P ((char *hdr, SCM exp, int tlr, SCM port, scm_print_state *pstate));
 104 extern void scm_prin1 SCM_P ((SCM exp, SCM port, int writingp));
 105 extern void scm_iprin1 SCM_P ((SCM exp, SCM port, scm_print_state *pstate));
 106 extern SCM scm_write SCM_P ((SCM obj, SCM port));
 107 extern SCM scm_display SCM_P ((SCM obj, SCM port));
 108 extern SCM scm_newline SCM_P ((SCM port));
 109 extern SCM scm_write_char SCM_P ((SCM chr, SCM port));
 110 extern SCM scm_printer_apply SCM_P ((SCM proc, SCM exp, SCM port,
 111                                      scm_print_state *));
 112 extern int scm_valid_oport_value_p SCM_P ((SCM val));
 113 extern void scm_init_print SCM_P ((void));
 114
 115 #ifdef GUILE_DEBUG
 116 extern SCM scm_current_pstate SCM_P ((void));
 117 #endif
 118 #endif  /* PRINTH */