[bpt/guile.git] / libguile / ports.h

/* classes: h_files */

#ifndef SCM_PORTS_H
#define SCM_PORTS_H

/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2003, 2004, 2006, 2008, 2009 Free Software Foundation, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */

\f

#include "libguile/__scm.h"

#include "libguile/print.h"
#include "libguile/struct.h"
#include "libguile/threads.h"

/* Not sure if this is a good idea.  We need it for off_t.  */
#include <sys/types.h>

\f

#define SCM_INITIAL_PUTBACK_BUF_SIZE 4

/* values for the rw_active flag.  */
typedef enum scm_t_port_rw_active {
  SCM_PORT_NEITHER = 0,
  SCM_PORT_READ = 1,
  SCM_PORT_WRITE = 2
} scm_t_port_rw_active;

/* C representation of a Scheme port.  */

typedef struct 
{
  SCM port;			/* Link back to the port object.  */
  int revealed;			/* 0 not revealed, > 1 revealed.
				 * Revealed ports do not get GC'd.
				 */
  /* data for the underlying port implementation as a raw C value. */
  scm_t_bits stream;

  SCM file_name;		/* debugging support.  */
  long line_number;		/* debugging support.  */
  int column_number;		/* debugging support.  */

  /* port buffers.  the buffer(s) are set up for all ports.  
     in the case of string ports, the buffer is the string itself.
     in the case of unbuffered file ports, the buffer is a
     single char: shortbuf.  */

  /* this buffer is filled from read_buf to read_end using the ptob 
     buffer_fill.  then input requests are taken from read_pos until
     it reaches read_end.  */

  unsigned char *read_buf;	/* buffer start.  */
  const unsigned char *read_pos;/* the next unread char.  */
  unsigned char *read_end;      /* pointer to last buffered char + 1.  */
  off_t read_buf_size;		/* size of the buffer.  */

  /* when chars are put back into the buffer, e.g., using peek-char or
     unread-string, the read-buffer pointers are switched to cbuf.
     the original pointers are saved here and restored when the put-back
     chars have been consumed.  */
  unsigned char *saved_read_buf;
  const unsigned char *saved_read_pos;
  unsigned char *saved_read_end;
  off_t saved_read_buf_size;

  /* write requests are saved into this buffer at write_pos until it
     reaches write_buf + write_buf_size, then the ptob flush is
     called.  */

  unsigned char *write_buf;     /* buffer start.  */
  unsigned char *write_pos;     /* pointer to last buffered char + 1.  */
  unsigned char *write_end;     /* pointer to end of buffer + 1.  */
  off_t write_buf_size;		/* size of the buffer.  */

  unsigned char shortbuf;       /* buffer for "unbuffered" streams.  */

  int rw_random;                /* true if the port is random access.
				   implies that the buffers must be
				   flushed before switching between
				   reading and writing, seeking, etc.  */

  scm_t_port_rw_active rw_active; /* for random access ports,
                                     indicates which of the buffers
                                     is currently in use.  can be
                                     SCM_PORT_WRITE, SCM_PORT_READ,
                                     or SCM_PORT_NEITHER.  */


  /* a buffer for un-read chars and strings.  */
  unsigned char *putback_buf;
  size_t putback_buf_size;        /* allocated size of putback_buf.  */
} scm_t_port;


SCM_INTERNAL scm_i_pthread_mutex_t scm_i_port_table_mutex;
SCM_INTERNAL SCM scm_i_port_weak_hash;


#define SCM_READ_BUFFER_EMPTY_P(c_port) (c_port->read_pos >= c_port->read_end)

\f

#define SCM_EOF_OBJECT_P(x) (scm_is_eq ((x), SCM_EOF_VAL))

/* PORT FLAGS
 * A set of flags characterizes a port.
 * Note that we reserve the bits 1 << 24 and above for use by the
 * routines in the port's scm_ptobfuns structure.
 */
#define SCM_OPN		(1L<<16) /* Is the port open? */
#define SCM_RDNG	(2L<<16) /* Is it a readable port? */
#define SCM_WRTNG	(4L<<16) /* Is it writable? */
#define SCM_BUF0	(8L<<16) /* Is it unbuffered? */
#define SCM_BUFLINE     (64L<<16) /* Is it line-buffered? */

