[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, 2010, 2011 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"
#include "libguile/strings.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.  */

  /* Character encoding support  */
  char *encoding;
  scm_t_string_failed_conversion_handler ilseq_handler;

  /* 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.  */
  scm_t_off 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;
  scm_t_off 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.  */
  scm_t_off 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.  */

  /* input/output iconv conversion descriptors */
  void *input_cd;
  void *output_cd;
} 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)  	do {SCM_LINUM (port) += 1; SCM_COL (port) = 0;} while (0)
#define SCM_ZEROCOL(port)  	do {SCM_COL (port) = 0;} while (0)
#define SCM_INCCOL(port)  	do {SCM_COL (port) += 1;} while (0)
#define SCM_DECCOL(port)  	do {if (SCM_COL (port) > 0) SCM_COL (port) -= 1;} while (0)
#define SCM_TABCOL(port)  	do {SCM_COL (port) += 8 - SCM_COL (port) % 8;} while (0)

/* 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);

  scm_t_off (*seek) (SCM port, scm_t_off OFFSET, int WHENCE);
  void (*truncate) (SCM port, scm_t_off 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;

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