Qore Programming Language  1.7.0
OutputStream.h
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3  OutputStream.h
4 
5  Qore Programming Language
6 
7  Copyright (C) 2016 - 2022 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_OUTPUTSTREAM_H
33 #define _QORE_OUTPUTSTREAM_H
34 
35 #include "qore/StreamBase.h"
36 
37 DLLEXPORT extern QoreClass* QC_OUTPUTSTREAM;
38 
44 class OutputStream : public StreamBase {
45 public:
54  DLLLOCAL bool check(ExceptionSink *xsink) {
55  if (!StreamBase::check(xsink)) {
56  assert(*xsink);
57  return false;
58  }
59  if (isClosed()) {
60  xsink->raiseException("OUTPUT-STREAM-CLOSED-ERROR", "this %s object has been already closed", getName());
61  return false;
62  }
63  return true;
64  }
65 
71  DLLLOCAL void closeHelper(ExceptionSink *xsink) {
72  if (!check(xsink)) {
73  return;
74  }
75  close(xsink);
76  }
77 
84  DLLLOCAL void writeHelper(const BinaryNode *data, ExceptionSink *xsink) {
85  if (!check(xsink)) {
86  return;
87  }
88  write(data->getPtr(), data->size(), xsink);
89  }
90 
97  DLLLOCAL void writeHelper(const QoreString* data, ExceptionSink *xsink) {
98  if (!check(xsink)) {
99  return;
100  }
101  write(data->c_str(), data->size(), xsink);
102  }
103 
108  virtual bool isClosed() = 0;
109 
114  virtual void close(ExceptionSink* xsink) = 0;
115 
122  virtual void write(const void *ptr, int64 count, ExceptionSink *xsink) = 0;
123 
124 protected:
128  OutputStream() = default;
129 };
130 
131 #endif // _QORE_OUTPUTSTREAM_H
holds arbitrary binary data
Definition: BinaryNode.h:41
DLLEXPORT size_t size() const
returns the number of bytes in the object
DLLEXPORT const void * getPtr() const
returns the pointer to the data
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:48
DLLEXPORT AbstractQoreNode * raiseException(const char *err, const char *fmt,...)
appends a Qore-language exception to the list
Interface for private data of output streams.
Definition: OutputStream.h:44
virtual bool isClosed()=0
Returns true is the stream has been closed.
virtual void write(const void *ptr, int64 count, ExceptionSink *xsink)=0
Writes bytes to the output stream.
DLLLOCAL void closeHelper(ExceptionSink *xsink)
Helper method that checks that the current thread is the same as when the instance was created,...
Definition: OutputStream.h:71
DLLLOCAL void writeHelper(const BinaryNode *data, ExceptionSink *xsink)
Helper method that checks that the current thread is the same as when the instance was created,...
Definition: OutputStream.h:84
OutputStream()=default
Constructor.
virtual void close(ExceptionSink *xsink)=0
Flushes any buffered (unwritten) bytes, closes the output stream and releases resources.
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 a Qore-language class
Definition: QoreClass.h:239
Qore's string type supported by the QoreEncoding class.
Definition: QoreString.h:93
DLLEXPORT size_t size() const
returns number of bytes in the string (not including the null pointer)
DLLEXPORT const char * c_str() const
returns the string's buffer; this data should not be changed
Base class for private data of stream implementations in C++.
Definition: StreamBase.h:44
virtual DLLLOCAL const char * getName()=0
Returns the name of the class.
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
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