#define SCM_PORTP(x) (!SCM_IMP (x) && (SCM_TYP7 (x) == scm_tc7_port))
#define SCM_OPPORTP(x) (!SCM_IMP(x) && (((0x7f | SCM_OPN) & SCM_CELL_WORD_0(x))==(scm_tc7_port | SCM_OPN)))
#define SCM_OPINPORTP(x) (!SCM_IMP(x) && (((0x7f | SCM_OPN | SCM_RDNG) & SCM_CELL_WORD_0(x))==(scm_tc7_port | SCM_OPN | SCM_RDNG)))
#define SCM_OPOUTPORTP(x) (!SCM_IMP(x) && (((0x7f | SCM_OPN | SCM_WRTNG) & SCM_CELL_WORD_0(x))==(scm_tc7_port | SCM_OPN | SCM_WRTNG)))
#define SCM_INPUT_PORT_P(x) \
  (!SCM_IMP(x) \
   && (((0x7f | SCM_RDNG) & SCM_CELL_WORD_0(x)) == (scm_tc7_port | SCM_RDNG)))
#define SCM_OUTPUT_PORT_P(x) \
  (!SCM_IMP(x) \
   && (((0x7f | SCM_WRTNG) & SCM_CELL_WORD_0(x))==(scm_tc7_port | SCM_WRTNG)))
#define SCM_OPENP(x) (!SCM_IMP(x) && (SCM_OPN & SCM_CELL_WORD_0 (x)))
#define SCM_CLOSEDP(x) (!SCM_OPENP(x))
#define SCM_CLR_PORT_OPEN_FLAG(p) \
  SCM_SET_CELL_WORD_0 ((p), SCM_CELL_WORD_0 (p) & ~SCM_OPN)

#define SCM_PTAB_ENTRY(x)         ((scm_t_port *) SCM_CELL_WORD_1 (x))
#define SCM_SETPTAB_ENTRY(x, ent)  (SCM_SET_CELL_WORD_1 ((x), (scm_t_bits) (ent)))
#define SCM_STREAM(x)             (SCM_PTAB_ENTRY(x)->stream)
#define SCM_SETSTREAM(x, s)        (SCM_PTAB_ENTRY(x)->stream = (scm_t_bits) (s))
#define SCM_FILENAME(x)           (SCM_PTAB_ENTRY(x)->file_name)
#define SCM_SET_FILENAME(x, n)    (SCM_PTAB_ENTRY(x)->file_name = (n))
#define SCM_LINUM(x)              (SCM_PTAB_ENTRY(x)->line_number)
#define SCM_COL(x)                (SCM_PTAB_ENTRY(x)->column_number)
#define SCM_REVEALED(x)           (SCM_PTAB_ENTRY(x)->revealed)
#define SCM_SETREVEALED(x, s)      (SCM_PTAB_ENTRY(x)->revealed = (s))

#define SCM_INCLINE(port)  	{SCM_LINUM (port) += 1; SCM_COL (port) = 0;}
#define SCM_ZEROCOL(port)  	{SCM_COL (port) = 0;}
#define SCM_INCCOL(port)  	{SCM_COL (port) += 1;}
#define SCM_DECCOL(port)  	{if (SCM_COL (port) > 0) SCM_COL (port) -= 1;}
#define SCM_TABCOL(port)  	{SCM_COL (port) += 8 - SCM_COL (port) % 8;}

/* Maximum number of port types.  */
#define SCM_I_MAX_PORT_TYPE_COUNT  256

\f

/* port-type description.  */
typedef struct scm_t_ptob_descriptor
{
  char *name;
  SCM (*mark) (SCM);
  size_t (*free) (SCM);
  int (*print) (SCM exp, SCM port, scm_print_state *pstate);
  SCM (*equalp) (SCM, SCM);
  int (*close) (SCM port);

  void (*write) (SCM port, const void *data, size_t size);
  void (*flush) (SCM port);

  void (*end_input) (SCM port, int offset);
  int (*fill_input) (SCM port);
  int (*input_waiting) (SCM port);

  off_t (*seek) (SCM port, off_t OFFSET, int WHENCE);
  void (*truncate) (SCM port, off_t length);

} scm_t_ptob_descriptor;

#define SCM_TC2PTOBNUM(x) (0x0ff & ((x) >> 8))
#define SCM_PTOBNUM(x) (SCM_TC2PTOBNUM (SCM_CELL_TYPE (x)))
/* SCM_PTOBNAME can be 0 if name is missing */
#define SCM_PTOBNAME(ptobnum) scm_ptobs[ptobnum].name

\f

