InputStream.h
/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
InputStream.h
Qore Programming Language
Copyright (C) 2016 - 2018 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_INPUTSTREAM_H
#define _QORE_INPUTSTREAM_H
#include "qore/StreamBase.h"
DLLEXPORT extern QoreClass* QC_INPUTSTREAM;
class InputStream : public StreamBase {
public:
DLLLOCAL BinaryNode *readHelper(int64 limit, ExceptionSink *xsink) {
if (!check(xsink)) {
return nullptr;
}
if (limit <= 0) {
xsink->raiseException("INPUT-STREAM-ERROR", "%s::read() called with non-positive limit " QLLD,
getName(), limit);
return nullptr;
}
SimpleRefHolder<BinaryNode> result(new BinaryNode);
result->preallocate(limit);
int64 count = read(const_cast<void *>(result->getPtr()), limit, xsink);
result->setSize(count);
return count ? result.release() : nullptr;
}
DLLLOCAL QoreValue peekHelper(ExceptionSink *xsink) {
if (!check(xsink)) {
return QoreValue();
}
return peek(xsink);
}
virtual int64 read(void *ptr, int64 limit, ExceptionSink *xsink) = 0;
virtual int64 peek(ExceptionSink *xsink) = 0;
protected:
InputStream() = default;
};
#endif // _QORE_INPUTSTREAM_H
SimpleRefHolder
manages a reference count of a pointer to a class that takes a simple "deref()" call with no argument...
Definition: ReferenceHolder.h:118
BinaryNode::setSize
DLLEXPORT int setSize(qore_size_t size)
sets the buffer size after preallocation
QoreValue
The main value class in Qore, designed to be passed by value.
Definition: QoreValue.h:262
QoreClass
defines a Qore-language class
Definition: QoreClass.h:239
int64
long long int64
64bit integer type, cannot use int64_t here since it breaks the API on some 64-bit systems due to equ...
Definition: common.h:260
InputStream::read
virtual int64 read(void *ptr, int64 limit, ExceptionSink *xsink)=0
Reads up to `limit` bytes from the input stream.
StreamBase
Base class for private data of stream implementations in C++.
Definition: StreamBase.h:44
ExceptionSink::raiseException
DLLEXPORT AbstractQoreNode * raiseException(const char *err, const char *fmt,...)
appends a Qore-language exception to the list
StreamBase::getName
virtual DLLLOCAL const char * getName()=0
Returns the name of the class.
InputStream::peekHelper
DLLLOCAL QoreValue peekHelper(ExceptionSink *xsink)
Helper method that checks that the current thread is the same as when the instance was created,...
Definition: InputStream.h:75
BinaryNode::getPtr
DLLEXPORT const void * getPtr() const
returns the pointer to the data
InputStream
Interface for private data of input streams.
Definition: InputStream.h:44
ExceptionSink
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:46
InputStream::readHelper
DLLLOCAL BinaryNode * readHelper(int64 limit, ExceptionSink *xsink)
Helper method that checks that the current thread is the same as when the instance was created,...
Definition: InputStream.h:53
InputStream::InputStream
InputStream()=default
Constructor.
InputStream::peek
virtual int64 peek(ExceptionSink *xsink)=0
Peeks the next byte from the input stream.
BinaryNode
holds arbitrary binary data
Definition: BinaryNode.h:41
StreamBase::check
DLLLOCAL bool check(ExceptionSink *xsink)
Checks that the current thread is the same as when the instance was created or assigned via unassignT...
Definition: StreamBase.h:53
BinaryNode::preallocate
DLLEXPORT int preallocate(qore_size_t size)
pre-allocates a buffer of a certain size