CallReferenceNode.h

/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
    CallReferenceNode.h
 
    Qore Programming Language
 
    Copyright (C) 2003 - 2024 Qore Technologies, s.r.o.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 
    Note that the Qore library is released under a choice of three open-source
    licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
    information.
*/
 
#ifndef _QORE_FUNCTIONREFERENCENODE_H
 
#define _QORE_FUNCTIONREFERENCENODE_H
 
 
class AbstractCallReferenceNode : public AbstractQoreNode {
public:
    DLLEXPORT AbstractCallReferenceNode(bool n_needs_eval = false, qore_type_t n_type = NT_FUNCREF);
 
    DLLEXPORT virtual ~AbstractCallReferenceNode();
 
 
    DLLEXPORT virtual bool getAsBoolImpl() const;
 
 
    DLLEXPORT virtual int getAsString(QoreString& str, int foff, ExceptionSink* xsink) const;
 
 
    DLLEXPORT virtual QoreString* getAsString(bool& del, int foff, ExceptionSink* xsink) const;
 
    DLLEXPORT virtual const char* getTypeName() const;
 
    DLLLOCAL AbstractCallReferenceNode* refSelf() const {
        ref();
        return const_cast<AbstractCallReferenceNode*>(this);
    }
 
    DLLLOCAL static const char* getStaticTypeName() {
        return "call reference";
    }
 
protected:
 
    DLLLOCAL virtual QoreValue evalImpl(bool& needs_deref, ExceptionSink* xsink) const;
 
    DLLLOCAL AbstractCallReferenceNode(bool n_needs_eval, bool n_there_can_be_only_one,
            qore_type_t n_type = NT_FUNCREF);
 
private:
 
    DLLLOCAL virtual AbstractQoreNode* realCopy() const;
 
 
    DLLLOCAL virtual bool is_equal_soft(const AbstractQoreNode* v, ExceptionSink* xsink) const;
 
 
    DLLLOCAL virtual bool is_equal_hard(const AbstractQoreNode* v, ExceptionSink* xsink) const;
};
 
class QoreFunction;
 
class ResolvedCallReferenceNode : public AbstractCallReferenceNode {
public:
    DLLEXPORT ResolvedCallReferenceNode();
 
    DLLEXPORT virtual ~ResolvedCallReferenceNode();
 
    DLLLOCAL ResolvedCallReferenceNode(bool n_needs_eval, qore_type_t n_type = NT_FUNCREF);
 
 
    DLLLOCAL virtual QoreValue execValue(const QoreListNode* args, ExceptionSink* xsink) const = 0;
 
 
    DLLEXPORT virtual QoreProgram* getProgram() const;
 
    DLLLOCAL virtual QoreFunction* getFunction() = 0;
 
    DLLLOCAL ResolvedCallReferenceNode* refRefSelf() const {
        ref();
        return const_cast<ResolvedCallReferenceNode*>(this);
    }
 
    DLLEXPORT virtual bool is_equal_hard(const AbstractQoreNode *v, ExceptionSink *xsink) const;
 
    DLLEXPORT virtual bool is_equal_soft(const AbstractQoreNode *v, ExceptionSink *xsink) const;
 
    DLLEXPORT virtual AbstractQoreNode* realCopy() const;
 
    // must be defined but performs no action
    DLLEXPORT virtual int parseInit(QoreValue& val, QoreParseContext& parse_context);
 
    // the following function must be defined, but is never called
    DLLEXPORT virtual QoreValue evalImpl(bool& needs_deref, ExceptionSink* xsink) const;
 
    DLLLOCAL void weakRef() {
        weak_refs.ROreference();
    }
 
    DLLLOCAL void weakDeref() {
        if (weak_refs.ROdereference()) {
            delete this;
        }
    }
 
protected:
    QoreReferenceCounter weak_refs;
 
 
    DLLEXPORT virtual bool derefImpl(ExceptionSink* xsink);
};
 
class OptionalCallReferenceAccessHelper {
public:
    DLLEXPORT OptionalCallReferenceAccessHelper(ExceptionSink* xsink, ResolvedCallReferenceNode* ref);
 
    DLLLOCAL ~OptionalCallReferenceAccessHelper() {
        if (ref) {
            ref->deref(xsink);
        }
    }
 
    DLLLOCAL operator bool() const {
        return ref ? true : false;
    }
 
    DLLLOCAL const AbstractCallReferenceNode* operator*() const {
        return ref;
    }
 
    DLLLOCAL AbstractCallReferenceNode* operator*() {
        return ref;
    }
 
protected:
    ExceptionSink* xsink;
    ResolvedCallReferenceNode* ref;
};
 
#endif