SCM_API scm_t_ptob_descriptor *scm_ptobs;
SCM_API long scm_numptob;
SCM_INTERNAL long scm_i_port_table_room;

\f

SCM_API SCM scm_markstream (SCM ptr);
SCM_API scm_t_bits scm_make_port_type (char *name,
				       int (*fill_input) (SCM port),
				       void (*write) (SCM port, 
						      const void *data,
						      size_t size));
SCM_API void scm_set_port_mark (scm_t_bits tc, SCM (*mark) (SCM));
SCM_API void scm_set_port_free (scm_t_bits tc, size_t (*free) (SCM));
SCM_API void scm_set_port_print (scm_t_bits tc,
				 int (*print) (SCM exp,
					       SCM port,
					       scm_print_state *pstate));
SCM_API void scm_set_port_equalp (scm_t_bits tc, SCM (*equalp) (SCM, SCM));
SCM_API void scm_set_port_close (scm_t_bits tc, int (*close) (SCM));

SCM_API void scm_set_port_flush (scm_t_bits tc, 
				 void (*flush) (SCM port));
SCM_API void scm_set_port_end_input (scm_t_bits tc,
				     void (*end_input) (SCM port,
							int offset));
SCM_API void scm_set_port_seek (scm_t_bits tc,
				off_t (*seek) (SCM port,
					       off_t OFFSET,
					       int WHENCE));
SCM_API void scm_set_port_truncate (scm_t_bits tc,
				    void (*truncate) (SCM port,
						      off_t length));
SCM_API void scm_set_port_input_waiting (scm_t_bits tc, int (*input_waiting) (SCM));
SCM_API SCM scm_char_ready_p (SCM port);
size_t scm_take_from_input_buffers (SCM port, char *dest, size_t read_len);
SCM_API SCM scm_drain_input (SCM port);
SCM_API SCM scm_current_input_port (void);
SCM_API SCM scm_current_output_port (void);
SCM_API SCM scm_current_error_port (void);
SCM_API SCM scm_current_load_port (void);
SCM_API SCM scm_set_current_input_port (SCM port);
SCM_API SCM scm_set_current_output_port (SCM port);
SCM_API SCM scm_set_current_error_port (SCM port);
SCM_API void scm_dynwind_current_input_port (SCM port);
SCM_API void scm_dynwind_current_output_port (SCM port);
SCM_API void scm_dynwind_current_error_port (SCM port);
SCM_API SCM scm_new_port_table_entry (scm_t_bits tag);
SCM_INTERNAL void scm_i_remove_port (SCM port);
SCM_API void scm_grow_port_cbuf (SCM port, size_t requested);
SCM_API SCM scm_pt_size (void);
SCM_API SCM scm_pt_member (SCM member);
SCM_API void scm_port_non_buffer (scm_t_port *pt);
SCM_API int scm_revealed_count (SCM port);
SCM_API SCM scm_port_revealed (SCM port);
SCM_API SCM scm_set_port_revealed_x (SCM port, SCM rcount);
SCM_API long scm_mode_bits (char *modes);
SCM_API SCM scm_port_mode (SCM port);
SCM_API SCM scm_close_input_port (SCM port);
SCM_API SCM scm_close_output_port (SCM port);
SCM_API SCM scm_close_port (SCM port);
SCM_API SCM scm_port_for_each (SCM proc);
SCM_API void scm_c_port_for_each (void (*proc)(void *data, SCM p), void *data);
SCM_API SCM scm_input_port_p (SCM x);
SCM_API SCM scm_output_port_p (SCM x);
SCM_API SCM scm_port_p (SCM x);
SCM_API SCM scm_port_closed_p (SCM port);
SCM_API SCM scm_eof_object_p (SCM x);
SCM_API SCM scm_force_output (SCM port);
SCM_API SCM scm_flush_all_ports (void);
SCM_API SCM scm_read_char (SCM port);
SCM_API size_t scm_c_read (SCM port, void *buffer, size_t size);
SCM_API void scm_c_write (SCM port, const void *buffer, size_t size);
SCM_API void scm_lfwrite (const char *ptr, size_t size, SCM port);
SCM_API void scm_flush (SCM port);
SCM_API void scm_end_input (SCM port);
SCM_API int scm_fill_input (SCM port);
SCM_API void scm_ungetc (int c, SCM port);
SCM_API void scm_ungets (const char *s, int n, SCM port);
SCM_API SCM scm_peek_char (SCM port);
SCM_API SCM scm_unread_char (SCM cobj, SCM port);
SCM_API SCM scm_unread_string (SCM str, SCM port);
SCM_API SCM scm_seek (SCM object, SCM offset, SCM whence);
SCM_API SCM scm_truncate_file (SCM object, SCM length);
SCM_API SCM scm_port_line (SCM port);
SCM_API SCM scm_set_port_line_x (SCM port, SCM line);
SCM_API SCM scm_port_column (SCM port);
SCM_API SCM scm_set_port_column_x (SCM port, SCM line);
SCM_API SCM scm_port_filename (SCM port);
SCM_API SCM scm_set_port_filename_x (SCM port, SCM filename);
SCM_API int scm_port_print (SCM exp, SCM port, scm_print_state *);
SCM_API void scm_print_port_mode (SCM exp, SCM port);
SCM_API void scm_ports_prehistory (void);
SCM_API SCM scm_void_port (char * mode_str);
SCM_API SCM scm_sys_make_void_port (SCM mode);
SCM_INTERNAL void scm_init_ports (void);


