1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2004-2008 Jean Privat <jean@pryen.org>
5 # This file is free software, which comes along with NIT. This software is
6 # distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
7 # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
8 # PARTICULAR PURPOSE. You can modify it is you want, provided this header
9 # is kept unaltered, and a notification of the changes is added.
10 # You are allowed to redistribute it and sell it, alone or is a part of
13 # Input and output streams of characters
26 # Abstract stream class
32 # Abstract input streams
35 # Read a character. Return its ASCII value, -1 on EOF or timeout
36 fun read_char
: Int is abstract
38 # Read at most i bytes
39 fun read
(i
: Int): String
41 var s
= new FlatBuffer.with_capacity
(i
)
42 while i
> 0 and not eof
do
52 # Read a string until the end of the line.
56 var s
= new FlatBuffer
61 # Read all the stream until the eof.
64 var s
= new FlatBuffer
67 if c
>= 0 then s
.add
(c
.ascii
)
72 # Read a string until the end of the line and append it to `s`.
73 fun append_line_to
(s
: Buffer)
82 if c
== '\n' then return
87 # Is there something to read.
88 # This function returns 'false' if there is something to read.
89 fun eof
: Bool is abstract
92 # IStream capable of declaring if readable without blocking
93 interface PollableIStream
96 # Is there something to read? (without blocking)
97 fun poll_in
: Bool is abstract
101 # Abstract output stream
105 fun write
(s
: Text) is abstract
107 # Can the stream be used to write
108 fun is_writable
: Bool is abstract
111 # Things that can be efficienlty writen to a OStream
113 # The point of this interface it to allow is instance to be efficenty
114 # writen into a OStream without having to allocate a big String object
116 # ready-to-save documents usually provide this interface.
118 # Write itself to a `stream`
119 # The specific logic it let to the concrete subclasses
120 fun write_to
(stream
: OStream) is abstract
122 # Like `write_to` but return a new String (may be quite large)
124 # This funtionnality is anectodical, since the point
125 # of streamable object to to be efficienlty written to a
126 # stream without having to allocate and concatenate strings
127 fun write_to_string
: String
129 var stream
= new StringOStream
137 redef fun write_to
(stream
) do stream
.write
(self)
146 redef fun write_to
(s
) do s
.write
(str
)
151 redef fun write_to
(s
)
153 if left
!= null then left
.write_to
(s
)
154 if right
!= null then right
.write_to
(s
)
158 redef class RopeString
160 redef fun write_to
(s
) do root
.write_to
(s
)
163 # Input streams with a buffer
164 abstract class BufferedIStream
169 if _buffer_pos
>= _buffer
.length
then
172 if _buffer_pos
>= _buffer
.length
then
175 var c
= _buffer
.chars
[_buffer_pos
]
182 if _buffer
.length
== _buffer_pos
then
189 if _buffer_pos
+ i
>= _buffer
.length
then
190 var from
= _buffer_pos
191 _buffer_pos
= _buffer
.length
192 return _buffer
.substring_from
(from
).to_s
195 return _buffer
.substring
(_buffer_pos
- i
, i
).to_s
200 var s
= new FlatBuffer
203 var k
= _buffer
.length
205 s
.add
(_buffer
.chars
[j
])
214 redef fun append_line_to
(s
)
217 # First phase: look for a '\n'
219 while i
< _buffer
.length
and _buffer
.chars
[i
] != '\n' do i
+= 1
221 # if there is something to append
222 if i
> _buffer_pos
then
223 # Enlarge the string (if needed)
224 s
.enlarge
(s
.length
+ i
- _buffer_pos
)
226 # Copy from the buffer to the string
229 s
.add
(_buffer
.chars
[j
])
234 if i
< _buffer
.length
then
235 # so \n is in _buffer[i]
236 _buffer_pos
= i
+ 1 # skip \n
250 redef fun eof
do return _buffer_pos
>= _buffer
.length
and end_reached
253 var _buffer
: nullable FlatBuffer = null
255 # The current position in the buffer
256 var _buffer_pos
: Int = 0
259 protected fun fill_buffer
is abstract
261 # Is the last fill_buffer reach the end
262 protected fun end_reached
: Bool is abstract
264 # Allocate a `_buffer` for a given `capacity`.
265 protected fun prepare_buffer
(capacity
: Int)
267 _buffer
= new FlatBuffer.with_capacity
(capacity
)
268 _buffer_pos
= 0 # need to read
277 ##############################################################"
279 abstract class FDStream
284 redef fun close
do native_close
(fd
)
286 private fun native_close
(i
: Int): Int is extern "stream_FDStream_FDStream_native_close_1"
287 private fun native_read_char
(i
: Int): Int is extern "stream_FDStream_FDStream_native_read_char_1"
288 private fun native_read
(i
: Int, buf
: NativeString, len
: Int): Int is extern "stream_FDStream_FDStream_native_read_3"
289 private fun native_write
(i
: Int, buf
: NativeString, len
: Int): Int is extern "stream_FDStream_FDStream_native_write_3"
290 private fun native_write_char
(i
: Int, c
: Char): Int is extern "stream_FDStream_FDStream_native_write_char_2"
292 init(fd
: Int) do self.fd
= fd
298 redef var eof
: Bool = false
302 var nb
= native_read_char
(fd
)
303 if nb
== -1 then eof
= true
313 redef var is_writable
: Bool
317 var nb
= native_write
(fd
, s
.to_cstring
, s
.length
)
318 if nb
< s
.length
then is_writable
= false
338 redef interface Object
339 # returns first available stream to read or write to
340 # return null on interruption (possibly a signal)
341 protected fun poll
( streams
: Sequence[FDStream] ) : nullable FDStream
343 var in_fds
= new Array[Int]
344 var out_fds
= new Array[Int]
345 var fd_to_stream
= new HashMap[Int,FDStream]
348 if s
isa FDIStream then in_fds
.add
( fd
)
349 if s
isa FDOStream then out_fds
.add
( fd
)
354 var polled_fd
= intern_poll
( in_fds
, out_fds
)
356 if polled_fd
== null then
359 return fd_to_stream
[polled_fd
]
363 private fun intern_poll
(in_fds
: Array[Int], out_fds
: Array[Int]) : nullable Int is extern import Array[Int].length
, Array[Int].[], Int.as(nullable Int) `{
364 int in_len, out_len, total_len;
365 struct pollfd *c_fds;
368 int first_polled_fd = -1;
371 in_len = Array_of_Int_length( in_fds );
372 out_len = Array_of_Int_length( out_fds );
373 total_len = in_len + out_len;
374 c_fds = malloc( sizeof(struct pollfd) * total_len );
377 for ( i=0; i<in_len; i ++ ) {
379 fd = Array_of_Int__index( in_fds, i );
382 c_fds[i].events = POLLIN;
386 for ( i=0; i<out_len; i ++ ) {
388 fd = Array_of_Int__index( out_fds, i );
391 c_fds[i].events = POLLOUT;
394 /* poll all fds, unlimited timeout */
395 result = poll( c_fds, total_len, -1 );
398 /* analyse results */
399 for ( i=0; i<total_len; i++ )
400 if ( c_fds[i].revents & c_fds[i].events || /* awaited event */
401 c_fds[i].revents & POLLHUP ) /* closed */
403 first_polled_fd = c_fds[i].fd;
407 return Int_as_nullable( first_polled_fd );
409 else if ( result < 0 )
410 fprintf( stderr, "Error in Stream:poll: %s\n", strerror( errno ) );
416 # Stream to a String. Mainly used for compatibility with OStream type and tests.
420 private var content
= new Array[String]
421 redef fun to_s
do return content
.to_s
422 redef fun is_writable
do return not closed
426 content
.add
(str
.to_s
)
429 protected var closed
= false
430 redef fun close
do closed
= true