1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # This file is free software, which comes along with NIT. This software is
4 # distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
5 # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
6 # PARTICULAR PURPOSE. You can modify it is you want, provided this header
7 # is kept unaltered, and a notification of the changes is added.
8 # You are allowed to redistribute it and sell it, alone or is a part of
11 # Input and output streams of characters
24 # Any kind of error that could be produced by an operation on Streams
29 # Any kind of stream to read/write/both to or from a source
31 # Codec used to transform raw data to text
33 # Note: defaults to UTF-8
34 var codec
: Codec = utf8_codec
is protected writable(set_codec
)
36 # Lookahead buffer for codecs
38 # Since some codecs are multibyte, a lookahead may be required
39 # to store the next bytes and consume them only if a valid character
41 protected var lookahead
: CString is noinit
43 # Capacity of the lookahead
44 protected var lookahead_capacity
= 0
46 # Current occupation of the lookahead
47 protected var lookahead_length
= 0
49 # Buffer for writing data to a stream
50 protected var write_buffer
: CString is noinit
53 var lcap
= codec
.max_lookahead
54 lookahead
= new CString(lcap
)
55 write_buffer
= new CString(lcap
)
57 lookahead_capacity
= lcap
60 # Change the codec for this stream.
61 fun codec
=(c
: Codec) do
62 if c
.max_lookahead
> lookahead_capacity
then
63 var lcap
= codec
.max_lookahead
64 var lk
= new CString(lcap
)
65 var llen
= lookahead_length
67 lookahead
.copy_to
(lk
, llen
, 0, 0)
70 lookahead_capacity
= lcap
71 write_buffer
= new CString(lcap
)
76 # Error produced by the file stream
78 # var ifs = new FileReader.open("donotmakethisfile.binx")
81 # assert ifs.last_error != null
82 var last_error
: nullable IOError = null
89 # Used to inform `self` that operations will start.
90 # Specific streams can use this to prepare some resources.
92 # Is automatically invoked at the beginning of `with` structures.
94 # Do nothing by default.
99 # Used to inform `self` that the operations are over.
100 # Specific streams can use this to free some resources.
102 # Is automatically invoked at the end of `with` structures.
104 # call `close` by default.
108 # A `Stream` that can be read from
109 abstract class Reader
112 # Read a byte directly from the underlying stream, without
113 # considering any eventual buffer
114 protected fun raw_read_byte
: Int is abstract
116 # Read at most `max` bytes from the underlying stream into `buf`,
117 # without considering any eventual buffer
119 # Returns how many bytes were read
120 protected fun raw_read_bytes
(buf
: CString, max
: Int): Int do
122 for i
in [0 .. max
[ do
123 var b
= raw_read_byte
131 # Reads a character. Returns `null` on EOF or timeout
133 # Returns unicode replacement character '�' if an
134 # invalid byte sequence is read.
136 # `read_char` may block if:
138 # * No byte could be read from the current buffer
139 # * An incomplete char is partially read, and more bytes are
140 # required for full decoding.
141 fun read_char
: nullable Char do
142 if eof
then return null
144 var codet_sz
= cod
.codet_size
146 var llen
= lookahead_length
147 if llen
< codet_sz
then
148 llen
+= raw_read_bytes
(lk
.fast_cstring
(llen
), codet_sz
- llen
)
150 if llen
< codet_sz
then
152 return 0xFFFD.code_point
154 var ret
= cod
.is_valid_char
(lk
, codet_sz
)
155 var max_llen
= cod
.max_lookahead
156 while ret
== 1 and llen
< max_llen
do
157 var rd
= raw_read_bytes
(lk
.fast_cstring
(llen
), codet_sz
)
158 if rd
< codet_sz
then
161 lookahead
.lshift
(codet_sz
, llen
, codet_sz
)
163 lookahead_length
= llen
.max
(0)
164 return 0xFFFD.code_point
167 ret
= cod
.is_valid_char
(lk
, llen
)
170 var c
= cod
.decode_char
(lk
)
171 var clen
= c
.u8char_len
174 lookahead
.lshift
(clen
, llen
, clen
)
176 lookahead_length
= llen
179 if ret
== 2 or ret
== 1 then
182 lookahead
.lshift
(codet_sz
, llen
, codet_sz
)
184 lookahead_length
= llen
185 return 0xFFFD.code_point
187 # Should not happen if the decoder works properly
188 var arr
= new Array[Object]
189 arr
.push
"Decoder error: could not decode nor recover from byte sequence ["
190 for i
in [0 .. llen
[ do
195 var err
= new IOError(arr
.plain_to_s
)
196 err
.cause
= last_error
198 return 0xFFFD.code_point
201 # Reads a byte. Returns a negative value on error
202 fun read_byte
: Int do
203 var llen
= lookahead_length
204 if llen
== 0 then return raw_read_byte
210 lk
.lshift
(1, llen
- 1, 1)
211 lookahead_length
-= 1
216 # Reads a String of at most `i` length
217 fun read
(i
: Int): String do
218 var cs
= new CString(i
)
219 var rd
= read_bytes_to_cstring
(cs
, i
)
220 return codec
.decode_string
(cs
, rd
)
223 # Reads up to `max` bytes from source
224 fun read_bytes
(max
: Int): Bytes do
225 var cs
= new CString(max
)
226 var rd
= read_bytes_to_cstring
(cs
, max
)
227 return new Bytes(cs
, rd
, max
)
230 # Reads up to `max` bytes from source and stores them in `bytes`
231 fun read_bytes_to_cstring
(bytes
: CString, max
: Int): Int do
232 var llen
= lookahead_length
233 if llen
== 0 then return raw_read_bytes
(bytes
, max
)
234 var rd
= max
.min
(llen
)
236 lk
.copy_to
(bytes
, rd
, 0, 0)
238 lk
.lshift
(rd
, llen
- rd
, rd
)
239 lookahead_length
-= rd
243 return rd
+ raw_read_bytes
(bytes
.fast_cstring
(rd
), max
- rd
)
246 # Read a string until the end of the line.
248 # The line terminator '\n' and '\r\n', if any, is removed in each line.
251 # var txt = "Hello\n\nWorld\n"
252 # var i = new StringReader(txt)
253 # assert i.read_line == "Hello"
254 # assert i.read_line == ""
255 # assert i.read_line == "World"
259 # Only LINE FEED (`\n`), CARRIAGE RETURN & LINE FEED (`\r\n`), and
260 # the end or file (EOF) is considered to delimit the end of lines.
261 # CARRIAGE RETURN (`\r`) alone is not used for the end of line.
264 # var txt2 = "Hello\r\n\n\rWorld"
265 # var i2 = new StringReader(txt2)
266 # assert i2.read_line == "Hello"
267 # assert i2.read_line == ""
268 # assert i2.read_line == "\rWorld"
272 # NOTE: Use `append_line_to` if the line terminator needs to be preserved.
273 fun read_line
: String
275 if last_error
!= null then return ""
276 if eof
then return ""
277 var s
= new FlatBuffer
282 # Read all the lines until the eof.
284 # The line terminator '\n' and `\r\n` is removed in each line,
287 # var txt = "Hello\n\nWorld\n"
288 # var i = new StringReader(txt)
289 # assert i.read_lines == ["Hello", "", "World"]
292 # This method is more efficient that splitting
293 # the result of `read_all`.
295 # NOTE: SEE `read_line` for details.
296 fun read_lines
: Array[String]
298 var res
= new Array[String]
305 # Return an iterator that read each line.
307 # The line terminator '\n' and `\r\n` is removed in each line,
308 # The line are read with `read_line`. See this method for details.
311 # var txt = "Hello\n\nWorld\n"
312 # var i = new StringReader(txt)
313 # assert i.each_line.to_a == ["Hello", "", "World"]
316 # Unlike `read_lines` that read all lines at the call, `each_line` is lazy.
317 # Therefore, the stream should no be closed until the end of the stream.
320 # i = new StringReader(txt)
321 # var el = i.each_line
323 # assert el.item == "Hello"
325 # assert el.item == ""
330 # assert not el.is_ok
331 # # closed before "world" is read
333 fun each_line
: LineIterator do return new LineIterator(self)
335 # Read all the stream until the eof.
337 # The content of the file is returned as a String.
340 # var txt = "Hello\n\nWorld\n"
341 # var i = new StringReader(txt)
342 # assert i.read_all == txt
344 fun read_all
: String do
345 var s
= read_all_bytes
347 if slen
== 0 then return ""
348 return codec
.decode_string
(s
.items
, s
.length
)
351 # Read all the stream until the eof.
353 # The content of the file is returned verbatim.
354 fun read_all_bytes
: Bytes
356 if last_error
!= null then return new Bytes.empty
357 var s
= new Bytes.empty
358 var buf
= new CString(4096)
360 var rd
= read_bytes_to_cstring
(buf
, 4096)
366 # Read a string until the end of the line and append it to `s`.
368 # Unlike `read_line` and other related methods,
369 # the line terminator '\n', if any, is preserved in each line.
370 # Use the method `Text::chomp` to safely remove it.
373 # var txt = "Hello\n\nWorld\n"
374 # var i = new StringReader(txt)
375 # var b = new FlatBuffer
376 # i.append_line_to(b)
377 # assert b == "Hello\n"
378 # i.append_line_to(b)
379 # assert b == "Hello\n\n"
380 # i.append_line_to(b)
385 # If `\n` is not present at the end of the result, it means that
386 # a non-eol terminated last line was returned.
389 # var i2 = new StringReader("hello")
391 # var b2 = new FlatBuffer
392 # i2.append_line_to(b2)
393 # assert b2 == "hello"
397 # NOTE: The single character LINE FEED (`\n`) delimits the end of lines.
398 # Therefore CARRIAGE RETURN & LINE FEED (`\r\n`) is also recognized.
399 fun append_line_to
(s
: Buffer)
401 if last_error
!= null then return
408 if x
== '\n' then return
413 # Is there something to read.
414 # This function returns 'false' if there is something to read.
416 if lookahead_length
> 0 then return false
417 lookahead_length
= raw_read_bytes
(lookahead
, 1)
418 return lookahead_length
<= 0
421 # Read the next sequence of non whitespace characters.
423 # Leading whitespace characters are skipped.
424 # The first whitespace character that follows the result is consumed.
426 # An empty string is returned if the end of the file or an error is encounter.
429 # var w = new StringReader(" Hello, \n\t World!")
430 # assert w.read_word == "Hello,"
431 # assert w.read_char == '\n'
432 # assert w.read_word == "World!"
433 # assert w.read_word == ""
436 # `Char::is_whitespace` determines what is a whitespace.
437 fun read_word
: String
439 var buf
= new FlatBuffer
440 var c
= read_nonwhitespace
445 if c
== null then break
446 if c
.is_whitespace
then break
454 # Skip whitespace characters (if any) then return the following non-whitespace character.
456 # Returns the code point of the character.
457 # Returns `null` on end of file or error.
459 # In fact, this method works like `read_char` except it skips whitespace.
462 # var w = new StringReader(" \nab\tc")
463 # assert w.read_nonwhitespace == 'a'
464 # assert w.read_nonwhitespace == 'b'
465 # assert w.read_nonwhitespace == 'c'
466 # assert w.read_nonwhitespace == null
469 # `Char::is_whitespace` determines what is a whitespace.
470 fun read_nonwhitespace
: nullable Char
472 var c
: nullable Char = null
475 if c
== null or not c
.is_whitespace
then break
481 # Iterator returned by `Reader::each_line`.
482 # See the aforementioned method for details.
484 super Iterator[String]
486 # The original stream
491 var res
= not stream
.eof
492 if not res
and close_on_finish
then stream
.close
500 line
= stream
.read_line
506 # The last line read (cache)
507 private var line
: nullable String = null
512 if line
== null then item
517 # Close the stream when the stream is at the EOF.
520 var close_on_finish
= false is writable
524 if close_on_finish
then stream
.close
528 # `Reader` capable of declaring if readable without blocking
529 abstract class PollableReader
532 # Is there something to read? (without blocking)
533 fun poll_in
: Bool is abstract
537 # A `Stream` that can be written to
538 abstract class Writer
541 # Write bytes from `s`
542 fun write_bytes
(s
: Bytes) do write_bytes_from_cstring
(s
.items
, s
.length
)
544 # Write `len` bytes from `ns`
545 fun write_bytes_from_cstring
(ns
: CString, len
: Int) is abstract
548 fun write
(s
: Text) is abstract
550 # Write a single byte
551 fun write_byte
(value
: Byte) is abstract
553 # Write a single char
554 fun write_char
(c
: Char) do
555 var ln
= codec
.add_char_to
(c
, write_buffer
)
556 write_bytes_from_cstring
(write_buffer
, ln
)
559 # Can the stream be used to write
560 fun is_writable
: Bool is abstract
563 # Things that can be efficienlty written to a `Writer`
565 # The point of this interface is to allow the instance to be efficiently
566 # written into a `Writer`.
568 # Ready-to-save documents usually provide this interface.
570 # Write itself to a `stream`
571 # The specific logic it let to the concrete subclasses
572 fun write_to
(stream
: Writer) is abstract
574 # Like `write_to` but return a new String (may be quite large)
576 # This funtionality is anectodical, since the point
577 # of streamable object to to be efficienlty written to a
578 # stream without having to allocate and concatenate strings
579 fun write_to_string
: String
581 var stream
= new StringWriter
589 redef fun write_to
(s
) do s
.write_bytes
(self)
591 redef fun write_to_string
do return to_s
596 redef fun write_to
(stream
) do stream
.write
(self)
599 # Input streams with a buffered input for efficiency purposes
600 abstract class BufferedReader
603 redef fun raw_read_byte
605 if last_error
!= null then return -1
607 last_error
= new IOError("Stream has reached eof")
610 var c
= _buffer
[_buffer_pos
]
615 # Resets the internal buffer
621 # Peeks up to `n` bytes in the buffer
623 # The operation does not consume the buffer
626 # var x = new FileReader.open("File.txt")
627 # assert x.peek(5) == x.read(5)
629 fun peek
(i
: Int): Bytes do
630 if eof
then return new Bytes.empty
631 var remsp
= _buffer_length
- _buffer_pos
633 var bf
= new Bytes.with_capacity
(i
)
634 bf
.append_ns_from
(_buffer
, i
, _buffer_pos
)
637 var bf
= new Bytes.with_capacity
(i
)
638 bf
.append_ns_from
(_buffer
, remsp
, _buffer_pos
)
639 _buffer_pos
= _buffer_length
640 read_intern
(i
- bf
.length
, bf
)
641 remsp
= _buffer_length
- _buffer_pos
642 var full_len
= bf
.length
+ remsp
643 if full_len
> _buffer_capacity
then
644 var c
= _buffer_capacity
645 while c
< full_len
do c
= c
* 2 + 2
648 var nns
= new CString(_buffer_capacity
)
649 bf
.items
.copy_to
(nns
, bf
.length
, 0, 0)
650 _buffer
.copy_to
(nns
, remsp
, _buffer_pos
, bf
.length
)
653 _buffer_length
= full_len
657 redef fun read_bytes_to_cstring
(buf
, i
)
659 if last_error
!= null then return 0
660 var bbf
= new Bytes(buf
, 0, i
)
661 return read_intern
(i
, bbf
)
664 # Fills `buf` with at most `i` bytes read from `self`
665 private fun read_intern
(i
: Int, buf
: Bytes): Int do
668 var bufsp
= _buffer_length
- p
671 buf
.append_ns_from
(_buffer
, i
, p
)
674 _buffer_pos
= _buffer_length
675 var readln
= _buffer_length
- p
676 buf
.append_ns_from
(_buffer
, readln
, p
)
677 var rd
= read_intern
(i
- readln
, buf
)
681 redef fun read_all_bytes
683 if last_error
!= null then return new Bytes.empty
684 var s
= new Bytes.with_capacity
(10)
688 var k
= _buffer_length
690 s
.append_ns_from
(b
, rd_sz
, j
)
697 redef fun append_line_to
(s
)
699 var lb
= new Bytes.with_capacity
(10)
701 # First phase: look for a '\n'
703 while i
< _buffer_length
and _buffer
[i
] != 0xAu
8 do
708 if i
< _buffer_length
then
709 assert _buffer
[i
] == 0xAu
8
716 # if there is something to append
717 if i
> _buffer_pos
then
718 # Copy from the buffer to the string
748 if _buffer_pos
< _buffer_length
then return false
749 if end_reached
then return true
751 return _buffer_pos
>= _buffer_length
and end_reached
755 private var buffer
: CString = new CString(0)
757 # The current position in the buffer
758 private var buffer_pos
= 0
760 # Length of the current buffer (i.e. nuber of bytes in the buffer)
761 private var buffer_length
= 0
763 # Capacity of the buffer
764 private var buffer_capacity
= 0
767 protected fun fill_buffer
is abstract
769 # Has the last fill_buffer reached the end
770 protected fun end_reached
: Bool is abstract
772 # Allocate a `_buffer` for a given `capacity`.
773 protected fun prepare_buffer
(capacity
: Int)
775 _buffer
= new CString(capacity
)
776 _buffer_pos
= 0 # need to read
778 _buffer_capacity
= capacity
782 # A `Stream` that can be written to and read from
783 abstract class Duplex
788 # Write to `bytes` in memory
791 # var writer = new BytesWriter
793 # writer.write "Strings "
794 # writer.write_char '&'
795 # writer.write_byte 0x20u8
796 # writer.write_bytes "bytes".to_bytes
798 # assert writer.to_s == "\\x53\\x74\\x72\\x69\\x6E\\x67\\x73\\x20\\x26\\x20\\x62\\x79\\x74\\x65\\x73"
799 # assert writer.bytes.to_s == "Strings & bytes"
802 # As with any binary data, UTF-8 code points encoded on two bytes or more
803 # can be constructed byte by byte.
806 # writer = new BytesWriter
808 # # Write just the character first half
809 # writer.write_byte 0xC2u8
810 # assert writer.to_s == "\\xC2"
811 # assert writer.bytes.to_s == "�"
813 # # Complete the character
814 # writer.write_byte 0xA2u8
815 # assert writer.to_s == "\\xC2\\xA2"
816 # assert writer.bytes.to_s == "¢"
822 var bytes
= new Bytes.empty
824 redef fun to_s
do return bytes
.chexdigest
828 if closed
then return
829 str
.append_to_bytes bytes
832 redef fun write_char
(c
)
834 if closed
then return
838 redef fun write_byte
(value
)
840 if closed
then return
844 redef fun write_bytes_from_cstring
(ns
, len
) do
845 if closed
then return
846 bytes
.append_ns
(ns
, len
)
849 # Is the stream closed?
850 protected var closed
= false
852 redef fun close
do closed
= true
853 redef fun is_writable
do return not closed
856 # `Stream` writing to a `String`
858 # This class has the same behavior as `BytesWriter`
859 # except for `to_s` which decodes `bytes` to a string.
862 # var writer = new StringWriter
864 # writer.write "Strings "
865 # writer.write_char '&'
866 # writer.write_byte 0x20u8
867 # writer.write_bytes "bytes".to_bytes
869 # assert writer.to_s == "Strings & bytes"
874 redef fun to_s
do return bytes
.to_s
877 # Read from `bytes` in memory
880 # var reader = new BytesReader(b"a…b")
881 # assert reader.read_char == 'a'
882 # assert reader.read_byte == 0xE2 # 1st byte of '…'
883 # assert reader.read_byte == 0x80 # 2nd byte of '…'
884 # assert reader.read_char == '�' # Reads the last byte as an invalid char
885 # assert reader.read_all_bytes == b"b"
890 # Source data to read
893 # The current position in `bytes`
894 private var cursor
= 0
896 redef fun raw_read_byte
898 if cursor
>= bytes
.length
then return -1
900 var c
= bytes
[cursor
]
905 redef fun close
do bytes
= new Bytes.empty
907 redef fun read_all_bytes
909 var res
= bytes
.slice_from
(cursor
)
910 cursor
= bytes
.length
914 redef fun raw_read_bytes
(ns
, max
) do
915 if cursor
>= bytes
.length
then return 0
917 var copy
= max
.min
(bytes
.length
- cursor
)
918 bytes
.items
.copy_to
(ns
, copy
, cursor
, 0)
923 redef fun eof
do return cursor
>= bytes
.length
926 # `Stream` reading from a `String` source
928 # This class has the same behavior as `BytesReader`
929 # except for its constructor accepting a `String`.
932 # var reader = new StringReader("a…b")
933 # assert reader.read_char == 'a'
934 # assert reader.read_byte == 0xE2 # 1st byte of '…'
935 # assert reader.read_byte == 0x80 # 2nd byte of '…'
936 # assert reader.read_char == '�' # Reads the last byte as an invalid char
937 # assert reader.read_all == "b"
944 # Source data to read
947 init do bytes
= source
.to_bytes