#if SCM_ENABLE_DEPRECATED==1
SCM_API scm_t_port * scm_add_to_port_table (SCM port);
#endif

#ifdef GUILE_DEBUG
SCM_API SCM scm_pt_size (void);
SCM_API SCM scm_pt_member (SCM member);
#endif /* GUILE_DEBUG */

/* internal */

SCM_INTERNAL long scm_i_mode_bits (SCM modes);
SCM_INTERNAL void scm_i_dynwind_current_load_port (SCM port);


#endif  /* SCM_PORTS_H */

/*
  Local Variables:
  c-file-style: "gnu"
  End:
*/
Commit	Line	Data
0f2d19dd JB	1	/* classes: h_files */
0f2d19dd JB	2
22a52da1 DH	3	#ifndef SCM_PORTS_H
22a52da1 DH	4	#define SCM_PORTS_H
8c494e99	5
5bb2d903	6	/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2003, 2004, 2006, 2008, 2009 Free Software Foundation, Inc.
8c494e99	7	*
73be1d9e	8	* This library is free software; you can redistribute it and/or
53befeb7 NJ	9	* modify it under the terms of the GNU Lesser General Public License
	10	* as published by the Free Software Foundation; either version 3 of
	11	* the License, or (at your option) any later version.
8c494e99	12	*
53befeb7 NJ	13	* This library is distributed in the hope that it will be useful, but
53befeb7 NJ	14	* WITHOUT ANY WARRANTY; without even the implied warranty of
73be1d9e MV	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
73be1d9e MV	16	* Lesser General Public License for more details.
8c494e99	17	*
73be1d9e MV	18	* You should have received a copy of the GNU Lesser General Public
73be1d9e MV	19	* License along with this library; if not, write to the Free Software
53befeb7 NJ	20	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
53befeb7 NJ	21	* 02110-1301 USA
73be1d9e	22	*/
d3a6bc94	23
0f2d19dd	24	\f
8c494e99	25
b4309c3c	26	#include "libguile/__scm.h"
0f2d19dd	27
e0d86ad2	28	#include "libguile/print.h"
78446828	29	#include "libguile/struct.h"
b9ad392e	30	#include "libguile/threads.h"
e0d86ad2	31
acdb12da JB	32	/* Not sure if this is a good idea. We need it for off_t. */
	33	#include <sys/types.h>
	34
0f2d19dd JB	35	\f
0f2d19dd JB	36
6c951427	37	#define SCM_INITIAL_PUTBACK_BUF_SIZE 4
0855ef71	38
61e452ba	39	/* values for the rw_active flag. */
92c2555f	40	typedef enum scm_t_port_rw_active {
61e452ba JB	41	SCM_PORT_NEITHER = 0,
	42	SCM_PORT_READ = 1,
	43	SCM_PORT_WRITE = 2
92c2555f	44	} scm_t_port_rw_active;
61e452ba	45
840ae05d JB	46	/* C representation of a Scheme port. */
	47
	48	typedef struct
