libguile/ports.h

   1 /* classes: h_files */
   2
   3 #ifndef PORTSH
   4 #define PORTSH
   5 /*      Copyright (C) 1995,1996,1997 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 \f
  50
  51 enum scm_port_representation_type
  52 {
  53   scm_regular_port,
  54   scm_mb_port,
  55   scm_wchar_port
  56 };
  57
  58 enum scm_string_representation_type
  59 {
  60   scm_regular_string = scm_regular_port,
  61   scm_mb_string = scm_mb_port,
  62   scm_wchar_string = scm_wchar_port
  63 };
  64
  65
  66 struct scm_port_table
  67 {
  68   SCM port;                     /* Open port.  */
  69   int revealed;                 /* 0 not revealed, > 1 revealed.
  70                                  * Revealed ports do not get GC'd.
  71                                  */
  72
  73   SCM stream;
  74   SCM file_name;                /* debugging support.  */
  75   int unchr;                    /* pushed back character, if any */
  76
  77   int line_number;              /* debugging support.  */
  78   int column_number;            /* debugging support.  */
  79
  80   enum scm_port_representation_type representation;
  81 };
  82
  83 extern struct scm_port_table **scm_port_table;
  84 extern int scm_port_table_size; /* Number of ports in scm_port_table.  */
  85
  86
  87 \f
  88
  89 /* PORT FLAGS
  90  * A set of flags characterizes a port.
  91  */
  92 #define SCM_OPN         (1L<<16) /* Is the port open? */
  93 #define SCM_RDNG        (2L<<16) /* Is it a readable port? */
  94 #define SCM_WRTNG       (4L<<16) /* Is it writable? */
  95 #define SCM_BUF0        (8L<<16)
  96 #define SCM_CRDY        (32L<<16) /* Should char-ready? return #t? */
  97
  98 /* A mask used to clear the char-ready port flag. */
  99 #define SCM_CUC         0x001fffffL
 100
 101 #define SCM_PORTP(x) (SCM_TYP7(x)==scm_tc7_port)
 102 #define SCM_OPPORTP(x) (((0x7f | SCM_OPN) & SCM_CAR(x))==(scm_tc7_port | SCM_OPN))
 103 #define SCM_OPINPORTP(x) (((0x7f | SCM_OPN | SCM_RDNG) & SCM_CAR(x))==(scm_tc7_port | SCM_OPN | SCM_RDNG))
 104 #define SCM_OPOUTPORTP(x) (((0x7f | SCM_OPN | SCM_WRTNG) & SCM_CAR(x))==(scm_tc7_port | SCM_OPN | SCM_WRTNG))
 105 #define SCM_FPORTP(x) (SCM_TYP16S(x)==scm_tc7_port)
 106 #define SCM_OPFPORTP(x) (((0xfeff | SCM_OPN) & SCM_CAR(x))==(scm_tc7_port | SCM_OPN))
 107 #define SCM_OPINFPORTP(x) (((0xfeff | SCM_OPN | SCM_RDNG) & SCM_CAR(x))==(scm_tc7_port | SCM_OPN | SCM_RDNG))
 108 #define SCM_OPOUTFPORTP(x) (((0xfeff | SCM_OPN | SCM_WRTNG) & SCM_CAR(x))==(scm_tc7_port | SCM_OPN | SCM_WRTNG))
 109
 110 #define SCM_INPORTP(x) (((0x7f | SCM_RDNG) & SCM_CAR(x))==(scm_tc7_port | SCM_RDNG))
 111 #define SCM_OUTPORTP(x) (((0x7f | SCM_WRTNG) & SCM_CAR(x))==(scm_tc7_port | SCM_WRTNG))
 112 #define SCM_OPENP(x) (SCM_OPN & SCM_CAR(x))
 113 #define SCM_CLOSEDP(x) (!SCM_OPENP(x))
 114 #define SCM_PTAB_ENTRY(x) ((struct scm_port_table *)SCM_CDR(x))
 115 #define SCM_SETPTAB_ENTRY(x,ent) SCM_SETCDR ((x), (SCM)(ent))
 116 #define SCM_STREAM(x) SCM_PTAB_ENTRY(x)->stream
 117 #define SCM_SETSTREAM(x,s) (SCM_PTAB_ENTRY(x)->stream = s)
 118 #define SCM_FILENAME(x) SCM_PTAB_ENTRY(x)->file_name
 119 #define SCM_LINUM(x) SCM_PTAB_ENTRY(x)->line_number
 120 #define SCM_COL(x) SCM_PTAB_ENTRY(x)->column_number
 121 #define SCM_REVEALED(x) SCM_PTAB_ENTRY(x)->revealed
 122 #define SCM_SETREVEALED(x,s) (SCM_PTAB_ENTRY(x)->revealed = s)
 123 #define SCM_PORT_REPRESENTATION(x) SCM_PTAB_ENTRY(x)->representation
 124 #define SCM_SET_PORT_REPRESENTATION(x,s) (SCM_PTAB_ENTRY(x)->representation = s)
 125 #define SCM_CRDYP(port) (SCM_CAR (port) & SCM_CRDY)
 126 #define SCM_CLRDY(port) {SCM_SETAND_CAR (port, SCM_CUC);}
 127 #define SCM_SETRDY(port) {SCM_SETOR_CAR (port, SCM_CRDY);}
 128 #define SCM_CUNGET(c,port) {SCM_PTAB_ENTRY(port)->unchr = c; SCM_SETRDY(port);}
 129 #define SCM_CGETUN(port) (SCM_PTAB_ENTRY(port)->unchr)
 130
 131 #define SCM_INCLINE(port)       {SCM_LINUM (port) += 1; SCM_COL (port) = 0;}
 132 #define SCM_INCCOL(port)        {SCM_COL (port) += 1;}
 133 #define SCM_TABCOL(port)        {SCM_COL (port) += 8 - SCM_COL (port) % 8;}
 134
 135
 136
 137 \f
 138
 139 typedef struct scm_ptobfuns
 140 {
 141   SCM (*mark) SCM_P ((SCM));
 142   int (*free) SCM_P ((SCM));
 143   int (*print) SCM_P ((SCM exp, SCM port, scm_print_state *pstate));
 144   SCM (*equalp) SCM_P ((SCM, SCM));
 145   int (*fputc) SCM_P ((int, SCM stream));
 146   int (*fputs) SCM_P ((char *, SCM stream));
 147   scm_sizet (*fwrite) SCM_P ((char *ptr, scm_sizet size, scm_sizet nitems, SCM stream));
 148   int (*fflush) SCM_P ((SCM stream));
 149   int (*fgetc) SCM_P ((SCM stream));
 150   int (*fclose) SCM_P ((SCM stream));
 151 } scm_ptobfuns;
 152
 153 #define SCM_PTOBNUM(x) (0x0ff & (SCM_CAR(x)>>8))
 154
 155 \f
 156
 157 extern scm_ptobfuns *scm_ptobs;
 158 extern scm_sizet scm_numptob;
 159 extern int scm_port_table_room;
 160
 161 \f
 162
 163 extern SCM scm_markstream SCM_P ((SCM ptr));
 164 extern long scm_newptob SCM_P ((scm_ptobfuns *ptob));
 165 extern void scm_fflush SCM_P ((SCM port));
 166 extern SCM scm_char_ready_p SCM_P ((SCM port));
 167 extern SCM scm_current_input_port SCM_P ((void));
 168 extern SCM scm_current_output_port SCM_P ((void));
 169 extern SCM scm_current_error_port SCM_P ((void));
 170 extern SCM scm_set_current_input_port SCM_P ((SCM port));
 171 extern SCM scm_set_current_output_port SCM_P ((SCM port));
 172 extern SCM scm_set_current_error_port SCM_P ((SCM port));
 173 extern struct scm_port_table * scm_add_to_port_table SCM_P ((SCM port));
 174 extern void scm_remove_from_port_table SCM_P ((SCM port));
 175 extern SCM scm_pt_size SCM_P ((void));
 176 extern SCM scm_pt_member SCM_P ((SCM member));
 177 extern int scm_revealed_count SCM_P ((SCM port));
 178 extern SCM scm_port_revealed SCM_P ((SCM port));
 179 extern SCM scm_set_port_revealed_x SCM_P ((SCM port, SCM rcount));
 180 extern SCM scm_close_port SCM_P ((SCM port));
 181 extern SCM scm_close_all_ports_except SCM_P ((SCM ports));
 182 extern SCM scm_input_port_p SCM_P ((SCM x));
 183 extern SCM scm_output_port_p SCM_P ((SCM x));
 184 extern SCM scm_eof_object_p SCM_P ((SCM x));
 185 extern SCM scm_force_output SCM_P ((SCM port));
 186 extern SCM scm_flush_all_ports SCM_P ((void));
 187 extern SCM scm_read_char SCM_P ((SCM port));
 188 extern SCM scm_peek_char SCM_P ((SCM port));
 189 extern SCM scm_unread_char SCM_P ((SCM cobj, SCM port));
 190 extern SCM scm_port_line SCM_P ((SCM port));
 191 extern SCM scm_port_column SCM_P ((SCM port));
 192 extern SCM scm_port_filename SCM_P ((SCM port));
 193 extern SCM scm_set_port_filename_x SCM_P ((SCM port, SCM filename));
 194 extern void scm_prinport SCM_P ((SCM exp, SCM port, char *type));
 195 extern void scm_ports_prehistory SCM_P ((void));
 196 extern SCM scm_void_port SCM_P ((char * mode_str));
 197 extern SCM scm_sys_make_void_port SCM_P ((SCM mode));
 198 extern void scm_init_ports SCM_P ((void));
 199
 200 #endif  /* PORTSH */