Qore Programming Language 1.19.5
Loading...
Searching...
No Matches
InputStream.h
1/* -*- mode: c++; indent-tabs-mode: nil -*- */
2/*
3 InputStream.h
4
5 Qore Programming Language
6
7 Copyright (C) 2016 - 2023 Qore Technologies, s.r.o.
8
9 Permission is hereby granted, free of charge, to any person obtaining a
10 copy of this software and associated documentation files (the "Software"),
11 to deal in the Software without restriction, including without limitation
12 the rights to use, copy, modify, merge, publish, distribute, sublicense,
13 and/or sell copies of the Software, and to permit persons to whom the
14 Software is furnished to do so, subject to the following conditions:
15
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25 DEALINGS IN THE SOFTWARE.
26
27 Note that the Qore library is released under a choice of three open-source
28 licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
29 information.
30*/
31
32#ifndef _QORE_INPUTSTREAM_H
33#define _QORE_INPUTSTREAM_H
34
35#include "qore/StreamBase.h"
36
37DLLEXPORT extern QoreClass* QC_INPUTSTREAM;
38
44class InputStream : public StreamBase {
45public:
53 DLLLOCAL BinaryNode *readHelper(int64 limit, ExceptionSink *xsink) {
54 if (!check(xsink)) {
55 return nullptr;
56 }
57 if (limit <= 0) {
58 xsink->raiseException("INPUT-STREAM-ERROR", "%s::read() called with non-positive limit " QLLD,
59 getName(), limit);
60 return nullptr;
61 }
63 result->preallocate(limit);
64 int64 count = read(const_cast<void *>(result->getPtr()), limit, xsink);
65 result->setSize(count);
66 return count ? result.release() : nullptr;
67 }
68
76 if (!check(xsink)) {
77 return QoreValue();
78 }
79
80 return peek(xsink);
81 }
82
90 virtual int64 read(void *ptr, int64 limit, ExceptionSink *xsink) = 0;
91
97 virtual int64 peek(ExceptionSink *xsink) = 0;
98
99protected:
103 InputStream() = default;
104};
105
106#endif // _QORE_INPUTSTREAM_H
holds arbitrary binary data
Definition: BinaryNode.h:41
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:50
DLLEXPORT AbstractQoreNode * raiseException(const char *err, const char *fmt,...)
appends a Qore-language exception to the list
Interface for private data of input streams.
Definition: InputStream.h:44
virtual int64 peek(ExceptionSink *xsink)=0
Peeks the next byte from the input stream.
InputStream()=default
Constructor.
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
virtual int64 read(void *ptr, int64 limit, ExceptionSink *xsink)=0
Reads up to `limit` bytes from the input stream.
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
defines a Qore-language class
Definition: QoreClass.h:257
manages a reference count of a pointer to a class that takes a simple "deref()" call with no argument...
Definition: ReferenceHolder.h:127
Base class for private data of stream implementations in C++.
Definition: StreamBase.h:48
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:57
virtual DLLLOCAL const char * getName()=0
Returns the name of the class.
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
The main value class in Qore, designed to be passed by value.
Definition: QoreValue.h:279