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

AbstractQoreNode.h
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3 AbstractQoreNode.h
4
5 Qore Programming Language
6
7 Copyright (C) 2003 - 2021 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_ABSTRACTQORENODE_H
33
34 #define _QORE_ABSTRACTQORENODE_H
35
36 #include <qore/common.h>
37 #include <qore/QoreReferenceCounter.h>
38 #include <qore/node_types.h>
39
40 #include <string>
41
42 #include <cassert>
43
44 #define FMT_YAML_SHORT -2
45 #define FMT_NONE -1
46 #define FMT_NORMAL 0
47
48 class LocalVar;
49
50 // forward declaration
51 struct QoreParseContext;
52
54
57 class AbstractQoreNode : public QoreReferenceCounter {
58 public:
60
67 DLLEXPORT AbstractQoreNode(qore_type_t t, bool n_value, bool n_needs_eval, bool n_there_can_be_only_one = false, bool n_custom_reference_handlers = false);
68
70 DLLEXPORT AbstractQoreNode(const AbstractQoreNode& v);
71
73
76 DLLEXPORT bool getAsBool() const;
77
79
82 DLLEXPORT int getAsInt() const;
83
85
88 DLLEXPORT int64 getAsBigInt() const;
89
91
94 DLLEXPORT double getAsFloat() const;
95
97
102 DLLEXPORT virtual QoreString* getStringRepresentation(bool& del) const;
103
105
108 DLLEXPORT virtual void getStringRepresentation(QoreString &str) const;
109
111
115 DLLEXPORT virtual class DateTime* getDateTimeRepresentation(bool& del) const;
116
118
121 DLLEXPORT virtual void getDateTimeRepresentation(DateTime &dt) const;
122
124
130 DLLEXPORT virtual int getAsString(QoreString &str, int foff, ExceptionSink* xsink) const = 0;
131
133
139 DLLEXPORT virtual QoreString *getAsString(bool& del, int foff, ExceptionSink* xsink) const = 0;
140
142
145 DLLLOCAL bool needs_eval() const {
146 return needs_eval_flag;
147 }
148
150
153 DLLEXPORT virtual AbstractQoreNode* realCopy() const = 0;
154
156
161 DLLEXPORT virtual bool is_equal_soft(const AbstractQoreNode* v, ExceptionSink* xsink) const = 0;
162
164
169 DLLEXPORT virtual bool is_equal_hard(const AbstractQoreNode* v, ExceptionSink* xsink) const = 0;
170
172
175 DLLLOCAL qore_type_t getType() const {
176 return type;
177 }
178
180
183 DLLEXPORT virtual const char* getTypeName() const = 0;
184
186
202 DLLEXPORT QoreValue eval(ExceptionSink* xsink) const;
203
205
217 DLLEXPORT QoreValue eval(bool& needs_deref, ExceptionSink* xsink) const;
218
220
223 DLLLOCAL bool is_value() const {
224 return value;
225 }
226
228
232 DLLEXPORT void deref(ExceptionSink* xsink);
233
235
238 DLLEXPORT AbstractQoreNode* refSelf() const;
239
241 DLLEXPORT void ref() const;
242
244 DLLLOCAL bool isReferenceCounted() const { return !there_can_be_only_one; }
245
247
257 DLLLOCAL virtual int parseInit(QoreValue& val, QoreParseContext& parse_context);
258
260 DLLLOCAL AbstractQoreNode& operator=(const AbstractQoreNode&);
261
263
266 DLLLOCAL virtual bool getAsBoolImpl() const { return false; }
267
269
272 DLLLOCAL virtual int getAsIntImpl() const { return 0; }
273
275
278 DLLLOCAL virtual int64 getAsBigIntImpl() const { return 0; }
279
281
284 DLLLOCAL virtual double getAsFloatImpl() const { return 0.0; }
285
287
299 DLLEXPORT virtual QoreValue evalImpl(bool& needs_deref, ExceptionSink* xsink) const = 0;
300
302
307 DLLEXPORT virtual bool derefImpl(ExceptionSink* xsink);
308
310
314 DLLEXPORT virtual void customRef() const;
315
320 DLLEXPORT virtual void customDeref(ExceptionSink* xsink);
321
322 protected:
324
327 qore_type_t type : 11;
328
330 bool value : 1;
331
333 bool needs_eval_flag : 1;
334
336 bool there_can_be_only_one : 1;
337
339 bool custom_reference_handlers : 1;
340
342
345 DLLEXPORT virtual ~AbstractQoreNode();
346 };
347
349
352 class SimpleQoreNode : public AbstractQoreNode {
353 public:
355 SimpleQoreNode& operator=(const SimpleQoreNode&) = delete;
356
358 DLLLOCAL SimpleQoreNode(qore_type_t t, bool n_value, bool n_needs_eval, bool n_there_can_be_only_one = false) : AbstractQoreNode(t, n_value, n_needs_eval, n_there_can_be_only_one) { }
359
361 DLLLOCAL SimpleQoreNode(const SimpleQoreNode& v) : AbstractQoreNode(v) { }
362
364
367 using AbstractQoreNode::deref;
368 DLLEXPORT void deref();
369 };
370
372 class SimpleValueQoreNode : public SimpleQoreNode {
373 public:
375 DLLLOCAL SimpleValueQoreNode(qore_type_t t, bool n_there_can_be_only_one = false) : SimpleQoreNode(t, true, false, n_there_can_be_only_one) { }
376
377 DLLLOCAL SimpleValueQoreNode(const SimpleValueQoreNode& v) : SimpleQoreNode(v) { }
378
379 protected:
381
383 DLLEXPORT virtual QoreValue evalImpl(bool& needs_deref, ExceptionSink* xsink) const;
384 };
385
387
389 class UniqueValueQoreNode : public SimpleValueQoreNode {
390 public:
392 DLLLOCAL UniqueValueQoreNode& operator=(const UniqueValueQoreNode&) = delete;
393
395 DLLLOCAL void *operator new(size_t) = delete;
396
398 DLLLOCAL UniqueValueQoreNode(qore_type_t t) : SimpleValueQoreNode(t, true) { }
399
401 DLLLOCAL UniqueValueQoreNode(const UniqueValueQoreNode& ) : SimpleValueQoreNode(type, true) { }
402
404 DLLEXPORT virtual AbstractQoreNode* realCopy() const;
405 };
406
407 #endif
AbstractQoreNode::customRef
virtual DLLEXPORT void customRef() const
special processing when the object&#39;s reference count transitions from 0-1
AbstractQoreNode::getType
DLLLOCAL qore_type_t getType() const
returns the data type
Definition: AbstractQoreNode.h:175
AbstractQoreNode::getStringRepresentation
virtual DLLEXPORT QoreString * getStringRepresentation(bool &del) const
returns the value of the type converted to a string, default implementation: returns the empty string...
AbstractQoreNode::getAsFloatImpl
virtual DLLLOCAL double getAsFloatImpl() const
default implementation, returns 0.0
Definition: AbstractQoreNode.h:284
AbstractQoreNode::parseInit
virtual DLLLOCAL int parseInit(QoreValue &val, QoreParseContext &parse_context)
for use by parse types to initialize them for execution during stage 1 parsing
AbstractQoreNode::getAsInt
DLLEXPORT int getAsInt() const
returns the integer value of the object
AbstractQoreNode::getAsString
virtual DLLEXPORT int getAsString(QoreString &str, int foff, ExceptionSink *xsink) const =0
concatenate the verbose string representation of the value (including all contained values for contai...
AbstractQoreNode::is_value
DLLLOCAL bool is_value() const
returns true if the node represents a value
Definition: AbstractQoreNode.h:223
AbstractQoreNode::getAsBool
DLLEXPORT bool getAsBool() const
returns the boolean value of the object
DateTime
Holds absolute and relative date/time values in Qore with precision to the microsecond.
Definition: DateTime.h:93
UniqueValueQoreNode::UniqueValueQoreNode
DLLLOCAL UniqueValueQoreNode(qore_type_t t)
constructor takes the type argument
Definition: AbstractQoreNode.h:398
AbstractQoreNode
The base class for all value and parse types in Qore expression trees.
Definition: AbstractQoreNode.h:57
AbstractQoreNode::derefImpl
virtual DLLEXPORT bool derefImpl(ExceptionSink *xsink)
decrements the reference count
AbstractQoreNode::eval
DLLEXPORT QoreValue eval(ExceptionSink *xsink) const
evaluates the object and returns a value (or 0)
AbstractQoreNode::is_equal_hard
virtual DLLEXPORT bool is_equal_hard(const AbstractQoreNode *v, ExceptionSink *xsink) const =0
tests for equality ("deep compare" including all contained values for container types) without type c...
AbstractQoreNode::getAsBoolImpl
virtual DLLLOCAL bool getAsBoolImpl() const
default implementation, returns false
Definition: AbstractQoreNode.h:266
AbstractQoreNode::refSelf
DLLEXPORT AbstractQoreNode * refSelf() const
returns "this" with an incremented reference count
AbstractQoreNode::getTypeName
virtual DLLEXPORT const char * getTypeName() const =0
returns the type name as a c string
QoreString
Qore&#39;s string type supported by the QoreEncoding class.
Definition: QoreString.h:81
AbstractQoreNode::custom_reference_handlers
bool custom_reference_handlers
set to one for objects that need custom reference handlers
Definition: AbstractQoreNode.h:339
AbstractQoreNode::needs_eval_flag
bool needs_eval_flag
if this is true then the type can be evaluated
Definition: AbstractQoreNode.h:333
UniqueValueQoreNode::realCopy
virtual DLLEXPORT AbstractQoreNode * realCopy() const
returns itself; objects of this type are not reference-counted and only deleted manually (by static d...
UniqueValueQoreNode
this class is for value types that will exists only once in the Qore library, reference counting is d...
Definition: AbstractQoreNode.h:389
QoreReferenceCounter
provides atomic reference counting to Qore objects
Definition: QoreReferenceCounter.h:44
AbstractQoreNode::customDeref
virtual DLLEXPORT void customDeref(ExceptionSink *xsink)
QoreValue
The main value class in Qore, designed to be passed by value.
Definition: QoreValue.h:267
AbstractQoreNode::getDateTimeRepresentation
virtual DLLEXPORT class DateTime * getDateTimeRepresentation(bool &del) const
returns the DateTime representation of this type (default implementation: returns ZeroDate...
AbstractQoreNode::realCopy
virtual DLLEXPORT AbstractQoreNode * realCopy() const =0
returns a copy of the object; the caller owns the reference count
AbstractQoreNode::getAsBigInt
DLLEXPORT int64 getAsBigInt() const
returns the 64-bit integer value of the object
AbstractQoreNode::operator=
DLLLOCAL AbstractQoreNode & operator=(const AbstractQoreNode &)
this function is not implemented; it is here as a private function in order to prohibit it from being...
SimpleQoreNode
The base class for all types in Qore expression trees that cannot throw an exception when deleted...
Definition: AbstractQoreNode.h:352
ExceptionSink
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:48
SimpleQoreNode::operator=
SimpleQoreNode & operator=(const SimpleQoreNode &)=delete
this function is not implemented
AbstractQoreNode::evalImpl
virtual DLLEXPORT QoreValue evalImpl(bool &needs_deref, ExceptionSink *xsink) const =0
optionally evaluates the argument
AbstractQoreNode::deref
DLLEXPORT void deref(ExceptionSink *xsink)
decrements the reference count and calls derefImpl() if there_can_be_only_one is false, otherwise does nothing
AbstractQoreNode::needs_eval
DLLLOCAL bool needs_eval() const
returns true if the object needs evaluation to return a value, false if not
Definition: AbstractQoreNode.h:145
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
AbstractQoreNode::ref
DLLEXPORT void ref() const
increments the reference count
SimpleValueQoreNode::SimpleValueQoreNode
DLLLOCAL SimpleValueQoreNode(qore_type_t t, bool n_there_can_be_only_one=false)
creates the object by assigning the type code and setting the "value" flag, unsetting the "needs_eval...
Definition: AbstractQoreNode.h:375
AbstractQoreNode::AbstractQoreNode
DLLEXPORT AbstractQoreNode(qore_type_t t, bool n_value, bool n_needs_eval, bool n_there_can_be_only_one=false, bool n_custom_reference_handlers=false)
constructor takes the type
AbstractQoreNode::getAsFloat
DLLEXPORT double getAsFloat() const
returns the float value of the object
AbstractQoreNode::there_can_be_only_one
bool there_can_be_only_one
if this is set to true, then reference counting is turned off for objects of this class ...
Definition: AbstractQoreNode.h:336
SimpleValueQoreNode::evalImpl
virtual DLLEXPORT QoreValue evalImpl(bool &needs_deref, ExceptionSink *xsink) const
should never be called for value types
SimpleQoreNode::SimpleQoreNode
DLLLOCAL SimpleQoreNode(qore_type_t t, bool n_value, bool n_needs_eval, bool n_there_can_be_only_one=false)
constructor takes the type and value arguments
Definition: AbstractQoreNode.h:358
qore_type_t
int16_t qore_type_t
used to identify unique Qore data and parse types (descendents of AbstractQoreNode) ...
Definition: common.h:70
AbstractQoreNode::getAsIntImpl
virtual DLLLOCAL int getAsIntImpl() const
default implementation, returns 0
Definition: AbstractQoreNode.h:272
AbstractQoreNode::value
bool value
this is true for values, if false then either the type needs evaluation to produce a value or is a pa...
Definition: AbstractQoreNode.h:330
UniqueValueQoreNode::operator=
DLLLOCAL UniqueValueQoreNode & operator=(const UniqueValueQoreNode &)=delete
this function is not implemented
common.h
AbstractQoreNode::~AbstractQoreNode
virtual DLLEXPORT ~AbstractQoreNode()
default destructor does nothing
SimpleValueQoreNode
base class for simple value types
Definition: AbstractQoreNode.h:372
AbstractQoreNode::is_equal_soft
virtual DLLEXPORT bool is_equal_soft(const AbstractQoreNode *v, ExceptionSink *xsink) const =0
tests for equality ("deep compare" including all contained values for container types) with possible ...
AbstractQoreNode::isReferenceCounted
DLLLOCAL bool isReferenceCounted() const
returns true if the object is reference-counted
Definition: AbstractQoreNode.h:244
AbstractQoreNode::type
qore_type_t type
the type of the object
Definition: AbstractQoreNode.h:327
node_types.h
AbstractQoreNode::getAsBigIntImpl
virtual DLLLOCAL int64 getAsBigIntImpl() const
default implementation, returns 0
Definition: AbstractQoreNode.h:278