Qore Programming Language 2.0.0
Loading...
Searching...
No Matches
ResolvedCallReferenceNode Class Referenceabstract

base class for resolved call references More...

#include <CallReferenceNode.h>

Inheritance diagram for ResolvedCallReferenceNode:
[legend]
Collaboration diagram for ResolvedCallReferenceNode:
[legend]

Public Member Methods

DLLEXPORT ResolvedCallReferenceNode ()
 public exported constructor function
 
DLLLOCAL ResolvedCallReferenceNode (bool n_needs_eval, qore_type_t n_type=NT_FUNCREF)
 constructor is not exported outside the library
 
virtual DLLEXPORT ~ResolvedCallReferenceNode ()
 public destructor function
 
virtual DLLEXPORT QoreValue evalImpl (bool &needs_deref, ExceptionSink *xsink) const
 this function should never be called for function references; this function should never be called directly
 
virtual DLLLOCAL QoreValue execValue (const QoreListNode *args, ExceptionSink *xsink) const =0
 pure virtual function for executing the function reference
 
virtual DLLLOCAL QoreFunction * getFunction ()=0
 Returns the internal function object, if any; can return nullptr.
 
virtual DLLEXPORT QoreProgramgetProgram () const
 returns a pointer to the QoreProgram object associated with this reference (can be nullptr)
 
virtual DLLEXPORT bool is_equal_hard (const AbstractQoreNode *v, ExceptionSink *xsink) const
 returns true if the other node is the same value
 
virtual DLLEXPORT bool is_equal_soft (const AbstractQoreNode *v, ExceptionSink *xsink) const
 returns true if the other node is the same value
 
virtual DLLEXPORT int parseInit (QoreValue &val, QoreParseContext &parse_context)
 for use by parse types to initialize them for execution during stage 1 parsing
 
virtual DLLEXPORT AbstractQoreNoderealCopy () const
 returns this with the ref count inmcremented; not a real copy
 
DLLLOCAL ResolvedCallReferenceNoderefRefSelf () const
 references itself and returns this
 
DLLLOCAL void weakDeref ()
 Decrements the weak reference count.
 
DLLLOCAL void weakRef ()
 Increments the weak reference count.
 
- Public Member Methods inherited from AbstractCallReferenceNode
virtual DLLEXPORT bool getAsBoolImpl () const
 returns false unless perl-boolean-evaluation is enabled, in which case it returns true
 
virtual DLLEXPORT QoreStringgetAsString (bool &del, int foff, ExceptionSink *xsink) const
 returns a QoreString giving the verbose string representation of the value
 
virtual DLLEXPORT int getAsString (QoreString &str, int foff, ExceptionSink *xsink) const
 concatenate the verbose string representation of the value to an existing QoreString
 
virtual DLLEXPORT const char * getTypeName () const
 returns the type name as a c string
 
DLLLOCAL AbstractCallReferenceNoderefSelf () const
 Returns a non-const ptr to the same object after increasing the reference count.
 
- Public Member Methods inherited from AbstractQoreNode
DLLEXPORT AbstractQoreNode (const AbstractQoreNode &v)
 copy constructor
 
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
 
virtual DLLEXPORT void customDeref (ExceptionSink *xsink)
 
virtual DLLEXPORT void customRef () const
 special processing when the object's reference count transitions from 0-1
 
DLLEXPORT void deref (ExceptionSink *xsink)
 decrements the reference count and calls derefImpl() if there_can_be_only_one is false, otherwise does nothing
 
DLLEXPORT QoreValue eval (bool &needs_deref, ExceptionSink *xsink) const
 optionally evaluates the argument
 
DLLEXPORT QoreValue eval (ExceptionSink *xsink) const
 evaluates the object and returns a value (or 0)
 
DLLEXPORT int64 getAsBigInt () const
 returns the 64-bit integer value of the object
 
virtual DLLLOCAL int64 getAsBigIntImpl () const
 default implementation, returns 0
 
DLLEXPORT bool getAsBool () const
 returns the boolean value of the object
 
DLLEXPORT double getAsFloat () const
 returns the float value of the object
 
virtual DLLLOCAL double getAsFloatImpl () const
 default implementation, returns 0.0
 
DLLEXPORT int getAsInt () const
 returns the integer value of the object
 
virtual DLLLOCAL int getAsIntImpl () const
 default implementation, returns 0
 
virtual DLLEXPORT class DateTimegetDateTimeRepresentation (bool &del) const
 returns the DateTime representation of this type (default implementation: returns ZeroDate, del = false)
 
virtual DLLEXPORT void getDateTimeRepresentation (DateTime &dt) const
 assigns the date representation of a value to the DateTime reference passed, default implementation does nothing
 
virtual DLLEXPORT QoreStringgetStringRepresentation (bool &del) const
 returns the value of the type converted to a string, default implementation: returns the empty string
 
virtual DLLEXPORT void getStringRepresentation (QoreString &str) const
 concatentates the value of the type to an existing QoreString reference, default implementation does nothing
 
DLLLOCAL qore_type_t getType () const
 returns the data type
 
DLLLOCAL bool is_value () const
 returns true if the node represents a value
 
