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

ReferenceArgumentHelper.h
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3 ReferenceArgumentHelper.h
4
5 Qore Programming Language
6
7 Copyright (C) 2003 - 2018 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_REFERENCEARGUMENTHELPER_H
33
34 #define _QORE_REFERENCEARGUMENTHELPER_H
35
37
58 class ReferenceArgumentHelper {
59 private:
60 struct lvih_intern *priv;
61
63 DLLLOCAL ReferenceArgumentHelper(const ReferenceArgumentHelper&);
64
66 DLLLOCAL ReferenceArgumentHelper& operator=(const ReferenceArgumentHelper&);
67
68 public:
70
83 DLLEXPORT ReferenceArgumentHelper(QoreValue val, ExceptionSink* xsink);
84
86
100 DLLEXPORT ReferenceArgumentHelper(QoreValue val, const QoreTypeInfo* typeInfo, ExceptionSink* xsink);
101
103 DLLEXPORT ~ReferenceArgumentHelper();
104
106
108 DLLEXPORT ReferenceNode* getArg() const;
109
111
113 DLLEXPORT QoreValue getOutputValue();
114 };
115
116 #endif
ReferenceArgumentHelper::getArg
DLLEXPORT ReferenceNode * getArg() const
returns the reference to the fake local variable for use in an argument list, the caller owns the ref...
ReferenceArgumentHelper
allows a reference to be passed as an argument to Qore code
Definition: ReferenceArgumentHelper.h:58
ReferenceNode
parse type: reference to a lvalue expression
Definition: ReferenceNode.h:45
QoreValue
The main value class in Qore, designed to be passed by value.
Definition: QoreValue.h:267
ExceptionSink
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:48
ReferenceArgumentHelper::~ReferenceArgumentHelper
DLLEXPORT ~ReferenceArgumentHelper()
frees all memory still managed by the object
ReferenceArgumentHelper::getOutputValue
DLLEXPORT QoreValue getOutputValue()
returns the value of the reference and leaves the reference empty, the caller owns the reference retu...