OutputStream.h

/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
  OutputStream.h
 
  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.
*/
 
#ifndef _QORE_OUTPUTSTREAM_H
#define _QORE_OUTPUTSTREAM_H
 
#include "qore/StreamBase.h"
 
DLLEXPORT extern QoreClass* QC_OUTPUTSTREAM;
 
class OutputStream : public StreamBase {
public:
    DLLLOCAL bool check(ExceptionSink *xsink) {
        if (!StreamBase::check(xsink)) {
            assert(*xsink);
            return false;
        }
        if (isClosed()) {
            xsink->raiseException("OUTPUT-STREAM-CLOSED-ERROR", "this %s object has been already closed", getName());
            return false;
        }
        return true;
    }
 
    DLLLOCAL void closeHelper(ExceptionSink *xsink) {
        if (!check(xsink)) {
            return;
        }
        close(xsink);
    }
 
    DLLLOCAL void writeHelper(const BinaryNode* data, ExceptionSink* xsink) {
        if (!check(xsink)) {
            return;
        }
        write(data->getPtr(), data->size(), xsink);
    }
 
    DLLLOCAL void writeHelper(const QoreString* data, ExceptionSink *xsink) {
        if (!check(xsink)) {
            return;
        }
        write(data->c_str(), data->size(), xsink);
    }
 
    virtual bool isClosed() = 0;
 
    virtual void close(ExceptionSink* xsink) = 0;
 
    virtual void write(const void *ptr, int64 count, ExceptionSink *xsink) = 0;
 
protected:
    OutputStream() = default;
};
 
#endif // _QORE_OUTPUTSTREAM_H