Internal refactoring (#69)

Author: bicycle1885

src/buffer.jl

@@ -23,8 +23,8 @@ mutable struct Buffer
     bufferpos::Int
     marginpos::Int
 
-    # the number of total bytes passed through this buffer
-    total::Int64
+    # the total number of transcoded bytes
+    transcoded::Int64
 
     function Buffer(size::Integer)
         return new(Vector{UInt8}(undef, size), 0, 1, 1, 0)
@@ -92,34 +92,27 @@ function reset!(buf::Buffer)
 end
 
 # Notify that `n` bytes are consumed from `buf`.
-function consumed!(buf::Buffer, n::Integer)
+function consumed!(buf::Buffer, n::Integer; transcode::Bool = false)
     buf.bufferpos += n
+    if transcode
+        buf.transcoded += n
+    end
     return buf
 end
 
 # Notify that `n` bytes are supplied to `buf`.
-function supplied!(buf::Buffer, n::Integer)
+function supplied!(buf::Buffer, n::Integer; transcode::Bool = false)
     buf.marginpos += n
-    return buf
-end
-
-function consumed2!(buf::Buffer, n::Integer)
-    buf.bufferpos += n
-    buf.total += n
-    return buf
-end
-
-function supplied2!(buf::Buffer, n::Integer)
-    buf.marginpos += n
-    buf.total += n
+    if transcode
+        buf.transcoded += n
+    end
     return buf
 end
 
 # Discard buffered data and initialize positions.
 function initbuffer!(buf::Buffer)
-    buf.markpos = 0
+    buf.markpos = buf.transcoded = 0
     buf.bufferpos = buf.marginpos = 1
-    buf.total = 0
     return buf
 end
 

src/noop.jl

@@ -130,13 +130,13 @@ function stats(stream::NoopStream)
     if mode == :idle
         consumed = supplied = 0
     elseif mode == :read
-        supplied = buffer.total
+        supplied = buffer.transcoded
         consumed = supplied - buffersize(buffer)
     elseif mode == :write
-        supplied = buffer.total + buffersize(buffer)
-        consumed = buffer.total
+        supplied = buffer.transcoded + buffersize(buffer)
+        consumed = buffer.transcoded
     else
-        assert(false)
+        @assert false "unreachable"
     end
     return Stats(consumed, supplied, supplied, supplied)
 end
@@ -161,7 +161,7 @@ function fillbuffer(stream::NoopStream)
         makemargin!(buffer, 1)
         nfilled += readdata!(stream.stream, buffer)
     end
-    buffer.total += nfilled
+    buffer.transcoded += nfilled
     return nfilled
 end
 
@@ -178,11 +178,11 @@ function flushbuffer(stream::NoopStream, all::Bool=false)
         nflushed += writedata!(stream.stream, buffer)
         makemargin!(buffer, 0)
     end
-    buffer.total += nflushed
+    buffer.transcoded += nflushed
     return nflushed
 end
 
 function flushuntilend(stream::NoopStream)
-    stream.state.buffer1.total += writedata!(stream.stream, stream.state.buffer1)
+    stream.state.buffer1.transcoded += writedata!(stream.stream, stream.state.buffer1)
     return
 end

src/stream.jl

@@ -20,7 +20,8 @@ struct TranscodingStream{C<:Codec,S<:IO} <: IO
     # mutable state of the stream
     state::State
 
-    function TranscodingStream{C,S}(codec::C, stream::S, state::State, initialized::Bool) where {C<:Codec,S<:IO}
+    function TranscodingStream{C,S}(
+            codec::C, stream::S, state::State, initialized::Bool) where {C<:Codec,S<:IO}
         if !isopen(stream)
             throw(ArgumentError("closed stream"))
         elseif state.mode != :idle
@@ -140,8 +141,9 @@ end
 # Check that mode is valid.
 macro checkmode(validmodes)
     mode = esc(:mode)
+    validmodes = [arg.value for arg in validmodes.args]
     quote
-        if !$(foldr((x, y) -> :($(mode) == $(QuoteNode(x)) || $(y)), eval(validmodes), init=false))
+        if !$(foldr((x, y) -> :($(mode) === $(QuoteNode(x)) || $(y)), validmodes, init=false))
             throw(ArgumentError(string("invalid mode :", $(mode))))
         end
     end
@@ -554,13 +556,13 @@ function stats(stream::TranscodingStream)
     if mode == :idle
         transcoded_in = transcoded_out = in = out = 0
     elseif mode == :read
-        transcoded_in = buffer2.total
-        transcoded_out = buffer1.total
+        transcoded_in = buffer2.transcoded
+        transcoded_out = buffer1.transcoded
         in = transcoded_in + buffersize(buffer2)
         out = transcoded_out - buffersize(buffer1)
     elseif mode == :write
-        transcoded_in = buffer1.total
-        transcoded_out = buffer2.total
+        transcoded_in = buffer1.transcoded
+        transcoded_out = buffer2.transcoded
         in = transcoded_in + buffersize(buffer1)
         out = transcoded_out - buffersize(buffer2)
     else
@@ -648,8 +650,8 @@ function callprocess(stream::TranscodingStream, inbuf::Buffer, outbuf::Buffer)
     input = buffermem(inbuf)
     makemargin!(outbuf, minoutsize(stream.codec, input))
     Δin, Δout, state.code = process(stream.codec, input, marginmem(outbuf), state.error)
-    consumed2!(inbuf, Δin)
-    supplied2!(outbuf, Δout)
+    consumed!(inbuf, Δin, transcode = true)
+    supplied!(outbuf, Δout, transcode = true)
     if state.code == :error
         changemode!(stream, :panic)
     elseif state.code == :ok && Δin == Δout == 0