ligo/src/lib_stdlib/binary_stream.ml
2018-06-30 17:41:32 +02:00

98 lines
4.0 KiB
OCaml

(*****************************************************************************)
(* *)
(* Open Source License *)
(* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. <contact@tezos.com> *)
(* *)
(* Permission is hereby granted, free of charge, to any person obtaining a *)
(* copy of this software and associated documentation files (the "Software"),*)
(* to deal in the Software without restriction, including without limitation *)
(* the rights to use, copy, modify, merge, publish, distribute, sublicense, *)
(* and/or sell copies of the Software, and to permit persons to whom the *)
(* Software is furnished to do so, subject to the following conditions: *)
(* *)
(* The above copyright notice and this permission notice shall be included *)
(* in all copies or substantial portions of the Software. *)
(* *)
(* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*)
(* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *)
(* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL *)
(* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*)
(* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING *)
(* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER *)
(* DEALINGS IN THE SOFTWARE. *)
(* *)
(*****************************************************************************)
(* Facilities to decode streams of binary data *)
type buffer = {
buffer : MBytes.t ;
ofs : int ;
len : int ;
}
type t = {
current : buffer ;
(* buffer queue (classical double list implementation) *)
pending : MBytes.t list ;
pending_rev : MBytes.t list ;
(* number unread bytes in 'current + pending + pending_rev' *)
unread : int ;
}
let is_empty { unread ; _ } = unread = 0
let of_buffer current =
{ current ;
pending = [] ;
pending_rev = [] ;
unread = current.len }
let of_bytes buffer =
let len = MBytes.length buffer in
of_buffer { buffer ; ofs = 0 ; len }
let empty = of_bytes (MBytes.create 0)
let push buffer stream =
{ stream with pending_rev = buffer :: stream.pending_rev ;
unread = stream.unread + MBytes.length buffer }
exception Need_more_data
let split buffer len =
assert (len <= buffer.len) ;
{ buffer with len },
{ buffer with ofs = buffer.ofs + len ; len = buffer.len - len }
let read stream len =
if len > stream.unread then raise Need_more_data ;
if len <= stream.current.len then
let res, current = split stream.current len in
res, { stream with current ; unread = stream.unread - len }
else
let res = { buffer = MBytes.create len ; ofs = 0 ; len } in
MBytes.blit
stream.current.buffer stream.current.ofs
res.buffer 0
stream.current.len ;
let rec loop ofs pending_rev = function
| [] -> loop ofs [] (List.rev pending_rev)
| buffer :: pending ->
let current = { buffer ; ofs = 0 ; len = MBytes.length buffer } in
let to_read = len - ofs in
if to_read <= current.len then begin
MBytes.blit current.buffer 0 res.buffer ofs to_read ;
res,
{ current = { current with ofs = to_read ;
len = current.len - to_read } ;
pending ;
pending_rev ;
unread = stream.unread - len ;
}
end else begin
MBytes.blit current.buffer 0 res.buffer ofs current.len ;
loop (ofs + current.len) pending_rev pending
end in
loop stream.current.len stream.pending_rev stream.pending