AbstractQoreNode.h

/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
    AbstractQoreNode.h

    Qore Programming Language

    Copyright (C) 2003 - 2018 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_ABSTRACTQORENODE_H

#define _QORE_ABSTRACTQORENODE_H

#include <qore/common.h>
#include <qore/QoreReferenceCounter.h>
#include <qore/node_types.h>

#include <string>

#include <cassert>

#define FMT_YAML_SHORT -2
#define FMT_NONE       -1
#define FMT_NORMAL      0

class LocalVar;


class AbstractQoreNode : public QoreReferenceCounter {
public:

    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);

    DLLEXPORT AbstractQoreNode(const AbstractQoreNode& v);


    DLLEXPORT bool getAsBool() const;


    DLLEXPORT int getAsInt() const;


    DLLEXPORT int64 getAsBigInt() const;


    DLLEXPORT double getAsFloat() const;


    DLLEXPORT virtual QoreString* getStringRepresentation(bool& del) const;


    DLLEXPORT virtual void getStringRepresentation(QoreString &str) const;


    DLLEXPORT virtual class DateTime* getDateTimeRepresentation(bool& del) const;


    DLLEXPORT virtual void getDateTimeRepresentation(DateTime &dt) const;


    DLLEXPORT virtual int getAsString(QoreString &str, int foff, ExceptionSink* xsink) const = 0;


    DLLEXPORT virtual QoreString *getAsString(bool& del, int foff, ExceptionSink* xsink) const = 0;


    DLLLOCAL bool needs_eval() const {
        return needs_eval_flag;
    }


    DLLEXPORT virtual AbstractQoreNode* realCopy() const = 0;


    DLLEXPORT virtual bool is_equal_soft(const AbstractQoreNode* v, ExceptionSink* xsink) const = 0;


    DLLEXPORT virtual bool is_equal_hard(const AbstractQoreNode* v, ExceptionSink* xsink) const = 0;


    DLLLOCAL qore_type_t getType() const {
        return type;
    }


    DLLEXPORT virtual const char* getTypeName() const = 0;


    DLLEXPORT QoreValue eval(ExceptionSink* xsink) const;


    DLLEXPORT QoreValue eval(bool& needs_deref, ExceptionSink* xsink) const;


    DLLLOCAL bool is_value() const {
        return value;
    }


    DLLEXPORT void deref(ExceptionSink* xsink);


    DLLEXPORT AbstractQoreNode* refSelf() const;

    DLLEXPORT void ref() const;

    DLLLOCAL bool isReferenceCounted() const { return !there_can_be_only_one; }


    DLLLOCAL virtual void parseInit(QoreValue& val, LocalVar* oflag, int pflag, int& lvids, const QoreTypeInfo*& typeInfo);

    DLLLOCAL AbstractQoreNode& operator=(const AbstractQoreNode&);


    DLLLOCAL virtual bool getAsBoolImpl() const { return false; }


    DLLLOCAL virtual int getAsIntImpl() const { return 0; }


    DLLLOCAL virtual int64 getAsBigIntImpl() const { return 0; }


    DLLLOCAL virtual double getAsFloatImpl() const { return 0.0; }


    DLLEXPORT virtual QoreValue evalImpl(bool& needs_deref, ExceptionSink* xsink) const = 0;


    DLLEXPORT virtual bool derefImpl(ExceptionSink* xsink);


    DLLEXPORT virtual void customRef() const;

    DLLEXPORT virtual void customDeref(ExceptionSink* xsink);

protected:

    qore_type_t type : 11;

    bool value : 1;

    bool needs_eval_flag : 1;

    bool there_can_be_only_one : 1;

    bool custom_reference_handlers : 1;


    DLLEXPORT virtual ~AbstractQoreNode();
};


class SimpleQoreNode : public AbstractQoreNode {
public:
    SimpleQoreNode& operator=(const SimpleQoreNode&) = delete;

    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) { }

    DLLLOCAL SimpleQoreNode(const SimpleQoreNode& v) : AbstractQoreNode(v) { }


    using AbstractQoreNode::deref;
    DLLEXPORT void deref();
};

class SimpleValueQoreNode : public SimpleQoreNode {
public:
    DLLLOCAL SimpleValueQoreNode(qore_type_t t, bool n_there_can_be_only_one = false) : SimpleQoreNode(t, true, false, n_there_can_be_only_one) { }

    DLLLOCAL SimpleValueQoreNode(const SimpleValueQoreNode& v) : SimpleQoreNode(v) { }

protected:

    DLLEXPORT virtual QoreValue evalImpl(bool& needs_deref, ExceptionSink* xsink) const;
};


class UniqueValueQoreNode : public SimpleValueQoreNode {
public:
    DLLLOCAL UniqueValueQoreNode& operator=(const UniqueValueQoreNode&) = delete;

    DLLLOCAL void *operator new(size_t) = delete;

    DLLLOCAL UniqueValueQoreNode(qore_type_t t) : SimpleValueQoreNode(t, true) { }

    DLLLOCAL UniqueValueQoreNode(const UniqueValueQoreNode& ) : SimpleValueQoreNode(type, true) { }

    DLLEXPORT virtual AbstractQoreNode* realCopy() const;
};

#endif