| Qore Programming Language - C/C++ Library 1.0.8

Transform.h
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3 Transform.h
4
5 Qore Programming Language
6
7 Copyright (C) 2016 - 2017 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_TRANSFORM_H
33 #define _QORE_TRANSFORM_H
34
35 #include "qore/AbstractPrivateData.h"
36
40 class Transform : public AbstractPrivateData {
41 public:
51 virtual std::pair<int64, int64> apply(const void *src, int64 srcLen, void *dst, int64 dstLen,
52 ExceptionSink *xsink) = 0;
53
55 DLLLOCAL virtual size_t outputBufferSize();
56
58 DLLLOCAL virtual size_t inputBufferSize();
59
60 protected:
64 Transform() = default;
65
66 private:
67 Transform(const Transform &) = delete;
68 Transform(Transform &&) = delete;
69 Transform &operator=(const Transform &) = delete;
70 Transform &operator=(Transform &&) = delete;
71 };
72
73 #endif // _QORE_TRANSFORM_H
AbstractPrivateData
the base class for all data to be used as private data of Qore objects
Definition: AbstractPrivateData.h:44
Transform::inputBufferSize
virtual DLLLOCAL size_t inputBufferSize()
returns the default input buffer size for the object
Transform::apply
virtual std::pair< int64, int64 > apply(const void *src, int64 srcLen, void *dst, int64 dstLen, ExceptionSink *xsink)=0
Applies the transformation.
Transform
Interface for private data of transformations.
Definition: Transform.h:40
Transform::outputBufferSize
virtual DLLLOCAL size_t outputBufferSize()
returns the default output buffer size for the object
Transform::Transform
Transform()=default
Constructor.
ExceptionSink
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:48
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