Qore Programming Language - C/C++ Library 2.1.1
Loading...
Searching...
No Matches
QoreTypeSafeReferenceHelper.h
1/* -*- mode: c++; indent-tabs-mode: nil -*- */
2/*
3 QoreTypeSafeReferenceHelper.h
4
5 Qore Programming Language
6
7 Copyright (C) 2003 - 2024 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_QORETYPESAFEREFERENCEHELPER_H
33
34#define _QORE_QORETYPESAFEREFERENCEHELPER_H
35
37
58friend struct qore_type_safe_ref_helper_priv_t;
59public:
61
64
66
70
73
75
77 DLLEXPORT int set(const ReferenceNode* ref);
78
80
82 DLLEXPORT int reset(const ReferenceNode* ref, ExceptionSink* xsink);
83
85
87 DLLEXPORT operator bool() const;
88
90
92 DLLEXPORT qore_type_t getType() const;
93
95
97 DLLEXPORT const char* getTypeName() const;
98
100
126
128
153 template <typename T>
154 DLLLOCAL T* getUnique() {
155 T* rv = reinterpret_cast<T*>(getUnique());
156 assert(!rv || dynamic_cast<T*>(rv));
157 return rv;
158 }
159
161
175 DLLEXPORT int assign(QoreValue val);
176
178
180 DLLEXPORT const QoreValue getValue() const;
181
183 DLLEXPORT AutoVLock& getVLock() const;
184
186
188 DLLEXPORT void close();
189
191 DLLEXPORT int setObjKey(QoreObject* obj, const char* key, bool for_remove = false);
192
194 DLLEXPORT int moveToHashObjKey(const char* key, bool for_remove = false);
195
197 DLLEXPORT QoreValue removeHashObjKey(const char* key);
198
200 DLLEXPORT ExceptionSink* getExceptionSink() const;
201
203 DLLEXPORT const QoreTypeInfo* getReferenceTypeInfo() const;
204
206 DLLEXPORT bool isLocked() const;
207
208private:
210 DLLLOCAL QoreTypeSafeReferenceHelper& operator=(const QoreTypeSafeReferenceHelper&) = delete;
211 DLLLOCAL void* operator new(size_t) = delete;
212
214 struct qore_type_safe_ref_helper_priv_t* priv;
215};
216
217#endif
The base class for all value and parse types in Qore expression trees.
Definition AbstractQoreNode.h:57
AutoVLock is a container for safely managing global variable and object lock handovers,...
Definition AutoVLock.h:80
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition ExceptionSink.h:50
the implementation of Qore's object data type, reference counted, dynamically-allocated only
Definition QoreObject.h:61
helper class to manage variable references passed to functions and class methods, stack only,...
Definition QoreTypeSafeReferenceHelper.h:57
DLLEXPORT ExceptionSink * getExceptionSink() const
Returns the ExceptionSink object.
DLLEXPORT AbstractQoreNode * getUnique()
returns a pointer to the value with a unique reference count (so it can be updated in place)
DLLEXPORT int reset(const ReferenceNode *ref, ExceptionSink *xsink)
Clears any existing reference and assigns the reference to use.
DLLEXPORT const char * getTypeName() const
returns the type name of the reference's value
DLLEXPORT QoreTypeSafeReferenceHelper(const ReferenceNode *ref, ExceptionSink *xsink)
initializes the object and tries to get the pointer to the pointer of the lvalue expression target
DLLEXPORT int assign(QoreValue val)
assigns a value to the reference, assumes the reference is valid
DLLEXPORT QoreTypeSafeReferenceHelper(ExceptionSink *xsink)
Initializes the object without a reference.
DLLEXPORT int setObjKey(QoreObject *obj, const char *key, bool for_remove=false)
Moves the reference to the given key of the given object.
DLLEXPORT const QoreTypeInfo * getReferenceTypeInfo() const
Returns the type of the reference.
DLLEXPORT ~QoreTypeSafeReferenceHelper()
destroys the object
DLLEXPORT int set(const ReferenceNode *ref)
Assigns the reference to use.
DLLEXPORT QoreValue removeHashObjKey(const char *key)
Removes the given key of the current hash or object.
DLLEXPORT const QoreValue getValue() const
returns the reference's value
DLLEXPORT bool isLocked() const
Returns true if managing a lock.
DLLEXPORT AutoVLock & getVLock() const
Returns the variable lock.
DLLLOCAL T * getUnique()
returns a pointer to the value with a unique reference count (so it can be updated in place)
Definition QoreTypeSafeReferenceHelper.h:154
DLLEXPORT void close()
Closes the object and unlocks all locks.
DLLEXPORT qore_type_t getType() const
returns the type of the reference's value
DLLEXPORT int moveToHashObjKey(const char *key, bool for_remove=false)
Moves the reference to the given key of the hash or object of the current value.
parse type: reference to a lvalue expression
Definition ReferenceNode.h:45
int16_t qore_type_t
used to identify unique Qore data and parse types (descendents of AbstractQoreNode)
Definition common.h:76
The main value class in Qore, designed to be passed by value.
Definition QoreValue.h:279