0f2d19dd	49	{
ee149d03	50	SCM port; /* Link back to the port object. */
0f2d19dd JB	51	int revealed; /* 0 not revealed, > 1 revealed.
	52	* Revealed ports do not get GC'd.
	53	*/
74a16888	54	/* data for the underlying port implementation as a raw C value. */
92c2555f	55	scm_t_bits stream;
0f2d19dd	56
0855ef71	57	SCM file_name; /* debugging support. */
1be6b49c	58	long line_number; /* debugging support. */
ebf7394e	59	int column_number; /* debugging support. */
0855ef71	60
ee149d03 JB	61	/* port buffers. the buffer(s) are set up for all ports.
	62	in the case of string ports, the buffer is the string itself.
	63	in the case of unbuffered file ports, the buffer is a
	64	single char: shortbuf. */
	65
	66	/* this buffer is filled from read_buf to read_end using the ptob
	67	buffer_fill. then input requests are taken from read_pos until
	68	it reaches read_end. */
	69
	70	unsigned char read_buf; / buffer start. */
840ae05d	71	const unsigned char read_pos;/ the next unread char. */
ee149d03	72	unsigned char read_end; / pointer to last buffered char + 1. */
840ae05d	73	off_t read_buf_size; /* size of the buffer. */
ee149d03	74
6c951427 GH	75	/* when chars are put back into the buffer, e.g., using peek-char or
	76	unread-string, the read-buffer pointers are switched to cbuf.
	77	the original pointers are saved here and restored when the put-back
	78	chars have been consumed. */
	79	unsigned char *saved_read_buf;
	80	const unsigned char *saved_read_pos;
	81	unsigned char *saved_read_end;
	82	off_t saved_read_buf_size;
	83
ee149d03 JB	84	/* write requests are saved into this buffer at write_pos until it
	85	reaches write_buf + write_buf_size, then the ptob flush is
	86	called. */
	87
6c951427	88	unsigned char write_buf; / buffer start. */
ee149d03 JB	89	unsigned char write_pos; / pointer to last buffered char + 1. */
ee149d03 JB	90	unsigned char write_end; / pointer to end of buffer + 1. */
840ae05d	91	off_t write_buf_size; /* size of the buffer. */
ee149d03 JB	92
	93	unsigned char shortbuf; /* buffer for "unbuffered" streams. */
	94
0de97b83 GH	95	int rw_random; /* true if the port is random access.
	96	implies that the buffers must be
	97	flushed before switching between
	98	reading and writing, seeking, etc. */
	99
92c2555f	100	scm_t_port_rw_active rw_active; /* for random access ports,
1be6b49c ML	101	indicates which of the buffers
	102	is currently in use. can be
	103	SCM_PORT_WRITE, SCM_PORT_READ,
	104	or SCM_PORT_NEITHER. */
ee149d03	105
61e452ba	106
6c951427 GH	107	/* a buffer for un-read chars and strings. */
6c951427 GH	108	unsigned char *putback_buf;
1be6b49c	109	size_t putback_buf_size; /* allocated size of putback_buf. */
92c2555f	110	} scm_t_port;
840ae05d	111
5dbc6c06	112
102dbb6f LC	113	SCM_INTERNAL scm_i_pthread_mutex_t scm_i_port_table_mutex;
102dbb6f LC	114	SCM_INTERNAL SCM scm_i_port_weak_hash;
5dbc6c06	115
0f2d19dd	116
6fe692e9	117	#define SCM_READ_BUFFER_EMPTY_P(c_port) (c_port->read_pos >= c_port->read_end)
0f2d19dd JB	118
	119	\f
	120
bc36d050	121	#define SCM_EOF_OBJECT_P(x) (scm_is_eq ((x), SCM_EOF_VAL))
0c32d76c	122
0f2d19dd	123	/* PORT FLAGS
dbece3a2	124	* A set of flags characterizes a port.
571031dc JB	125	* Note that we reserve the bits 1 << 24 and above for use by the
571031dc JB	126	* routines in the port's scm_ptobfuns structure.
0f2d19dd JB	127	*/
	128	#define SCM_OPN (1L<<16) /* Is the port open? */
	129	#define SCM_RDNG (2L<<16) /* Is it a readable port? */
	130	#define SCM_WRTNG (4L<<16) /* Is it writable? */
