1 /* Copyright (C) 1995,1996,1998,1999,2000,2001, 2002, 2003, 2006 Free Software Foundation, Inc.
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public License
5 * as published by the Free Software Foundation; either version 3 of
6 * the License, or (at your option) any later version.
8 * This library is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
28 #include "libguile/_scm.h"
29 #include "libguile/eval.h"
30 #include "libguile/chars.h"
31 #include "libguile/fports.h"
32 #include "libguile/root.h"
33 #include "libguile/strings.h"
34 #include "libguile/vectors.h"
36 #include "libguile/validate.h"
37 #include "libguile/vports.h"
45 /* {Ports - soft ports}
50 static scm_t_bits scm_tc16_sfport
;
56 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
57 SCM stream
= SCM_PACK (pt
->stream
);
59 if (pt
->write_pos
> pt
->write_buf
)
62 scm_call_1 (SCM_SIMPLE_VECTOR_REF (stream
, 0),
63 SCM_MAKE_CHAR (*pt
->write_buf
));
64 pt
->write_pos
= pt
->write_buf
;
66 /* flush the output. */
68 SCM f
= SCM_SIMPLE_VECTOR_REF (stream
, 2);
77 sf_write (SCM port
, const void *data
, size_t size
)
79 SCM p
= SCM_PACK (SCM_STREAM (port
));
81 scm_call_1 (SCM_SIMPLE_VECTOR_REF (p
, 1),
82 scm_from_locale_stringn ((char *) data
, size
));
85 /* calling the flush proc (element 2) is in case old code needs it,
86 but perhaps softports could the use port buffer in the same way as
89 /* places a single char in the input buffer. */
91 sf_fill_input (SCM port
)
93 SCM p
= SCM_PACK (SCM_STREAM (port
));
96 ans
= scm_call_0 (SCM_SIMPLE_VECTOR_REF (p
, 3)); /* get char. */
97 if (scm_is_false (ans
) || SCM_EOF_OBJECT_P (ans
))
99 SCM_ASSERT (SCM_CHARP (ans
), ans
, SCM_ARG1
, "sf_fill_input");
101 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
103 *pt
->read_buf
= SCM_CHAR (ans
);
104 pt
->read_pos
= pt
->read_buf
;
105 pt
->read_end
= pt
->read_buf
+ 1;
106 return *pt
->read_buf
;
114 SCM p
= SCM_PACK (SCM_STREAM (port
));
115 SCM f
= SCM_SIMPLE_VECTOR_REF (p
, 4);
116 if (scm_is_false (f
))
120 return scm_is_false (f
) ? EOF
: 0;
125 sf_input_waiting (SCM port
)
127 SCM p
= SCM_PACK (SCM_STREAM (port
));
128 if (SCM_SIMPLE_VECTOR_LENGTH (p
) >= 6)
130 SCM f
= SCM_SIMPLE_VECTOR_REF (p
, 5);
132 return scm_to_int (scm_call_0 (f
));
134 /* Default is such that char-ready? for soft ports returns #t, as it
135 did before this extension was implemented. */
141 SCM_DEFINE (scm_make_soft_port
, "make-soft-port", 2, 0, 0,
143 "Return a port capable of receiving or delivering characters as\n"
144 "specified by the @var{modes} string (@pxref{File Ports,\n"
145 "open-file}). @var{pv} must be a vector of length 5 or 6. Its\n"
146 "components are as follows:\n"
150 "procedure accepting one character for output\n"
152 "procedure accepting a string for output\n"
154 "thunk for flushing output\n"
156 "thunk for getting one character\n"
158 "thunk for closing port (not by garbage collection)\n"
160 "(if present and not @code{#f}) thunk for computing the number of\n"
161 "characters that can be read from the port without blocking.\n"
164 "For an output-only port only elements 0, 1, 2, and 4 need be\n"
165 "procedures. For an input-only port only elements 3 and 4 need\n"
166 "be procedures. Thunks 2 and 4 can instead be @code{#f} if\n"
167 "there is no useful operation for them to perform.\n"
169 "If thunk 3 returns @code{#f} or an @code{eof-object}\n"
170 "(@pxref{Input, eof-object?, ,r5rs, The Revised^5 Report on\n"
171 "Scheme}) it indicates that the port has reached end-of-file.\n"
175 "(define stdout (current-output-port))\n"
176 "(define p (make-soft-port\n"
178 " (lambda (c) (write c stdout))\n"
179 " (lambda (s) (display s stdout))\n"
180 " (lambda () (display \".\" stdout))\n"
181 " (lambda () (char-upcase (read-char)))\n"
182 " (lambda () (display \"@@\" stdout)))\n"
185 "(write p p) @result{} #<input-output: soft 8081e20>\n"
187 #define FUNC_NAME s_scm_make_soft_port
193 SCM_VALIDATE_VECTOR (1, pv
);
194 vlen
= SCM_SIMPLE_VECTOR_LENGTH (pv
);
195 SCM_ASSERT ((vlen
== 5) || (vlen
== 6), pv
, 1, FUNC_NAME
);
196 SCM_VALIDATE_STRING (2, modes
);
198 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
199 z
= scm_new_port_table_entry (scm_tc16_sfport
);
200 pt
= SCM_PTAB_ENTRY (z
);
201 scm_port_non_buffer (pt
);
202 SCM_SET_CELL_TYPE (z
, scm_tc16_sfport
| scm_i_mode_bits (modes
));
204 SCM_SETSTREAM (z
, SCM_UNPACK (pv
));
205 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
214 scm_t_bits tc
= scm_make_port_type ("soft", sf_fill_input
, sf_write
);
216 scm_set_port_mark (tc
, scm_markstream
);
217 scm_set_port_flush (tc
, sf_flush
);
218 scm_set_port_close (tc
, sf_close
);
219 scm_set_port_input_waiting (tc
, sf_input_waiting
);
227 scm_tc16_sfport
= scm_make_sfptob ();
229 #include "libguile/vports.x"