libguile/ports.h

   1 /* classes: h_files */
   2
   3 #ifndef PORTSH
   4 #define PORTSH
   5 /*      Copyright (C) 1995,1996,1997,1998,1999, 2000 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 #include "libguile/__scm.h"
  50
  51 #include "libguile/print.h"
  52 #include "libguile/struct.h"
  53
  54 /* Not sure if this is a good idea.  We need it for off_t.  */
  55 #include <sys/types.h>
  56
  57 \f
  58
  59 #define SCM_INITIAL_PUTBACK_BUF_SIZE 4
  60
  61 /* values for the rw_active flag.  */
  62 enum scm_port_rw_active {
  63   SCM_PORT_NEITHER = 0,
  64   SCM_PORT_READ = 1,
  65   SCM_PORT_WRITE = 2
  66 };
  67
  68 /* C representation of a Scheme port.  */
  69
  70 typedef struct
  71 {
  72   SCM port;                     /* Link back to the port object.  */
  73   int entry;                    /* Index in port table. */
  74   int revealed;                 /* 0 not revealed, > 1 revealed.
  75                                  * Revealed ports do not get GC'd.
  76                                  */
  77   /* data for the underlying port implementation as a raw C value. */
  78   scm_bits_t stream;
  79
  80   SCM file_name;                /* debugging support.  */
  81   int line_number;              /* debugging support.  */
  82   int column_number;            /* debugging support.  */
  83
  84   /* port buffers.  the buffer(s) are set up for all ports.
  85      in the case of string ports, the buffer is the string itself.
  86      in the case of unbuffered file ports, the buffer is a
  87      single char: shortbuf.  */
  88
  89   /* this buffer is filled from read_buf to read_end using the ptob
  90      buffer_fill.  then input requests are taken from read_pos until
  91      it reaches read_end.  */
  92
  93   unsigned char *read_buf;      /* buffer start.  */
  94   const unsigned char *read_pos;/* the next unread char.  */
  95   unsigned char *read_end;      /* pointer to last buffered char + 1.  */
  96   off_t read_buf_size;          /* size of the buffer.  */
  97
  98   /* when chars are put back into the buffer, e.g., using peek-char or
  99      unread-string, the read-buffer pointers are switched to cbuf.
 100      the original pointers are saved here and restored when the put-back
 101      chars have been consumed.  */
 102   unsigned char *saved_read_buf;
 103   const unsigned char *saved_read_pos;
 104   unsigned char *saved_read_end;
 105   off_t saved_read_buf_size;
 106
 107   /* write requests are saved into this buffer at write_pos until it
 108      reaches write_buf + write_buf_size, then the ptob flush is
 109      called.  */
 110
 111   unsigned char *write_buf;     /* buffer start.  */
 112   unsigned char *write_pos;     /* pointer to last buffered char + 1.  */
 113   unsigned char *write_end;     /* pointer to end of buffer + 1.  */
 114   off_t write_buf_size;         /* size of the buffer.  */
 115
 116   unsigned char shortbuf;       /* buffer for "unbuffered" streams.  */
 117
 118   int rw_random;                /* true if the port is random access.
 119                                    implies that the buffers must be
 120                                    flushed before switching between
 121                                    reading and writing, seeking, etc.  */
 122
 123   enum scm_port_rw_active rw_active; /* for random access ports,
 124                                         indicates which of the buffers
 125                                         is currently in use.  can be
 126                                         SCM_PORT_WRITE, SCM_PORT_READ,
 127                                         or SCM_PORT_NEITHER.  */
 128
 129
 130   /* a buffer for un-read chars and strings.  */
 131   unsigned char *putback_buf;
 132   int putback_buf_size;        /* allocated size of putback_buf.  */
 133 } scm_port;
 134
 135 extern scm_port **scm_port_table;
 136 extern int scm_port_table_size; /* Number of ports in scm_port_table.  */
 137
 138
 139 \f
 140
 141 #define SCM_EOF_OBJECT_P(x) (SCM_EQ_P ((x), SCM_EOF_VAL))
 142
 143 /* PORT FLAGS
 144  * A set of flags characterizes a port.
 145  * Note that we reserve the bits 1 << 24 and above for use by the
 146  * routines in the port's scm_ptobfuns structure.
 147  */
 148 #define SCM_OPN         (1L<<16) /* Is the port open? */
 149 #define SCM_RDNG        (2L<<16) /* Is it a readable port? */
 150 #define SCM_WRTNG       (4L<<16) /* Is it writable? */
 151 #define SCM_BUF0        (8L<<16) /* Is it unbuffered? */
 152 #define SCM_BUFLINE     (64L<<16) /* Is it line-buffered? */
 153
 154 #define SCM_PORTP(x) (SCM_NIMP(x) && (SCM_TYP7(x)==scm_tc7_port))
 155 #define SCM_OPPORTP(x) (SCM_NIMP(x) && (((0x7f | SCM_OPN) & SCM_CELL_WORD_0(x))==(scm_tc7_port | SCM_OPN)))
 156 #define SCM_OPINPORTP(x) (SCM_NIMP(x) && (((0x7f | SCM_OPN | SCM_RDNG) & SCM_CELL_WORD_0(x))==(scm_tc7_port | SCM_OPN | SCM_RDNG)))
 157 #define SCM_OPOUTPORTP(x) (SCM_NIMP(x) && (((0x7f | SCM_OPN | SCM_WRTNG) & SCM_CELL_WORD_0(x))==(scm_tc7_port | SCM_OPN | SCM_WRTNG)))
 158 #define SCM_INPUT_PORT_P(x) \
 159   (SCM_NIMP(x) \
 160    && (((0x7f | SCM_RDNG) & SCM_CELL_WORD_0(x)) == (scm_tc7_port | SCM_RDNG)))
 161 #define SCM_OUTPUT_PORT_P(x) \
 162   (SCM_NIMP(x) \
 163    && (((0x7f | SCM_WRTNG) & SCM_CELL_WORD_0(x))==(scm_tc7_port | SCM_WRTNG)))
 164 #define SCM_OPENP(x) (SCM_NIMP(x) && (SCM_OPN & SCM_CELL_WORD_0 (x)))
 165 #define SCM_CLOSEDP(x) (!SCM_OPENP(x))
 166
 167 #define SCM_PTAB_ENTRY(x)         ((scm_port *) SCM_CELL_WORD_1 (x))
 168 #define SCM_SETPTAB_ENTRY(x,ent)  (SCM_SET_CELL_WORD_1 ((x), (scm_bits_t) (ent)))
 169 #define SCM_STREAM(x)             (SCM_PTAB_ENTRY(x)->stream)
 170 #define SCM_SETSTREAM(x,s)        (SCM_PTAB_ENTRY(x)->stream = (scm_bits_t) (s))
 171 #define SCM_FILENAME(x)           (SCM_PTAB_ENTRY(x)->file_name)
 172 #define SCM_SET_FILENAME(x, n)    (SCM_PTAB_ENTRY(x)->file_name = (n))
 173 #define SCM_LINUM(x)              (SCM_PTAB_ENTRY(x)->line_number)
 174 #define SCM_COL(x)                (SCM_PTAB_ENTRY(x)->column_number)
 175 #define SCM_REVEALED(x)           (SCM_PTAB_ENTRY(x)->revealed)
 176 #define SCM_SETREVEALED(x,s)      (SCM_PTAB_ENTRY(x)->revealed = (s))
 177
 178 #define SCM_INCLINE(port)       {SCM_LINUM (port) += 1; SCM_COL (port) = 0;}
 179 #define SCM_INCCOL(port)        {SCM_COL (port) += 1;}
 180 #define SCM_TABCOL(port)        {SCM_COL (port) += 8 - SCM_COL (port) % 8;}
 181
 182 \f
 183
 184 /* port-type description.  */
 185 typedef struct scm_ptob_descriptor
 186 {
 187   char *name;
 188   SCM (*mark) (SCM);
 189   scm_sizet (*free) (SCM);
 190   int (*print) (SCM exp, SCM port, scm_print_state *pstate);
 191   SCM (*equalp) (SCM, SCM);
 192   int (*close) (SCM port);
 193
 194   void (*write) (SCM port, const void *data, size_t size);
 195   void (*flush) (SCM port);
 196
 197   void (*end_input) (SCM port, int offset);
 198   int (*fill_input) (SCM port);
 199   int (*input_waiting) (SCM port);
 200
 201   off_t (*seek) (SCM port, off_t OFFSET, int WHENCE);
 202   void (*truncate) (SCM port, off_t length);
 203
 204 } scm_ptob_descriptor;
 205
 206 #define SCM_TC2PTOBNUM(x) (0x0ff & ((x) >> 8))
 207 #define SCM_PTOBNUM(x) (SCM_TC2PTOBNUM (SCM_CELL_TYPE (x)))
 208 /* SCM_PTOBNAME can be 0 if name is missing */
 209 #define SCM_PTOBNAME(ptobnum) scm_ptobs[ptobnum].name
 210
 211 \f
 212
 213 extern scm_ptob_descriptor *scm_ptobs;
 214 extern int scm_numptob;
 215 extern int scm_port_table_room;
 216
 217 \f
 218
 219 extern SCM scm_markstream (SCM ptr);
 220 extern long scm_make_port_type (char *name,
 221                                 int (*fill_input) (SCM port),
 222                                 void (*write) (SCM port, const void *data,
 223                                                size_t size));
 224 extern void scm_set_port_mark (long tc, SCM (*mark) (SCM));
 225 extern void scm_set_port_free (long tc, scm_sizet (*free) (SCM));
 226 extern void scm_set_port_print (long tc,
 227                                 int (*print) (SCM exp,
 228                                               SCM port,
 229                                               scm_print_state *pstate));
 230 extern void scm_set_port_equalp (long tc, SCM (*equalp) (SCM, SCM));
 231 extern void scm_set_port_close (long tc, int (*close) (SCM));
 232
 233 extern void scm_set_port_flush (long tc,
 234                                 void (*flush) (SCM port));
 235 extern void scm_set_port_end_input (long tc,
 236                                     void (*end_input) (SCM port,
 237                                                        int offset));
 238 extern void scm_set_port_seek (long tc,
 239                                off_t (*seek) (SCM port,
 240                                               off_t OFFSET,
 241                                               int WHENCE));
 242 extern void scm_set_port_truncate (long tc,
 243                                    void (*truncate) (SCM port,
 244                                                      off_t length));
 245 extern void scm_set_port_input_waiting (long tc, int (*input_waiting) (SCM));
 246 extern SCM scm_char_ready_p (SCM port);
 247 size_t scm_take_from_input_buffers (SCM port, char *dest, size_t read_len);
 248 extern SCM scm_drain_input (SCM port);
 249 extern SCM scm_current_input_port (void);
 250 extern SCM scm_current_output_port (void);
 251 extern SCM scm_current_error_port (void);
 252 extern SCM scm_current_load_port (void);
 253 extern SCM scm_set_current_input_port (SCM port);
 254 extern SCM scm_set_current_output_port (SCM port);
 255 extern SCM scm_set_current_error_port (SCM port);
 256 extern scm_port * scm_add_to_port_table (SCM port);
 257 extern void scm_remove_from_port_table (SCM port);
 258 extern void scm_grow_port_cbuf (SCM port, size_t requested);
 259 extern SCM scm_pt_size (void);
 260 extern SCM scm_pt_member (SCM member);
 261 extern void scm_port_non_buffer (scm_port *pt);
 262 extern int scm_revealed_count (SCM port);
 263 extern SCM scm_port_revealed (SCM port);
 264 extern SCM scm_set_port_revealed_x (SCM port, SCM rcount);
 265 extern long scm_mode_bits (char *modes);
 266 extern SCM scm_port_mode (SCM port);
 267 extern SCM scm_close_input_port (SCM port);
 268 extern SCM scm_close_output_port (SCM port);
 269 extern SCM scm_close_port (SCM port);
 270 extern SCM scm_port_for_each (SCM proc);
 271 extern SCM scm_input_port_p (SCM x);
 272 extern SCM scm_output_port_p (SCM x);
 273 extern SCM scm_port_p (SCM x);
 274 extern SCM scm_port_closed_p (SCM port);
 275 extern SCM scm_eof_object_p (SCM x);
 276 extern SCM scm_force_output (SCM port);
 277 extern SCM scm_flush_all_ports (void);
 278 extern SCM scm_read_char (SCM port);
 279 extern void scm_putc (char c, SCM port);
 280 extern void scm_puts (const char *str_data, SCM port);
 281 extern void scm_lfwrite (const char *ptr, scm_sizet size, SCM port);
 282 extern void scm_flush (SCM port);
 283 extern void scm_end_input (SCM port);
 284 extern int scm_fill_input (SCM port);
 285 extern int scm_getc (SCM port);
 286 extern void scm_ungetc (int c, SCM port);
 287 extern void scm_ungets (const char *s, int n, SCM port);
 288 extern SCM scm_peek_char (SCM port);
 289 extern SCM scm_unread_char (SCM cobj, SCM port);
 290 extern SCM scm_unread_string (SCM str, SCM port);
 291 extern SCM scm_seek (SCM object, SCM offset, SCM whence);
 292 extern SCM scm_truncate_file (SCM object, SCM length);
 293 extern SCM scm_port_line (SCM port);
 294 extern SCM scm_set_port_line_x (SCM port, SCM line);
 295 extern SCM scm_port_column (SCM port);
 296 extern SCM scm_set_port_column_x (SCM port, SCM line);
 297 extern SCM scm_port_filename (SCM port);
 298 extern SCM scm_set_port_filename_x (SCM port, SCM filename);
 299 extern int scm_port_print (SCM exp, SCM port, scm_print_state *);
 300 extern void scm_print_port_mode (SCM exp, SCM port);
 301 extern void scm_ports_prehistory (void);
 302 extern SCM scm_void_port (char * mode_str);
 303 extern SCM scm_sys_make_void_port (SCM mode);
 304 extern void scm_init_ports (void);
 305
 306 #ifdef GUILE_DEBUG
 307 extern SCM scm_pt_size (void);
 308 extern SCM scm_pt_member (SCM member);
 309 #endif /* GUILE_DEBUG */
 310
 311 \f
 312
 313 #if (SCM_DEBUG_DEPRECATED == 0)
 314
 315 /* #define SCM_CRDY     (32L<<16)  obsolete, for pushed back characters  */
 316 #define SCM_INPORTP(x) SCM_INPUT_PORT_P (x)
 317 #define SCM_OUTPORTP(x) SCM_OUTPUT_PORT_P (x)
 318
 319 extern SCM scm_close_all_ports_except (SCM ports);
 320
 321 #endif  /* SCM_DEBUG_DEPRECATED == 0 */
 322
 323 #endif  /* PORTSH */
 324
 325 /*
 326   Local Variables:
 327   c-file-style: "gnu"
 328   End:
 329 */