ee149d03	131	#define SCM_BUF0 (8L<<16) /* Is it unbuffered? */
ee149d03	132	#define SCM_BUFLINE (64L<<16) /* Is it line-buffered? */
0f2d19dd	133
8c494e99 DH	134	#define SCM_PORTP(x) (!SCM_IMP (x) && (SCM_TYP7 (x) == scm_tc7_port))
	135	#define SCM_OPPORTP(x) (!SCM_IMP(x) && (((0x7f \| SCM_OPN) & SCM_CELL_WORD_0(x))==(scm_tc7_port \| SCM_OPN)))
	136	#define SCM_OPINPORTP(x) (!SCM_IMP(x) && (((0x7f \| SCM_OPN \| SCM_RDNG) & SCM_CELL_WORD_0(x))==(scm_tc7_port \| SCM_OPN \| SCM_RDNG)))
	137	#define SCM_OPOUTPORTP(x) (!SCM_IMP(x) && (((0x7f \| SCM_OPN \| SCM_WRTNG) & SCM_CELL_WORD_0(x))==(scm_tc7_port \| SCM_OPN \| SCM_WRTNG)))
df97587f	138	#define SCM_INPUT_PORT_P(x) \
8c494e99	139	(!SCM_IMP(x) \
f9a64404	140	&& (((0x7f \| SCM_RDNG) & SCM_CELL_WORD_0(x)) == (scm_tc7_port \| SCM_RDNG)))
df97587f	141	#define SCM_OUTPUT_PORT_P(x) \
8c494e99	142	(!SCM_IMP(x) \
f9a64404	143	&& (((0x7f \| SCM_WRTNG) & SCM_CELL_WORD_0(x))==(scm_tc7_port \| SCM_WRTNG)))
8c494e99	144	#define SCM_OPENP(x) (!SCM_IMP(x) && (SCM_OPN & SCM_CELL_WORD_0 (x)))
0f2d19dd	145	#define SCM_CLOSEDP(x) (!SCM_OPENP(x))
22a52da1 DH	146	#define SCM_CLR_PORT_OPEN_FLAG(p) \
22a52da1 DH	147	SCM_SET_CELL_WORD_0 ((p), SCM_CELL_WORD_0 (p) & ~SCM_OPN)
843524cc	148
92c2555f	149	#define SCM_PTAB_ENTRY(x) ((scm_t_port *) SCM_CELL_WORD_1 (x))
34d19ef6	150	#define SCM_SETPTAB_ENTRY(x, ent) (SCM_SET_CELL_WORD_1 ((x), (scm_t_bits) (ent)))
843524cc	151	#define SCM_STREAM(x) (SCM_PTAB_ENTRY(x)->stream)
34d19ef6	152	#define SCM_SETSTREAM(x, s) (SCM_PTAB_ENTRY(x)->stream = (scm_t_bits) (s))
843524cc	153	#define SCM_FILENAME(x) (SCM_PTAB_ENTRY(x)->file_name)
b24b5e13	154	#define SCM_SET_FILENAME(x, n) (SCM_PTAB_ENTRY(x)->file_name = (n))
843524cc DH	155	#define SCM_LINUM(x) (SCM_PTAB_ENTRY(x)->line_number)
	156	#define SCM_COL(x) (SCM_PTAB_ENTRY(x)->column_number)
	157	#define SCM_REVEALED(x) (SCM_PTAB_ENTRY(x)->revealed)
34d19ef6	158	#define SCM_SETREVEALED(x, s) (SCM_PTAB_ENTRY(x)->revealed = (s))
0f2d19dd JB	159
0f2d19dd JB	160	#define SCM_INCLINE(port) {SCM_LINUM (port) += 1; SCM_COL (port) = 0;}
92680388	161	#define SCM_ZEROCOL(port) {SCM_COL (port) = 0;}
0f2d19dd	162	#define SCM_INCCOL(port) {SCM_COL (port) += 1;}
92680388	163	#define SCM_DECCOL(port) {if (SCM_COL (port) > 0) SCM_COL (port) -= 1;}
d14af9f2	164	#define SCM_TABCOL(port) {SCM_COL (port) += 8 - SCM_COL (port) % 8;}
0f2d19dd	165
5bb2d903 LC	166	/* Maximum number of port types. */
	167	#define SCM_I_MAX_PORT_TYPE_COUNT 256
	168
