Qore Programming Language 1.19.2
Loading...
Searching...
No Matches
StringOutputStream.h
1/* -*- mode: c++; indent-tabs-mode: nil -*- */
2/*
3 StringOutputStream.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 strings (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_STRINGOUTPUTSTREAM_H
33#define _QORE_STRINGOUTPUTSTREAM_H
34
35#include <stdint.h>
36#include "qore/OutputStream.h"
37
42
43public:
45 }
46
47 DLLLOCAL StringOutputStream(const QoreEncoding* e) : enc(e), buf(new QoreStringNode) {
48 }
49
50 DLLLOCAL const char* getName() override {
51 return "StringOutputStream";
52 }
53
54 DLLLOCAL bool isClosed() override {
55 return !buf;
56 }
57
58 DLLLOCAL void close(ExceptionSink* xsink) override {
59 assert(!isClosed());
60 buf = 0;
61 }
62
63 DLLLOCAL void write(const void* ptr, int64 count, ExceptionSink* xsink) override {
64 assert(!isClosed());
65 assert(count >= 0);
66 buf->concat((const char*)ptr, count);
67 }
68
69 DLLLOCAL const QoreEncoding* getEncoding() const {
70 return enc;
71 }
72
73 DLLLOCAL bool hasData(ExceptionSink* xsink) {
74 if (!check(xsink)) {
75 return 0;
76 }
77 return buf && !buf->empty();
78 }
79
80 DLLLOCAL QoreStringNode* getData(ExceptionSink* xsink) {
81 if (!check(xsink)) {
82 return 0;
83 }
84 assert(!isClosed());
85 QoreStringNode *ret = buf.release();
86 buf = new QoreStringNode(enc);
87 return ret;
88 }
89
90private:
91 const QoreEncoding* enc;
93};
94
95#endif // _QORE_STRINGOUTPUTSTREAM_H
DLLEXPORT const QoreEncoding * QCS_DEFAULT
the default encoding for the Qore library
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:50
Interface for private data of output streams.
Definition: OutputStream.h:44
DLLLOCAL bool check(ExceptionSink *xsink)
Checks that the current thread is the same as when the instance was created or assigned via unassignT...
Definition: OutputStream.h:54
defines string encoding functions in Qore
Definition: QoreEncoding.h:83
DLLEXPORT void concat(const QoreString *str, ExceptionSink *xsink)
concatenates a string and converts encodings if necessary
DLLEXPORT bool empty() const
returns true if the string is empty, false if not
Qore's string value type, reference counted, dynamically-allocated only.
Definition: QoreStringNode.h:50
manages a reference count of a pointer to a class that takes a simple "deref()" call with no argument...
Definition: ReferenceHolder.h:127
Private data for the Qore::StringOutputStream class.
Definition: StringOutputStream.h:41
DLLLOCAL void write(const void *ptr, int64 count, ExceptionSink *xsink) override
Writes bytes to the output stream.
Definition: StringOutputStream.h:63
DLLLOCAL void close(ExceptionSink *xsink) override
Flushes any buffered (unwritten) bytes, closes the output stream and releases resources.
Definition: StringOutputStream.h:58
DLLLOCAL bool isClosed() override
Returns true is the stream has been closed.
Definition: StringOutputStream.h:54
DLLLOCAL const char * getName() override
Returns the name of the class.
Definition: StringOutputStream.h:50
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