Qore Programming Language - C/C++ Library  0.8.12.2
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
QoreTypeSafeReferenceHelper.h
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3  QoreTypeSafeReferenceHelper.h
4 
5  Qore Programming Language
6 
7  Copyright (C) 2003 - 2015 David Nichols
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_QORETYPESAFEREFERENCEHELPER_H
33 
34 #define _QORE_QORETYPESAFEREFERENCEHELPER_H
35 
37 
58 private:
61 
63  DLLLOCAL QoreTypeSafeReferenceHelper& operator=(const QoreTypeSafeReferenceHelper&);
64 
66  DLLLOCAL void *operator new(size_t);
67 
69  struct qore_type_safe_ref_helper_priv_t *priv;
70 
71 public:
73 
76  DLLEXPORT QoreTypeSafeReferenceHelper(const ReferenceNode *ref, ExceptionSink *xsink);
77 
79 
85  DLLEXPORT QoreTypeSafeReferenceHelper(const ReferenceNode *ref, AutoVLock &vl, ExceptionSink *xsink);
86 
88  DLLEXPORT ~QoreTypeSafeReferenceHelper();
89 
91 
93  DLLEXPORT operator bool() const;
94 
96 
98  DLLEXPORT qore_type_t getType() const;
99 
101 
103  DLLEXPORT const char* getTypeName() const;
104 
106 
122  DLLEXPORT AbstractQoreNode *getUnique(ExceptionSink *xsink);
123 
125 
137  DLLEXPORT int assign(QoreValue val);
138 
140 
152  DLLEXPORT int assign(AbstractQoreNode *val);
153 
155 
170  DLLEXPORT int assign(AbstractQoreNode *val, ExceptionSink *xsink);
171 
173 
176  DLLEXPORT int assignBigInt(int64 v);
177 
179 
182  DLLEXPORT int assignFloat(double v);
183 
185 
187  DLLEXPORT const AbstractQoreNode *getValue() const;
188 
190  DLLEXPORT void swap(QoreTypeSafeReferenceHelper &other);
191 };
192 
193 #ifndef _QORE_LIB_INTERN
195 #endif
196 
197 #endif
AutoVLock is a container for safely managing global variable and object lock handovers, required for functions accessing global variables and object data where locking is necessary.
Definition: AutoVLock.h:80
DLLEXPORT void swap(QoreTypeSafeReferenceHelper &other)
swaps the values of two references
The base class for all value and parse types in Qore expression trees.
Definition: AbstractQoreNode.h:55
DLLEXPORT qore_type_t getType() const
returns the type of the reference's value
DLLEXPORT AbstractQoreNode * getUnique(ExceptionSink *xsink)
returns a pointer to the value with a unique reference count (so it can be updated in place)...
DLLEXPORT ~QoreTypeSafeReferenceHelper()
destroys the object
parse type: reference to a lvalue expression
Definition: ReferenceNode.h:45
DLLEXPORT int assignBigInt(int64 v)
assigns an integer value to the reference
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:43
helper class to manage variable references passed to functions and class methods, stack only...
Definition: QoreTypeSafeReferenceHelper.h:57
DLLEXPORT int assignFloat(double v)
assigns an integer value to the reference
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:228
DLLEXPORT const char * getTypeName() const
returns the type name of the reference's value
int16_t qore_type_t
used to identify unique Qore data and parse types (descendents of AbstractQoreNode) ...
Definition: common.h:68
DLLEXPORT int assign(QoreValue val)
assigns a value to the reference, assumes the reference is valid
DLLEXPORT const AbstractQoreNode * getValue() const
returns a constant pointer to the reference's value