/* -*- mode: c++; indent-tabs-mode: nil -*- */
/** @file QC_BinaryInputStream.qpp BinaryInputStream class definition */
/*
    Qore Programming Language

    Copyright (C) 2016 - 2023 Qore Technologies, s.r.o.

    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.

    Note that the Qore library is released under a choice of three open-source
    licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
    information.
*/

#include <qore/Qore.h>
#include "qore/intern/BinaryInputStream.h"

//! This class implements the @ref InputStream interface for reading bytes from a @ref binary variable
/** @par Example: BinaryInputStream basic usage
    @code{.py}
    binary src = <2AFF04>;
    BinaryInputStream bis(src);
    *binary b;
    while (b = bis.read(2)) {
        printf("read %d\n", make_hex_string(b));
    }

    read 2AFF
    read 04
    @endcode

    @note stream classes are not designed to be accessed from multiple threads; they have been implemented without
    locking for fast and efficient use when used from a single thread.  For methods that would be unsafe to use in
    another thread, any use of such methods in threads other than the thread where the constructor was called will
    cause a \c STREAM-THREAD-ERROR to be thrown, unless the stream is handed
    off to another thread using the @ref Qore::StreamBase::unassignThread() "StreamBase::unassignThread()"
    method in the thread that currently owns the stream, and the
    @ref Qore::StreamBase::reassignThread() "StreamBase::reassignThread()" method in the new thread.

    @see @ref Qore::StreamReader "StreamReader" for a class that can be used to read various kinds of data from an @ref Qore::InputStream "InputStream"

    @since %Qore 0.8.13
 */
qclass BinaryInputStream [arg=BinaryInputStream* is; ns=Qore; vparent=InputStream; flags=final];

//! Creates the BinaryInputStream based on the \ref binary given
/**
    @param src the \ref binary or string to read bytes from

    @since %Qore 0.9.4 this constructor also accepts strings
 */
BinaryInputStream::constructor(data src) {
   SimpleRefHolder<BinaryInputStream> bis(new BinaryInputStream(src));
   self->setPrivate(CID_BINARYINPUTSTREAM, bis.release());
}

//! Reads bytes (up to a specified limit) from the input stream; returns \ref NOTHING if there are no more bytes in the stream
/**

    @param limit the maximum number of bytes to read
    @return the read bytes (the length is between 1 and `limit` inclusive) or \ref NOTHING if no more bytes are available

    @par Example:
    @code{.py}
    binary src = <2AFF04>;
    BinaryInputStream is(src);
    *binary b;
    while (b = is.read(2)) {
        printf("read %s\n", make_hex_string(b));
    }

    read 2aff
    read 04
    @endcode

    @throw INPUT-STREAM-ERROR \a limit is not positive
    @throw STREAM-THREAD-ERROR this exception is thrown if this method is called from any thread other than the thread that created the object
 */
*binary BinaryInputStream::read(int limit) {
   return is->readHelper(limit, xsink);
}

//! Peeks the next byte available from the input stream; returns -1 if no more data available
/**
    @return the next byte available from the input stream or -1 if no more data is available

    @par Example:
    @code{.py}
    binary src = <2AFF04>;
    BinaryInputStream is(src);
    printf("peek: %d\n", is.peek());
    *binary b = is.read(3);
    printf("peek: %d\n", is.peek());

    peek 42
    peek -1
    @endcode

    @throw STREAM-THREAD-ERROR this exception is thrown if this method is called from any thread other than the thread that created the object
 */
int BinaryInputStream::peek() {
   return is->peekHelper(xsink);
}