0f2d19dd JB	169	\f
0f2d19dd JB	170
affc96b5	171	/* port-type description. */
92c2555f	172	typedef struct scm_t_ptob_descriptor
0f82baf6	173	{
f12733c9	174	char *name;
0c0669cc	175	SCM (*mark) (SCM);
1be6b49c	176	size_t (*free) (SCM);
0c0669cc JB	177	int (print) (SCM exp, SCM port, scm_print_state pstate);
0c0669cc JB	178	SCM (*equalp) (SCM, SCM);
affc96b5 GH	179	int (*close) (SCM port);
affc96b5 GH	180
8aa011a1	181	void (write) (SCM port, const void data, size_t size);
affc96b5 GH	182	void (*flush) (SCM port);
	183
	184	void (*end_input) (SCM port, int offset);
	185	int (*fill_input) (SCM port);
	186	int (*input_waiting) (SCM port);
	187
ee149d03	188	off_t (*seek) (SCM port, off_t OFFSET, int WHENCE);
affc96b5 GH	189	void (*truncate) (SCM port, off_t length);
affc96b5 GH	190
92c2555f	191	} scm_t_ptob_descriptor;
1be6b49c	192
12a8b769 DH	193	#define SCM_TC2PTOBNUM(x) (0x0ff & ((x) >> 8))
12a8b769 DH	194	#define SCM_PTOBNUM(x) (SCM_TC2PTOBNUM (SCM_CELL_TYPE (x)))
f12733c9 MD	195	/* SCM_PTOBNAME can be 0 if name is missing */
f12733c9 MD	196	#define SCM_PTOBNAME(ptobnum) scm_ptobs[ptobnum].name
0f82baf6 JB	197
	198	\f
	199
33b001fd MV	200	SCM_API scm_t_ptob_descriptor *scm_ptobs;
33b001fd MV	201	SCM_API long scm_numptob;
102dbb6f	202	SCM_INTERNAL long scm_i_port_table_room;
0f2d19dd JB	203
0f2d19dd JB	204	\f
0f2d19dd	205
33b001fd MV	206	SCM_API SCM scm_markstream (SCM ptr);
	207	SCM_API scm_t_bits scm_make_port_type (char *name,
	208	int (*fill_input) (SCM port),
	209	void (*write) (SCM port,
	210	const void *data,
	211	size_t size));
23f2b9a3 KR	212	SCM_API void scm_set_port_mark (scm_t_bits tc, SCM (*mark) (SCM));
	213	SCM_API void scm_set_port_free (scm_t_bits tc, size_t (*free) (SCM));
	214	SCM_API void scm_set_port_print (scm_t_bits tc,
33b001fd MV	215	int (*print) (SCM exp,
	216	SCM port,
	217	scm_print_state *pstate));
23f2b9a3 KR	218	SCM_API void scm_set_port_equalp (scm_t_bits tc, SCM (*equalp) (SCM, SCM));
23f2b9a3 KR	219	SCM_API void scm_set_port_close (scm_t_bits tc, int (*close) (SCM));
33b001fd	220
23f2b9a3	221	SCM_API void scm_set_port_flush (scm_t_bits tc,
33b001fd	222	void (*flush) (SCM port));
23f2b9a3	223	SCM_API void scm_set_port_end_input (scm_t_bits tc,
33b001fd MV	224	void (*end_input) (SCM port,
33b001fd MV	225	int offset));
23f2b9a3	226	SCM_API void scm_set_port_seek (scm_t_bits tc,
33b001fd MV	227	off_t (*seek) (SCM port,
	228	off_t OFFSET,
	229	int WHENCE));
23f2b9a3	230	SCM_API void scm_set_port_truncate (scm_t_bits tc,
33b001fd MV	231	void (*truncate) (SCM port,
33b001fd MV	232	off_t length));
23f2b9a3	233	SCM_API void scm_set_port_input_waiting (scm_t_bits tc, int (*input_waiting) (SCM));
33b001fd	234	SCM_API SCM scm_char_ready_p (SCM port);
c2da2648	235	size_t scm_take_from_input_buffers (SCM port, char *dest, size_t read_len);
33b001fd MV	236	SCM_API SCM scm_drain_input (SCM port);
	237	SCM_API SCM scm_current_input_port (void);
	238	SCM_API SCM scm_current_output_port (void);
	239	SCM_API SCM scm_current_error_port (void);
	240	SCM_API SCM scm_current_load_port (void);
	241	SCM_API SCM scm_set_current_input_port (SCM port);
	242	SCM_API SCM scm_set_current_output_port (SCM port);
	243	SCM_API SCM scm_set_current_error_port (SCM port);
661ae7ab MV	244	SCM_API void scm_dynwind_current_input_port (SCM port);
	245	SCM_API void scm_dynwind_current_output_port (SCM port);
	246	SCM_API void scm_dynwind_current_error_port (SCM port);
