Qore Programming Language - C/C++ Library  0.8.12.3
QoreObject.h
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3  QoreObject.h
4 
5  thread-safe object definition
6 
7  references: how many variables are pointing at this object?
8 
9  Qore Programming Language
10 
11  Copyright (C) 2003 - 2016 David Nichols
12 
13  Permission is hereby granted, free of charge, to any person obtaining a
14  copy of this software and associated documentation files (the "Software"),
15  to deal in the Software without restriction, including without limitation
16  the rights to use, copy, modify, merge, publish, distribute, sublicense,
17  and/or sell copies of the Software, and to permit persons to whom the
18  Software is furnished to do so, subject to the following conditions:
19 
20  The above copyright notice and this permission notice shall be included in
21  all copies or substantial portions of the Software.
22 
23  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29  DEALINGS IN THE SOFTWARE.
30 
31  Note that the Qore library is released under a choice of three open-source
32  licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
33  information.
34 */
35 
36 #ifndef _QORE_QOREOBJECT_H
37 
38 #define _QORE_QOREOBJECT_H
39 
40 class AutoVLock;
41 class VRMutex;
42 class BuiltinCopy;
43 class BuiltinDeleteBlocker;
44 class BuiltinNormalMethodVariantBase;
45 class BuiltinCopyVariantBase;
46 class QoreExternalMethodVariant;
47 class QoreExternalStaticMethodVariant;
48 class QoreProgram;
49 
51 
64 class QoreObject : public AbstractQoreNode {
65  friend class qore_object_private;
66  friend class ObjectRSetHelper;
67  friend class ObjectRSet;
68  friend class qore_object_dereference_helper;
69 
70 private:
72  class qore_object_private* priv;
73 
75  DLLLOCAL QoreObject(const QoreObject&);
76 
78  DLLLOCAL QoreObject& operator=(const QoreObject&);
79 
80 protected:
82 
86  DLLEXPORT virtual bool derefImpl(ExceptionSink* xsink);
87 
89 
91  DLLLOCAL virtual AbstractQoreNode* evalImpl(ExceptionSink* xsink) const;
92 
94 
96  DLLLOCAL virtual AbstractQoreNode* evalImpl(bool& needs_deref, ExceptionSink* xsink) const;
97 
99 
101  DLLLOCAL virtual int64 bigIntEvalImpl(ExceptionSink* xsink) const;
102 
104 
106  DLLLOCAL virtual int integerEvalImpl(ExceptionSink* xsink) const;
107 
109 
111  DLLLOCAL virtual bool boolEvalImpl(ExceptionSink* xsink) const;
112 
114 
116  DLLLOCAL virtual double floatEvalImpl(ExceptionSink* xsink) const;
117 
119  DLLLOCAL void customRefIntern() const;
120 
122  DLLLOCAL virtual void customRef() const;
123 
125  DLLLOCAL virtual void customDeref(ExceptionSink* xsink);
126 
128  DLLLOCAL virtual ~QoreObject();
129 
130 public:
132 
136  DLLEXPORT QoreObject(const QoreClass* oc, QoreProgram* p);
137 
139 
144  DLLEXPORT QoreObject(const QoreClass* oc, QoreProgram* p, AbstractPrivateData *data);
145 
147 
149  DLLEXPORT virtual bool getAsBoolImpl() const;
150 
152 
158  DLLEXPORT virtual int getAsString(QoreString &str, int foff, ExceptionSink* xsink) const;
159 
161 
168  DLLEXPORT virtual QoreString* getAsString(bool& del, int foff, ExceptionSink* xsink) const;
169 
171  DLLEXPORT virtual AbstractQoreNode* realCopy() const;
172 
174 
178  DLLEXPORT virtual bool is_equal_soft(const AbstractQoreNode* v, ExceptionSink* xsink) const;
179 
181 
185  DLLEXPORT virtual bool is_equal_hard(const AbstractQoreNode* v, ExceptionSink* xsink) const;
186 
188  DLLEXPORT virtual const char* getTypeName() const;
189 
191  DLLLOCAL static const char* getStaticTypeName() {
192  return "object";
193  }
194 
196  DLLLOCAL static qore_type_t getStaticTypeCode() {
197  return NT_OBJECT;
198  }
199 
201 
205  DLLEXPORT bool validInstanceOf(qore_classid_t cid) const;
206 
208 
210  DLLEXPORT bool validInstanceOf(const QoreClass& qc) const;
211 
213 
218  DLLEXPORT void setValue(const char* key, AbstractQoreNode* val, ExceptionSink* xsink);
219 
221 
224  DLLEXPORT QoreListNode* getMemberList(ExceptionSink* xsink) const;
225 
227 
231  DLLEXPORT void deleteMemberValue(const QoreString* key, ExceptionSink* xsink);
232 
234 
238  DLLEXPORT void deleteMemberValue(const char* key, ExceptionSink* xsink);
239 
241 
245  DLLEXPORT void removeMember(const QoreString* key, ExceptionSink* xsink);
246 
248 
252  DLLEXPORT void removeMember(const char* key, ExceptionSink* xsink);
253 
255 
260  DLLEXPORT AbstractQoreNode* takeMember(const QoreString* key, ExceptionSink* xsink);
261 
263 
268  DLLEXPORT AbstractQoreNode* takeMember(const char* key, ExceptionSink* xsink);
269 
271 
274  DLLEXPORT int size(ExceptionSink* xsink) const;
275 
277 
281  DLLEXPORT bool compareSoft(const QoreObject* obj, ExceptionSink* xsink) const;
282 
284 
288  DLLEXPORT bool compareHard(const QoreObject* obj, ExceptionSink* xsink) const;
289 
291 
296  DLLEXPORT AbstractQoreNode* getReferencedMemberNoMethod(const char* mem, ExceptionSink* xsink) const;
297 
299 
305  DLLEXPORT int64 getMemberAsBigInt(const char* mem, bool& found, ExceptionSink* xsink) const;
306 
308 
311  DLLEXPORT QoreHashNode* copyData(ExceptionSink* xsink) const;
312 
314 
318  DLLEXPORT void mergeDataToHash(QoreHashNode* hash, ExceptionSink* xsink);
319 
321 
325  DLLEXPORT void setPrivate(qore_classid_t key, AbstractPrivateData *pd);
326 
328 
333 
335 
340  DLLEXPORT QoreValue evalMethodValue(const QoreString* name, const QoreListNode* args, ExceptionSink* xsink);
341 
343 
348  DLLEXPORT QoreValue evalMethodValue(const char* name, const QoreListNode* args, ExceptionSink* xsink);
349 
351 
358  DLLEXPORT AbstractQoreNode* evalMethod(const QoreString* name, const QoreListNode* args, ExceptionSink* xsink);
359 
361 
368  DLLEXPORT AbstractQoreNode* evalMethod(const char* name, const QoreListNode* args, ExceptionSink* xsink);
369 
371 
378  DLLEXPORT int64 bigIntEvalMethod(const char* name, const QoreListNode* args, ExceptionSink* xsink);
379 
381 
388  DLLEXPORT int intEvalMethod(const char* name, const QoreListNode* args, ExceptionSink* xsink);
389 
391 
398  DLLEXPORT bool boolEvalMethod(const char* name, const QoreListNode* args, ExceptionSink* xsink);
399 
401 
408  DLLEXPORT double floatEvalMethod(const char* name, const QoreListNode* args, ExceptionSink* xsink);
409 
411 
416  DLLEXPORT QoreValue evalMethodValue(const QoreMethod& method, const QoreListNode* args, ExceptionSink* xsink);
417 
419 
426  DLLEXPORT AbstractQoreNode* evalMethod(const QoreMethod& method, const QoreListNode* args, ExceptionSink* xsink);
427 
429 
436  DLLEXPORT int64 bigIntEvalMethod(const QoreMethod& method, const QoreListNode* args, ExceptionSink* xsink);
437 
439 
446  DLLEXPORT int intEvalMethod(const QoreMethod& method, const QoreListNode* args, ExceptionSink* xsink);
447 
449 
456  DLLEXPORT bool boolEvalMethod(const QoreMethod& method, const QoreListNode* args, ExceptionSink* xsink);
457 
459 
466  DLLEXPORT double floatEvalMethod(const QoreMethod& method, const QoreListNode* args, ExceptionSink* xsink);
467 
469 
472  DLLEXPORT void doDelete(ExceptionSink* xsink);
473 
475 
479  DLLEXPORT const QoreClass* getClass(qore_classid_t cid) const;
480 
482 
489  DLLEXPORT const QoreClass* getClass(qore_classid_t cid, bool& priv) const;
490 
492 
495  DLLEXPORT const QoreClass* getClass() const;
496 
498 
501  DLLEXPORT const char* getClassName() const;
502 
504 
507  DLLEXPORT bool isValid() const;
508 
510 
513  DLLEXPORT QoreProgram* getProgram() const;
514 
516 
519  DLLEXPORT bool isSystemObject() const;
520 
522 
527  DLLEXPORT void tRef() const;
528 
530 
533  DLLEXPORT void tDeref();
534 
536 
544  DLLEXPORT AbstractQoreNode* getMemberValueNoMethod(const QoreString* key, AutoVLock* vl, ExceptionSink* xsink) const;
545 
547 
553  DLLEXPORT AbstractQoreNode* getMemberValueNoMethod(const char* key, AutoVLock* vl, ExceptionSink* xsink) const;
554 
556 
558  DLLEXPORT void deleteBlockerRef() const;
559 
561 
565  DLLEXPORT void externalDelete(qore_classid_t key, ExceptionSink* xsink);
566 
568  DLLEXPORT AbstractQoreNode* evalMethodVariant(const QoreMethod& method, const QoreExternalMethodVariant* variant, const QoreListNode* args, ExceptionSink* xsink);
569 
570  DLLLOCAL int getStatus() const;
571 
573 
577  DLLLOCAL QoreValue evalMember(const QoreString* member, ExceptionSink* xsink);
578 
580 
584  DLLLOCAL QoreHashNode* getRuntimeMemberHash(ExceptionSink* xsink) const;
585 
586  DLLLOCAL class KeyNode* getReferencedPrivateDataNode(qore_classid_t key);
587 
589 
594 
596 
602  DLLLOCAL QoreValue evalBuiltinMethodWithPrivateData(const QoreMethod& method, const BuiltinNormalMethodVariantBase* meth, const QoreListNode* args, ExceptionSink* xsink);
603 
605  DLLLOCAL void evalCopyMethodWithPrivateData(const QoreClass &thisclass, const BuiltinCopyVariantBase* meth, QoreObject* self, ExceptionSink* xsink);
606 
608 
612  DLLLOCAL void addPrivateDataToString(QoreString* str, ExceptionSink* xsink) const;
613 
615 
618  DLLLOCAL void obliterate(ExceptionSink* xsink);
619 
621 
625  DLLLOCAL void defaultSystemDestructor(qore_classid_t classID, ExceptionSink* xsink);
626 
628 
636  DLLLOCAL AbstractQoreNode** getExistingValuePtr(const QoreString* mem, AutoVLock* vl, ExceptionSink* xsink) const;
637 
639 
646  DLLLOCAL AbstractQoreNode** getExistingValuePtr(const char* mem, AutoVLock* vl, ExceptionSink* xsink) const;
647 
648  // returns a new hash consisting of just the members of value_list
649  DLLLOCAL QoreHashNode* getSlice(const QoreListNode* value_list, ExceptionSink* xsink) const;
650 
652  DLLLOCAL QoreObject(const QoreClass* oc, QoreProgram* p, QoreHashNode* d);
653 
655  DLLLOCAL bool evalDeleteBlocker(qore_classid_t classid_for_method, BuiltinDeleteBlocker* meth);
656 
658  DLLLOCAL bool hasMemberNotification() const;
659 
661  DLLLOCAL void execMemberNotification(const char* member, ExceptionSink* xsink);
662 
664  DLLLOCAL AbstractQoreNode** getMemberValuePtrForInitialization(const char* member);
665 };
666 
668 template <class T>
670 public:
671  DLLLOCAL PrivateDataRefHolder(const QoreObject* o, qore_classid_t cid, ExceptionSink* xsink) : ReferenceHolder<T>(reinterpret_cast<T*>(o->getReferencedPrivateData(cid, xsink)), xsink) {
672  }
673 };
674 
675 class QorePrivateObjectAccessHelper {
676 private:
677  // not implemented
678  DLLLOCAL QorePrivateObjectAccessHelper(const QorePrivateObjectAccessHelper&);
679  DLLLOCAL QorePrivateObjectAccessHelper& operator=(const QorePrivateObjectAccessHelper&);
680  DLLLOCAL void* operator new(size_t);
681 
682 protected:
683  ExceptionSink* xsink;
684  void* ptr;
685 
686 public:
687  DLLLOCAL QorePrivateObjectAccessHelper(ExceptionSink* xs) : xsink(xs), ptr(0) {
688  }
689 
690  DLLLOCAL operator bool() const {
691  return (bool)ptr;
692  }
693 };
694 
695 #endif
DLLLOCAL QoreHashNode * getRuntimeMemberHash(ExceptionSink *xsink) const
retuns member data of the object (or 0 if there's an exception), private members are excluded if call...
DLLLOCAL void evalCopyMethodWithPrivateData(const QoreClass &thisclass, const BuiltinCopyVariantBase *meth, QoreObject *self, ExceptionSink *xsink)
called on the old object (this) to acquire private data, copy method called with pointer to "self" (n...
DLLEXPORT bool compareHard(const QoreObject *obj, ExceptionSink *xsink) const
tests for equality ("deep compare" including all contained values) with possible type conversion of c...
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 bool isSystemObject() const
returns true if the object is a system object (created with the system constructor) ...
DLLLOCAL void execMemberNotification(const char *member, ExceptionSink *xsink)
executes the member notification on the object the given member
This is the hash or associative list container type in Qore, dynamically allocated only...
Definition: QoreHashNode.h:49
DLLEXPORT void setValue(const char *key, AbstractQoreNode *val, ExceptionSink *xsink)
sets the value of the given member to the given value
DLLLOCAL AbstractQoreNode ** getMemberValuePtrForInitialization(const char *member)
returns a pointer to an object member during initialization (no locking; interal use only) ...
DLLEXPORT void doDelete(ExceptionSink *xsink)
runs the destructor on the object (if it hasn't already been deleted)
virtual DLLLOCAL bool boolEvalImpl(ExceptionSink *xsink) const
should never be called, does nothing
the base class for all data to be used as private data of Qore objects
Definition: AbstractPrivateData.h:44
DLLEXPORT void mergeDataToHash(QoreHashNode *hash, ExceptionSink *xsink)
copies all member data of the current object to the passed QoreHashNode
DLLEXPORT const char * getClassName() const
returns the name of the class
DLLEXPORT bool compareSoft(const QoreObject *obj, ExceptionSink *xsink) const
tests for equality ("deep compare" including all contained values) with possible type conversion of c...
DLLEXPORT void externalDelete(qore_classid_t key, ExceptionSink *xsink)
call this function when an object's private data is deleted externally
DLLEXPORT void removeMember(const QoreString *key, ExceptionSink *xsink)
removes a member from the object without explicitly calling destructors; the value is only dereferenc...
DLLEXPORT AbstractPrivateData * getReferencedPrivateData(qore_classid_t key, ExceptionSink *xsink) const
returns the private data corresponding to the class ID passed with an incremented reference count...
DLLEXPORT int size(ExceptionSink *xsink) const
returns the number of members of the object
DLLEXPORT AbstractQoreNode * takeMember(const QoreString *key, ExceptionSink *xsink)
removes a member from the object without explicitly calling destructors and returns the value removed...
virtual DLLEXPORT bool getAsBoolImpl() const
returns false unless perl-boolean-evaluation is enabled, in which case it returns false only when emp...
The base class for all value and parse types in Qore expression trees.
Definition: AbstractQoreNode.h:55
const qore_type_t NT_OBJECT
type value for QoreObject
Definition: node_types.h:52
virtual DLLLOCAL ~QoreObject()
destructor
DLLEXPORT bool boolEvalMethod(const char *name, const QoreListNode *args, ExceptionSink *xsink)
evaluates the given method with the arguments passed and returns the return value as a bool ...
DLLEXPORT const QoreClass * getClass() const
returns a pointer to the QoreClass of this object
DLLEXPORT int64 bigIntEvalMethod(const char *name, const QoreListNode *args, ExceptionSink *xsink)
evaluates the given method with the arguments passed and returns the return value as an int64 ...
DLLEXPORT QoreListNode * getMemberList(ExceptionSink *xsink) const
returns the list of members, caller owns the list returned
virtual DLLEXPORT AbstractQoreNode * realCopy() const
performs a deep copy of the list and returns the new list
virtual DLLLOCAL AbstractQoreNode * evalImpl(ExceptionSink *xsink) const
should never be called, does nothing
DLLEXPORT AbstractQoreNode * evalMethod(const QoreString *name, const QoreListNode *args, ExceptionSink *xsink)
evaluates the given method with the arguments passed and returns the return value, caller owns the AbstractQoreNode (reference) returned
virtual DLLLOCAL void customDeref(ExceptionSink *xsink)
custom dereference handler - with delete
DLLEXPORT QoreProgram * getProgram() const
returns the QoreProgram object associated with this object
virtual DLLEXPORT bool derefImpl(ExceptionSink *xsink)
runs the destructor if necessary and dereferences all members
DLLLOCAL bool hasMemberNotification() const
returns true if the class has a memberNotification method
DLLEXPORT QoreHashNode * copyData(ExceptionSink *xsink) const
retuns all member data of the object (or 0 if there's an exception), caller owns the QoreHashNode ref...
virtual DLLEXPORT bool is_equal_soft(const AbstractQoreNode *v, ExceptionSink *xsink) const
tests for equality ("deep compare" including all contained values) with possible type conversion (sof...
Qore's string type supported by the QoreEncoding class.
Definition: QoreString.h:82
DLLLOCAL void obliterate(ExceptionSink *xsink)
destroys all members and dereferences all private data structures
virtual DLLLOCAL void customRef() const
custom reference handler
static DLLLOCAL qore_type_t getStaticTypeCode()
returns the type code (useful in templates)
Definition: QoreObject.h:196
DLLEXPORT void tDeref()
decrements the existence reference count, when it reaches 0 the C++ object ("this") will be deleted ...
virtual DLLEXPORT const char * getTypeName() const
returns the type name as a c string
DLLEXPORT double floatEvalMethod(const char *name, const QoreListNode *args, ExceptionSink *xsink)
evaluates the given method with the arguments passed and returns the return value as a double ...
This is the list container type in Qore, dynamically allocated only, reference counted.
Definition: QoreListNode.h:52
virtual DLLEXPORT bool is_equal_hard(const AbstractQoreNode *v, ExceptionSink *xsink) const
tests for equality ("deep compare" including all contained values) without type conversions (hard com...
convenience class for holding AbstractPrivateData references
Definition: QoreObject.h:669
DLLLOCAL bool evalDeleteBlocker(qore_classid_t classid_for_method, BuiltinDeleteBlocker *meth)
evaluates the delete blocker function for the managed private data
DLLLOCAL void addPrivateDataToString(QoreString *str, ExceptionSink *xsink) const
concatenates info about private data to a string
defines a Qore-language class
Definition: QoreClass.h:195
DLLEXPORT QoreValue evalMethodValue(const QoreString *name, const QoreListNode *args, ExceptionSink *xsink)
evaluates the given method with the arguments passed and returns the return value, caller owns the AbstractQoreNode (reference) returned
DLLLOCAL QoreValue evalMember(const QoreString *member, ExceptionSink *xsink)
returns the value of the member with an incremented reference count, or executes the memberGate() met...
DLLEXPORT AbstractQoreNode * getReferencedMemberNoMethod(const char *mem, ExceptionSink *xsink) const
returns the value of the given member with the reference count incremented, the caller owns the Abstr...
supports parsing and executing Qore-language code, reference counted, dynamically-allocated only ...
Definition: QoreProgram.h:103
the implementation of Qore's object data type, reference counted, dynamically-allocated only ...
Definition: QoreObject.h:64
DLLEXPORT AbstractQoreNode * getMemberValueNoMethod(const QoreString *key, AutoVLock *vl, ExceptionSink *xsink) const
returns the pointer to the value of the member
DLLLOCAL void defaultSystemDestructor(qore_classid_t classID, ExceptionSink *xsink)
runs the destructor for system objects
unsigned qore_classid_t
used for the unique class ID for QoreClass objects
Definition: common.h:77
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:43
virtual DLLLOCAL int integerEvalImpl(ExceptionSink *xsink) const
should never be called, does nothing
virtual DLLLOCAL double floatEvalImpl(ExceptionSink *xsink) const
should never be called, does nothing
virtual DLLEXPORT int getAsString(QoreString &str, int foff, ExceptionSink *xsink) const
concatenate the verbose string representation of the list (including all contained values) to an exis...
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
DLLLOCAL AbstractPrivateData * getAndClearPrivateData(qore_classid_t key, ExceptionSink *xsink)
retrieves the private data pointer and clears it from the object's private data store, used when executing destructors
DLLLOCAL void customRefIntern() const
custom reference handler - unlocked
DLLLOCAL AbstractQoreNode ** getExistingValuePtr(const QoreString *mem, AutoVLock *vl, ExceptionSink *xsink) const
returns a pointer to a pointer to the value of the member only if it already exists, so it can be set externally
DLLEXPORT AbstractQoreNode * evalMethodVariant(const QoreMethod &method, const QoreExternalMethodVariant *variant, const QoreListNode *args, ExceptionSink *xsink)
executes a normal object method variant
virtual DLLLOCAL int64 bigIntEvalImpl(ExceptionSink *xsink) const
should never be called, does nothing
DLLEXPORT void deleteMemberValue(const QoreString *key, ExceptionSink *xsink)
removes a member from the object, if the member's value is an object it is deleted as well (destructo...
int16_t qore_type_t
used to identify unique Qore data and parse types (descendents of AbstractQoreNode) ...
Definition: common.h:68
DLLEXPORT void deleteBlockerRef() const
increment the reference count of the object, to be called only from within a delete blocker ...
static DLLLOCAL const char * getStaticTypeName()
returns the type name (useful in templates)
Definition: QoreObject.h:191
a method in a QoreClass
Definition: QoreClass.h:91
DLLEXPORT void tRef() const
increments the existence reference count
DLLLOCAL QoreValue evalBuiltinMethodWithPrivateData(const QoreMethod &method, const BuiltinNormalMethodVariantBase *meth, const QoreListNode *args, ExceptionSink *xsink)
called to evaluate a builtin method when private data is available
DLLEXPORT void setPrivate(qore_classid_t key, AbstractPrivateData *pd)
sets private data for the object against the class ID passed, used in C++ functions implementing Qore...
DLLEXPORT bool isValid() const
returns true if the object is valid
a templated class to manage a reference count of an object that can throw a Qore-language exception w...
Definition: ReferenceHolder.h:51
DLLEXPORT int64 getMemberAsBigInt(const char *mem, bool &found, ExceptionSink *xsink) const
returns the value of the given member as an int64
DLLEXPORT bool validInstanceOf(qore_classid_t cid) const
returns true if this object is a valid instance of the classid passed
DLLEXPORT int intEvalMethod(const char *name, const QoreListNode *args, ExceptionSink *xsink)
evaluates the given method with the arguments passed and returns the return value as an int ...