415 lines
13 KiB
Julia
415 lines
13 KiB
Julia
# This file is a part of Julia. License is MIT: https://julialang.org/license
|
|
|
|
## work with AbstractVector{UInt8} via I/O primitives ##
|
|
|
|
# Stateful string
|
|
mutable struct AbstractIOBuffer{T<:AbstractVector{UInt8}} <: IO
|
|
data::T # T should support: getindex, setindex!, length, copy!, and resize!
|
|
readable::Bool
|
|
writable::Bool
|
|
seekable::Bool # if not seekable, implementation is free to destroy (compact) past read data
|
|
append::Bool # add data at end instead of at pointer
|
|
size::Int # end pointer (and write pointer if append == true)
|
|
maxsize::Int # fixed array size (typically pre-allocated)
|
|
ptr::Int # read (and maybe write) pointer
|
|
mark::Int # reset mark location for ptr (or <0 for no mark)
|
|
|
|
function AbstractIOBuffer{T}(data::T, readable::Bool, writable::Bool, seekable::Bool, append::Bool,
|
|
maxsize::Int) where T<:AbstractVector{UInt8}
|
|
new(data,readable,writable,seekable,append,length(data),maxsize,1,-1)
|
|
end
|
|
end
|
|
const IOBuffer = AbstractIOBuffer{Vector{UInt8}}
|
|
|
|
function AbstractIOBuffer(data::T, readable::Bool, writable::Bool, seekable::Bool, append::Bool,
|
|
maxsize::Int) where T<:AbstractVector{UInt8}
|
|
AbstractIOBuffer{T}(data, readable, writable, seekable, append, maxsize)
|
|
end
|
|
|
|
# allocate Vector{UInt8}s for IOBuffer storage that can efficiently become Strings
|
|
StringVector(n::Integer) = Vector{UInt8}(_string_n(n))
|
|
|
|
# IOBuffers behave like Files. They are typically readable and writable. They are seekable. (They can be appendable).
|
|
|
|
"""
|
|
IOBuffer([data,],[readable::Bool=true, writable::Bool=true, [maxsize::Int=typemax(Int)]])
|
|
|
|
Create an `IOBuffer`, which may optionally operate on a pre-existing array. If the
|
|
readable/writable arguments are given, they restrict whether or not the buffer may be read
|
|
from or written to respectively. The last argument optionally specifies a size beyond which
|
|
the buffer may not be grown.
|
|
"""
|
|
IOBuffer(data::AbstractVector{UInt8}, readable::Bool=true, writable::Bool=false, maxsize::Int=typemax(Int)) =
|
|
AbstractIOBuffer(data, readable, writable, true, false, maxsize)
|
|
function IOBuffer(readable::Bool, writable::Bool)
|
|
b = IOBuffer(StringVector(32), readable, writable)
|
|
b.data[:] = 0
|
|
b.size = 0
|
|
return b
|
|
end
|
|
|
|
"""
|
|
IOBuffer() -> IOBuffer
|
|
|
|
Create an in-memory I/O stream.
|
|
"""
|
|
IOBuffer() = IOBuffer(true, true)
|
|
|
|
"""
|
|
IOBuffer(size::Int)
|
|
|
|
Create a fixed size IOBuffer. The buffer will not grow dynamically.
|
|
"""
|
|
IOBuffer(maxsize::Int) = (x=IOBuffer(StringVector(maxsize), true, true, maxsize); x.size=0; x)
|
|
|
|
# PipeBuffers behave like Unix Pipes. They are typically readable and writable, they act appendable, and are not seekable.
|
|
|
|
"""
|
|
PipeBuffer(data::Vector{UInt8}=UInt8[],[maxsize::Int=typemax(Int)])
|
|
|
|
An [`IOBuffer`](@ref) that allows reading and performs writes by appending.
|
|
Seeking and truncating are not supported.
|
|
See [`IOBuffer`](@ref) for the available constructors.
|
|
If `data` is given, creates a `PipeBuffer` to operate on a data vector,
|
|
optionally specifying a size beyond which the underlying `Array` may not be grown.
|
|
"""
|
|
PipeBuffer(data::Vector{UInt8}=UInt8[], maxsize::Int=typemax(Int)) =
|
|
AbstractIOBuffer(data,true,true,false,true,maxsize)
|
|
PipeBuffer(maxsize::Int) = (x = PipeBuffer(StringVector(maxsize),maxsize); x.size=0; x)
|
|
|
|
function copy(b::AbstractIOBuffer)
|
|
ret = typeof(b)(b.writable ? copy(b.data) : b.data,
|
|
b.readable, b.writable, b.seekable, b.append, b.maxsize)
|
|
ret.size = b.size
|
|
ret.ptr = b.ptr
|
|
return ret
|
|
end
|
|
|
|
show(io::IO, b::AbstractIOBuffer) = print(io, "IOBuffer(data=UInt8[...], ",
|
|
"readable=", b.readable, ", ",
|
|
"writable=", b.writable, ", ",
|
|
"seekable=", b.seekable, ", ",
|
|
"append=", b.append, ", ",
|
|
"size=", b.size, ", ",
|
|
"maxsize=", b.maxsize == typemax(Int) ? "Inf" : b.maxsize, ", ",
|
|
"ptr=", b.ptr, ", ",
|
|
"mark=", b.mark, ")")
|
|
|
|
function unsafe_read(from::AbstractIOBuffer, p::Ptr{UInt8}, nb::UInt)
|
|
from.readable || throw(ArgumentError("read failed, IOBuffer is not readable"))
|
|
avail = nb_available(from)
|
|
adv = min(avail, nb)
|
|
unsafe_copy!(p, pointer(from.data, from.ptr), adv)
|
|
from.ptr += adv
|
|
if nb > avail
|
|
throw(EOFError())
|
|
end
|
|
nothing
|
|
end
|
|
|
|
function read_sub(from::AbstractIOBuffer, a::AbstractArray{T}, offs, nel) where T
|
|
from.readable || throw(ArgumentError("read failed, IOBuffer is not readable"))
|
|
if offs+nel-1 > length(a) || offs < 1 || nel < 0
|
|
throw(BoundsError())
|
|
end
|
|
if isbits(T) && isa(a,Array)
|
|
nb = UInt(nel * sizeof(T))
|
|
unsafe_read(from, pointer(a, offs), nb)
|
|
else
|
|
for i = offs:offs+nel-1
|
|
a[i] = read(to, T)
|
|
end
|
|
end
|
|
return a
|
|
end
|
|
|
|
@inline function read(from::AbstractIOBuffer, ::Type{UInt8})
|
|
from.readable || throw(ArgumentError("read failed, IOBuffer is not readable"))
|
|
ptr = from.ptr
|
|
size = from.size
|
|
if ptr > size
|
|
throw(EOFError())
|
|
end
|
|
@inbounds byte = from.data[ptr]
|
|
from.ptr = ptr + 1
|
|
return byte
|
|
end
|
|
|
|
function peek(from::AbstractIOBuffer)
|
|
from.readable || throw(ArgumentError("read failed, IOBuffer is not readable"))
|
|
if from.ptr > from.size
|
|
throw(EOFError())
|
|
end
|
|
return from.data[from.ptr]
|
|
end
|
|
|
|
read(from::AbstractIOBuffer, ::Type{Ptr{T}}) where {T} = convert(Ptr{T}, read(from, UInt))
|
|
|
|
isreadable(io::AbstractIOBuffer) = io.readable
|
|
iswritable(io::AbstractIOBuffer) = io.writable
|
|
|
|
# TODO: AbstractIOBuffer is not iterable, so doesn't really have a length.
|
|
# This should maybe be sizeof() instead.
|
|
#length(io::AbstractIOBuffer) = (io.seekable ? io.size : nb_available(io))
|
|
nb_available(io::AbstractIOBuffer) = io.size - io.ptr + 1
|
|
position(io::AbstractIOBuffer) = io.ptr-1
|
|
|
|
function skip(io::AbstractIOBuffer, n::Integer)
|
|
seekto = io.ptr + n
|
|
n < 0 && return seek(io, seekto-1) # Does error checking
|
|
io.ptr = min(seekto, io.size+1)
|
|
return io
|
|
end
|
|
|
|
function seek(io::AbstractIOBuffer, n::Integer)
|
|
if !io.seekable
|
|
ismarked(io) || throw(ArgumentError("seek failed, IOBuffer is not seekable and is not marked"))
|
|
n == io.mark || throw(ArgumentError("seek failed, IOBuffer is not seekable and n != mark"))
|
|
end
|
|
# TODO: REPL.jl relies on the fact that this does not throw (by seeking past the beginning or end
|
|
# of an AbstractIOBuffer), so that would need to be fixed in order to throw an error here
|
|
#(n < 0 || n > io.size) && throw(ArgumentError("Attempted to seek outside IOBuffer boundaries."))
|
|
#io.ptr = n+1
|
|
io.ptr = max(min(n+1, io.size+1), 1)
|
|
return io
|
|
end
|
|
|
|
function seekend(io::AbstractIOBuffer)
|
|
io.ptr = io.size+1
|
|
return io
|
|
end
|
|
|
|
function truncate(io::AbstractIOBuffer, n::Integer)
|
|
io.writable || throw(ArgumentError("truncate failed, IOBuffer is not writeable"))
|
|
io.seekable || throw(ArgumentError("truncate failed, IOBuffer is not seekable"))
|
|
n < 0 && throw(ArgumentError("truncate failed, n bytes must be ≥ 0, got $n"))
|
|
n > io.maxsize && throw(ArgumentError("truncate failed, $(n) bytes is exceeds IOBuffer maxsize $(io.maxsize)"))
|
|
if n > length(io.data)
|
|
resize!(io.data, n)
|
|
end
|
|
io.data[io.size+1:n] = 0
|
|
io.size = n
|
|
io.ptr = min(io.ptr, n+1)
|
|
ismarked(io) && io.mark > n && unmark(io)
|
|
return io
|
|
end
|
|
|
|
function compact(io::AbstractIOBuffer)
|
|
io.writable || throw(ArgumentError("compact failed, IOBuffer is not writeable"))
|
|
io.seekable && throw(ArgumentError("compact failed, IOBuffer is seekable"))
|
|
local ptr::Int, bytes_to_move::Int
|
|
if ismarked(io) && io.mark < io.ptr
|
|
if io.mark == 0 return end
|
|
ptr = io.mark
|
|
bytes_to_move = nb_available(io) + (io.ptr-io.mark)
|
|
else
|
|
ptr = io.ptr
|
|
bytes_to_move = nb_available(io)
|
|
end
|
|
copy!(io.data, 1, io.data, ptr, bytes_to_move)
|
|
io.size -= ptr - 1
|
|
io.ptr -= ptr - 1
|
|
io.mark -= ptr - 1
|
|
return io
|
|
end
|
|
|
|
@inline ensureroom(io::AbstractIOBuffer, nshort::Int) = ensureroom(io, UInt(nshort))
|
|
@inline function ensureroom(io::AbstractIOBuffer, nshort::UInt)
|
|
io.writable || throw(ArgumentError("ensureroom failed, IOBuffer is not writeable"))
|
|
if !io.seekable
|
|
nshort >= 0 || throw(ArgumentError("ensureroom failed, requested number of bytes must be ≥ 0, got $nshort"))
|
|
if !ismarked(io) && io.ptr > 1 && io.size <= io.ptr - 1
|
|
io.ptr = 1
|
|
io.size = 0
|
|
else
|
|
datastart = ismarked(io) ? io.mark : io.ptr
|
|
if (io.size+nshort > io.maxsize) ||
|
|
(datastart > 4096 && datastart > io.size - io.ptr) ||
|
|
(datastart > 262144)
|
|
# apply somewhat arbitrary heuristics to decide when to destroy
|
|
# old, read data to make more room for new data
|
|
compact(io)
|
|
end
|
|
end
|
|
end
|
|
n = min(nshort + (io.append ? io.size : io.ptr-1), io.maxsize)
|
|
if n > length(io.data)
|
|
resize!(io.data, n)
|
|
end
|
|
return io
|
|
end
|
|
|
|
eof(io::AbstractIOBuffer) = (io.ptr-1 == io.size)
|
|
|
|
@noinline function close(io::AbstractIOBuffer{T}) where T
|
|
io.readable = false
|
|
io.writable = false
|
|
io.seekable = false
|
|
io.size = 0
|
|
io.maxsize = 0
|
|
io.ptr = 1
|
|
io.mark = -1
|
|
if io.writable
|
|
resize!(io.data, 0)
|
|
end
|
|
nothing
|
|
end
|
|
|
|
isopen(io::AbstractIOBuffer) = io.readable || io.writable || io.seekable || nb_available(io) > 0
|
|
|
|
function String(io::AbstractIOBuffer)
|
|
io.readable || throw(ArgumentError("IOBuffer is not readable"))
|
|
io.seekable || throw(ArgumentError("IOBuffer is not seekable"))
|
|
return unsafe_string(pointer(io.data), io.size)
|
|
end
|
|
|
|
"""
|
|
take!(b::IOBuffer)
|
|
|
|
Obtain the contents of an `IOBuffer` as an array, without copying. Afterwards, the
|
|
`IOBuffer` is reset to its initial state.
|
|
"""
|
|
function take!(io::AbstractIOBuffer)
|
|
ismarked(io) && unmark(io)
|
|
if io.seekable
|
|
nbytes = io.size
|
|
data = copy!(StringVector(nbytes), 1, io.data, 1, nbytes)
|
|
else
|
|
nbytes = nb_available(io)
|
|
data = read!(io,StringVector(nbytes))
|
|
end
|
|
if io.writable
|
|
io.ptr = 1
|
|
io.size = 0
|
|
end
|
|
return data
|
|
end
|
|
function take!(io::IOBuffer)
|
|
ismarked(io) && unmark(io)
|
|
if io.seekable
|
|
data = io.data
|
|
if io.writable
|
|
maxsize = (io.maxsize == typemax(Int) ? 0 : min(length(io.data),io.maxsize))
|
|
io.data = StringVector(maxsize)
|
|
else
|
|
data = copy(data)
|
|
end
|
|
resize!(data,io.size)
|
|
else
|
|
nbytes = nb_available(io)
|
|
a = StringVector(nbytes)
|
|
data = read!(io, a)
|
|
end
|
|
if io.writable
|
|
io.ptr = 1
|
|
io.size = 0
|
|
end
|
|
return data
|
|
end
|
|
|
|
function write(to::AbstractIOBuffer, from::AbstractIOBuffer)
|
|
if to === from
|
|
from.ptr = from.size + 1
|
|
return 0
|
|
end
|
|
written::Int = write_sub(to, from.data, from.ptr, nb_available(from))
|
|
from.ptr += written
|
|
return written
|
|
end
|
|
|
|
function unsafe_write(to::AbstractIOBuffer, p::Ptr{UInt8}, nb::UInt)
|
|
ensureroom(to, nb)
|
|
ptr = (to.append ? to.size+1 : to.ptr)
|
|
written = Int(min(nb, length(to.data) - ptr + 1))
|
|
towrite = written
|
|
d = to.data
|
|
while towrite > 0
|
|
@inbounds d[ptr] = unsafe_load(p)
|
|
ptr += 1
|
|
p += 1
|
|
towrite -= 1
|
|
end
|
|
to.size = max(to.size, ptr - 1)
|
|
if !to.append
|
|
to.ptr += written
|
|
end
|
|
return written
|
|
end
|
|
|
|
function write_sub(to::AbstractIOBuffer, a::AbstractArray{UInt8}, offs, nel)
|
|
if offs+nel-1 > length(a) || offs < 1 || nel < 0
|
|
throw(BoundsError())
|
|
end
|
|
unsafe_write(to, pointer(a, offs), UInt(nel))
|
|
end
|
|
|
|
@inline function write(to::AbstractIOBuffer, a::UInt8)
|
|
ensureroom(to, UInt(1))
|
|
ptr = (to.append ? to.size+1 : to.ptr)
|
|
if ptr > to.maxsize
|
|
return 0
|
|
else
|
|
to.data[ptr] = a
|
|
end
|
|
to.size = max(to.size, ptr)
|
|
if !to.append
|
|
to.ptr += 1
|
|
end
|
|
return sizeof(UInt8)
|
|
end
|
|
|
|
readbytes!(io::AbstractIOBuffer, b::Array{UInt8}, nb=length(b)) = readbytes!(io, b, Int(nb))
|
|
function readbytes!(io::AbstractIOBuffer, b::Array{UInt8}, nb::Int)
|
|
nr = min(nb, nb_available(io))
|
|
if length(b) < nr
|
|
resize!(b, nr)
|
|
end
|
|
read_sub(io, b, 1, nr)
|
|
return nr
|
|
end
|
|
read(io::AbstractIOBuffer) = read!(io,StringVector(nb_available(io)))
|
|
readavailable(io::AbstractIOBuffer) = read(io)
|
|
read(io::AbstractIOBuffer, nb::Integer) = read!(io,StringVector(min(nb, nb_available(io))))
|
|
|
|
function search(buf::IOBuffer, delim::UInt8)
|
|
p = pointer(buf.data, buf.ptr)
|
|
q = ccall(:memchr,Ptr{UInt8},(Ptr{UInt8},Int32,Csize_t),p,delim,nb_available(buf))
|
|
nb::Int = (q == C_NULL ? 0 : q-p+1)
|
|
return nb
|
|
end
|
|
|
|
function search(buf::AbstractIOBuffer, delim::UInt8)
|
|
data = buf.data
|
|
for i = buf.ptr : buf.size
|
|
@inbounds b = data[i]
|
|
if b == delim
|
|
return i - buf.ptr + 1
|
|
end
|
|
end
|
|
return 0
|
|
end
|
|
|
|
function readuntil(io::AbstractIOBuffer, delim::UInt8)
|
|
lb = 70
|
|
A = StringVector(lb)
|
|
n = 0
|
|
data = io.data
|
|
for i = io.ptr : io.size
|
|
n += 1
|
|
if n > lb
|
|
lb = n*2
|
|
resize!(A, lb)
|
|
end
|
|
@inbounds b = data[i]
|
|
@inbounds A[n] = b
|
|
if b == delim
|
|
break
|
|
end
|
|
end
|
|
io.ptr += n
|
|
if lb != n
|
|
resize!(A, n)
|
|
end
|
|
A
|
|
end
|