da220f27	247	SCM_API SCM scm_new_port_table_entry (scm_t_bits tag);
102dbb6f	248	SCM_INTERNAL void scm_i_remove_port (SCM port);
33b001fd MV	249	SCM_API void scm_grow_port_cbuf (SCM port, size_t requested);
	250	SCM_API SCM scm_pt_size (void);
	251	SCM_API SCM scm_pt_member (SCM member);
	252	SCM_API void scm_port_non_buffer (scm_t_port *pt);
	253	SCM_API int scm_revealed_count (SCM port);
	254	SCM_API SCM scm_port_revealed (SCM port);
	255	SCM_API SCM scm_set_port_revealed_x (SCM port, SCM rcount);
	256	SCM_API long scm_mode_bits (char *modes);
	257	SCM_API SCM scm_port_mode (SCM port);
	258	SCM_API SCM scm_close_input_port (SCM port);
	259	SCM_API SCM scm_close_output_port (SCM port);
	260	SCM_API SCM scm_close_port (SCM port);
	261	SCM_API SCM scm_port_for_each (SCM proc);
c536b4b3	262	SCM_API void scm_c_port_for_each (void (proc)(void data, SCM p), void *data);
33b001fd MV	263	SCM_API SCM scm_input_port_p (SCM x);
	264	SCM_API SCM scm_output_port_p (SCM x);
	265	SCM_API SCM scm_port_p (SCM x);
	266	SCM_API SCM scm_port_closed_p (SCM port);
	267	SCM_API SCM scm_eof_object_p (SCM x);
	268	SCM_API SCM scm_force_output (SCM port);
	269	SCM_API SCM scm_flush_all_ports (void);
	270	SCM_API SCM scm_read_char (SCM port);
33b001fd MV	271	SCM_API size_t scm_c_read (SCM port, void *buffer, size_t size);
	272	SCM_API void scm_c_write (SCM port, const void *buffer, size_t size);
	273	SCM_API void scm_lfwrite (const char *ptr, size_t size, SCM port);
	274	SCM_API void scm_flush (SCM port);
	275	SCM_API void scm_end_input (SCM port);
	276	SCM_API int scm_fill_input (SCM port);
33b001fd MV	277	SCM_API void scm_ungetc (int c, SCM port);
	278	SCM_API void scm_ungets (const char *s, int n, SCM port);
	279	SCM_API SCM scm_peek_char (SCM port);
	280	SCM_API SCM scm_unread_char (SCM cobj, SCM port);
	281	SCM_API SCM scm_unread_string (SCM str, SCM port);
	282	SCM_API SCM scm_seek (SCM object, SCM offset, SCM whence);
	283	SCM_API SCM scm_truncate_file (SCM object, SCM length);
	284	SCM_API SCM scm_port_line (SCM port);
	285	SCM_API SCM scm_set_port_line_x (SCM port, SCM line);
	286	SCM_API SCM scm_port_column (SCM port);
	287	SCM_API SCM scm_set_port_column_x (SCM port, SCM line);
	288	SCM_API SCM scm_port_filename (SCM port);
	289	SCM_API SCM scm_set_port_filename_x (SCM port, SCM filename);
	290	SCM_API int scm_port_print (SCM exp, SCM port, scm_print_state *);
	291	SCM_API void scm_print_port_mode (SCM exp, SCM port);
	292	SCM_API void scm_ports_prehistory (void);
	293	SCM_API SCM scm_void_port (char * mode_str);
	294	SCM_API SCM scm_sys_make_void_port (SCM mode);
102dbb6f	295	SCM_INTERNAL void scm_init_ports (void);
0f2d19dd	296
67329a9e HWN	297
	298	#if SCM_ENABLE_DEPRECATED==1
	299	SCM_API scm_t_port * scm_add_to_port_table (SCM port);
	300	#endif
	301
f3667f52	302	#ifdef GUILE_DEBUG
33b001fd MV	303	SCM_API SCM scm_pt_size (void);
33b001fd MV	304	SCM_API SCM scm_pt_member (SCM member);
be1cd096	305	#endif /* GUILE_DEBUG */
f3667f52	306
d617ee18 MV	307	/* internal */
d617ee18 MV	308
102dbb6f LC	309	SCM_INTERNAL long scm_i_mode_bits (SCM modes);
102dbb6f LC	310	SCM_INTERNAL void scm_i_dynwind_current_load_port (SCM port);
d617ee18 MV	311
d617ee18 MV	312
22a52da1	313	#endif /* SCM_PORTS_H */
89e00824 ML	314
	315	/*
	316	Local Variables:
	317	c-file-style: "gnu"
	318	End:
	319	*/