/* -*- mode: c++; indent-tabs-mode: nil -*- */
/** @file QC_StringOutputStream.qpp StringOutputStream 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/StringOutputStream.h"

//! This class implements the @ref OutputStream interface for writing bytes to a @ref string buffer
/** @par Example: StringOutputStream basic usage
    @code{.py}
    StringOutputStream sos();
    sos.write(<41>);
    sos.write(<42>);
    sos.write(<43>);
    sos.getData();      # returns "ABC"
    @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::StreamWriter "StreamWriter" for a class that can be used to write various kinds of data to an
    @ref Qore::OutputStream "OutputStream"

    @since %Qore 0.8.13
 */
qclass StringOutputStream [arg=StringOutputStream* os; ns=Qore; vparent=OutputStream; flags=final];

//! Creates the StringOutputStream
/** This variant assumes the @ref default_encoding for the string

    @note raw binary data is written to the output stream, so it's up to the caller to ensure that only valid
    character data for the given encoding is written to the @ref StringOutputStream object, otherwise a string with
    invalid character data will be returned by getData()
 */
StringOutputStream::constructor() {
    SimpleRefHolder<StringOutputStream> sos(new StringOutputStream);
    self->setPrivate(CID_STRINGOUTPUTSTREAM, sos.release());
}

//! Creates the StringOutputStream
/** @param encoding the encoding to tag the string data with

    @note raw binary data is written to the output stream, so it's up to the caller to ensure that only valid
    character data for the given encoding is written to the @ref StringOutputStream object, otherwise a string with
    invalid character data will be returned by getData()
 */
StringOutputStream::constructor(string encoding) {
   SimpleRefHolder<StringOutputStream> sos(new StringOutputStream(QEM.findCreate(encoding)));
   self->setPrivate(CID_STRINGOUTPUTSTREAM, sos.release());
}

//! Closes the output stream and releases any resources.
/** Any methods called on a closed output stream will throw an exception.

    @throw OUTPUT-STREAM-CLOSED-ERROR the output stream has already been closed
    @throw STREAM-THREAD-ERROR this exception is thrown if this method is called from any thread other than the thread
    that created the object
 */
nothing StringOutputStream::close() {
    os->closeHelper(xsink);
}

//! Writes bytes to the output stream
/**
    @param data the data to write

    @par Example:
    @code{.py}
    StringOutputStream sos();
    sos.write(<41>);
    sos.write(<42>);
    sos.write(<43>);
    sos.getData();      # returns "ABC"
    @endcode

    @throw OUTPUT-STREAM-CLOSED-ERROR the output stream has already been closed
    @throw STREAM-THREAD-ERROR this exception is thrown if this method is called from any thread other than the thread
    that created the object
 */
nothing StringOutputStream::write(binary data) {
    os->writeHelper(data, xsink);
}

//! Returns the data written to the stream, clearing the internal buffer
/**
    @return the data written to the @ref StringOutputStream

    @par Example:
    @code{.py}
    StringOutputStream sos();
    sos.write(<41>);
    sos.write(<42>);
    sos.write(<43>);
    sos.getData();      # returns "ABC"
    @endcode

    @throw OUTPUT-STREAM-CLOSED-ERROR the output stream has already been closed
    @throw STREAM-THREAD-ERROR this exception is thrown if this method is called from any thread other than the thread
    that created the object
 */
string StringOutputStream::getData() {
    return os->getData(xsink);
}

//! Returns @ref True if the stream already has data
/** @return @ref True if the stream already has data

    @par Example:
    @code{.py}
bool has_data = sos.hasData();
    @endcode

    @throw OUTPUT-STREAM-CLOSED-ERROR the output stream has already been closed
    @throw STREAM-THREAD-ERROR this exception is thrown if this method is called from any thread other than the thread
    that created the object

    @since %Qore 1.1
*/
bool StringOutputStream::hasData() [flags=RET_VALUE_ONLY] {
    return os->hasData(xsink);
}

//! Returns the @ref character_encoding "character encoding" for the @ref StringOutputStream
/** @par Example:
    @code{.py}
StringOutputStream sos("latin1");
string encoding = sos.getEncoding();
    @endcode

    @return the @ref character_encoding "character encoding" for the @ref StringOutputStream

    @note raw binary data is written to the output stream, so it's up to the caller to ensure that only valid
    character data for the given encoding is written to the @ref StringOutputStream object, otherwise a string with
    invalid character data will be returned by getData()
 */
string StringOutputStream::getEncoding() [flags=CONSTANT] {
    return new QoreStringNode(os->getEncoding());
}