DLLLOCAL bool isReferenceCounted () const
 returns true if the object is reference-counted
 
DLLLOCAL bool needs_eval () const
 returns true if the object needs evaluation to return a value, false if not
 
DLLLOCAL AbstractQoreNodeoperator= (const AbstractQoreNode &)
 this function is not implemented; it is here as a private function in order to prohibit it from being used
 
DLLEXPORT void ref () const
 increments the reference count
 
DLLEXPORT AbstractQoreNoderefSelf () const
 returns "this" with an incremented reference count
 
- Public Member Methods inherited from QoreReferenceCounter
DLLEXPORT QoreReferenceCounter ()
 Creates the reference counter object.
 
DLLEXPORT QoreReferenceCounter (const QoreReferenceCounter &old)
 Creates a new object with a reference count of 1.
 
DLLEXPORT ~QoreReferenceCounter ()
 destroys the reference counter object
 
DLLEXPORT bool is_unique () const
 Returns true if the reference count is 1.
 
DLLEXPORT bool optRef ()
 Make a strong reference only if the object is valid.
 
DLLEXPORT int reference_count () const
 Gets the reference count.
 
DLLEXPORT bool ROdereference () const
 Atomically decrements the reference count.
 
DLLEXPORT void ROreference () const
 Atomically increments the reference count.
 

Private Member Methods

virtual DLLEXPORT bool derefImpl (ExceptionSink *xsink)
 Called when the strong reference count reaches zero.
 
- Private Member Methods inherited from AbstractCallReferenceNode
DLLLOCAL AbstractCallReferenceNode (bool n_needs_eval, bool n_there_can_be_only_one, qore_type_t n_type=NT_FUNCREF)
 protected constructor for subclasses that are not reference-counted
 
- Private Member Methods inherited from AbstractQoreNode
virtual DLLEXPORT ~AbstractQoreNode ()
 default destructor does nothing
 

Private Attributes

QoreReferenceCounter weak_refs
 weak references
 
- Private Attributes inherited from AbstractQoreNode
bool custom_reference_handlers: 1
 set to one for objects that need custom reference handlers
 
bool needs_eval_flag: 1
 if this is true then the type can be evaluated
 
bool there_can_be_only_one: 1
 if this is set to true, then reference counting is turned off for objects of this class
 
qore_type_t type: 11
 the type of the object
 
bool value: 1
 this is true for values, if false then either the type needs evaluation to produce a value or is a parse expression
 

Detailed Description

base class for resolved call references

Member Function Documentation

◆ derefImpl()

virtual DLLEXPORT bool ResolvedCallReferenceNode::derefImpl ( ExceptionSink xsink)
privatevirtual

Called when the strong reference count reaches zero.

This function must free all memory owned by the object; the weak reference count is decremented, and if it reaches zero, the object is deleted

Parameters
xsinkif an error occurs, the Qore-language exception information will be added here
Returns
always returns false

Reimplemented from AbstractQoreNode.

Reimplemented in FunctionCallReferenceNode.

◆ evalImpl()

virtual DLLEXPORT QoreValue ResolvedCallReferenceNode::evalImpl ( bool &  needs_deref,
ExceptionSink xsink 
) const
virtual

this function should never be called for function references; this function should never be called directly

in debug mode this function calls assert(false)

Reimplemented from AbstractCallReferenceNode.

Reimplemented in LocalStaticMethodCallReferenceNode, LocalMethodCallReferenceNode, and LocalFunctionCallReferenceNode.

◆ execValue()

virtual DLLLOCAL QoreValue ResolvedCallReferenceNode::execValue ( const QoreListNode args,
ExceptionSink xsink 
) const
pure virtual

pure virtual function for executing the function reference

executes the function reference and returns the value returned

Parameters
argsthe arguments to the function
xsinkany Qore-language exception thrown (and not handled) will be added here
Returns
a pointer to an AbstractQoreNode, the caller owns the reference count returned (can also be nullptr)

Implemented in LocalStaticMethodCallReferenceNode, LocalMethodCallReferenceNode, LocalFunctionCallReferenceNode, FunctionCallReferenceNode, RunTimeObjectMethodReferenceNode, and RunTimeResolvedMethodReferenceNode.

◆ getProgram()

virtual DLLEXPORT QoreProgram * ResolvedCallReferenceNode::getProgram ( ) const
virtual

returns a pointer to the QoreProgram object associated with this reference (can be nullptr)

this function is not exported in the library's public interface

Returns
a pointer to the QoreProgram object associated with this reference (can be nullptr)

Reimplemented in RunTimeObjectMethodReferenceNode, and RunTimeResolvedMethodReferenceNode.

◆ parseInit()

virtual DLLEXPORT int ResolvedCallReferenceNode::parseInit ( QoreValue val,
QoreParseContext &  parse_context 
)
virtual

for use by parse types to initialize them for execution during stage 1 parsing

Not exported in the library; this method's API/ABI subject to change at any time.

This function should only be overridden by types that can appear in the parse tree (i.e. are recognized by the parser)

Parameters
valthe containing QoreValue
parse_contextthe parse context
Returns
-1 if an error occured, 0 if OK

Reimplemented from AbstractQoreNode.


The documentation for this class was generated from the following file: