QoreHashNode.h

/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
    QoreHashNode.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_QOREHASHNODE_H

#define _QORE_QOREHASHNODE_H

#include <qore/AbstractQoreNode.h>
#include <qore/common.h>

class LocalVar;
class QoreString;
class TypedHashDecl;


class QoreHashNode : public AbstractQoreNode {
    friend class HashIterator;
    friend class ReverseHashIterator;
    friend class ConstHashIterator;
    friend class ReverseConstHashIterator;
    friend class HashAssignmentHelper;
    friend class hash_assignment_priv;
    friend class qore_object_private;
    friend class qore_hash_private;

private:
    DLLLOCAL QoreHashNode(const QoreHashNode&);

    DLLLOCAL QoreHashNode& operator=(const QoreHashNode&);

protected:
    class qore_hash_private *priv;


    DLLEXPORT virtual bool derefImpl(ExceptionSink* xsink);


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


    DLLEXPORT virtual ~QoreHashNode();

public:
    DLLEXPORT QoreHashNode();


    DLLEXPORT QoreHashNode(const TypedHashDecl* hd, ExceptionSink* xsink);


    DLLEXPORT QoreHashNode(const QoreTypeInfo* valueTypeInfo);


    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 AbstractQoreNode* realCopy() const;


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


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


    DLLEXPORT virtual const char* getTypeName() const;


    DLLEXPORT QoreHashNode* hashRefSelf() const;


    DLLEXPORT const char* getFirstKey() const;


    DLLEXPORT const char* getLastKey() const;


    DLLEXPORT QoreValue getKeyValueExistence(const char* key, bool& exists, ExceptionSink* xsink) const;


    DLLEXPORT QoreValue getKeyValueExistence(const char* key, bool& exists) const;


    DLLEXPORT QoreValue getKeyValue(const char* key, ExceptionSink* xsink) const;


    DLLEXPORT QoreValue getKeyValue(const char* key) const;


    DLLEXPORT QoreValue getKeyValueExistence(const QoreString& key, bool& exists, ExceptionSink* xsink) const;


    DLLEXPORT QoreValue getKeyValueExistence(const QoreString& key, bool& exists) const;


    DLLEXPORT QoreValue getKeyValue(const QoreString& key, ExceptionSink* xsink) const;


    DLLEXPORT int64 getKeyAsBigInt(const char* key, bool &found) const;


    DLLEXPORT bool getKeyAsBool(const char* key, bool &found) const;


    DLLEXPORT QoreHashNode* copy() const;

    DLLEXPORT QoreValue& getKeyValueReference(const char* key);


    DLLEXPORT void merge(const QoreHashNode* h, ExceptionSink* xsink);


    DLLEXPORT int setKeyValue(const char* key, QoreValue value, ExceptionSink* xsink);


    DLLEXPORT int setKeyValue(const QoreString& key, QoreValue value, ExceptionSink* xsink);


    DLLEXPORT void deleteKey(const QoreString* key, ExceptionSink* xsink);


    DLLEXPORT void deleteKey(const char* key, ExceptionSink* xsink);

    DLLEXPORT QoreValue takeKeyValue(const char* key);


    DLLEXPORT QoreListNode* getKeys() const;


    DLLEXPORT QoreListNode* getValues() const;


    DLLEXPORT bool compareSoft(const QoreHashNode* h, ExceptionSink* xsink) const;


    DLLEXPORT bool compareHard(const QoreHashNode* h, ExceptionSink* xsink) const;


    DLLEXPORT qore_size_t size() const;


    DLLEXPORT bool empty() const;


    DLLEXPORT bool existsKey(const char* key) const;


    DLLEXPORT bool existsKeyValue(const char* key) const;


    DLLEXPORT void removeKey(const QoreString* key, ExceptionSink* xsink);


    DLLEXPORT void removeKey(const char* key, ExceptionSink* xsink);


    DLLEXPORT const TypedHashDecl* getHashDecl() const;


    DLLEXPORT const QoreTypeInfo* getValueTypeInfo() const;


    DLLEXPORT const QoreTypeInfo* getTypeInfo() const;


    DLLLOCAL static const char* getStaticTypeName() {
        return "hash";
    }

    DLLLOCAL static qore_type_t getStaticTypeCode() {
        return NT_HASH;
    }

    static const qore_type_t TYPE = NT_HASH;

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

    DLLLOCAL QoreHashNode(bool ne);
    DLLLOCAL void clear(ExceptionSink* xsink, bool reverse = false);

    DLLLOCAL void clearNeedsEval();

    DLLLOCAL void setNeedsEval();

    // returns a new hash consisting of just the members of value_list
    DLLLOCAL QoreHashNode* getSlice(const QoreListNode* value_list, ExceptionSink* xsink) const;
};

#include <qore/ReferenceHolder.h>


typedef ReferenceHolder<QoreHashNode> QoreHashNodeHolder;

class qhi_priv;


class HashIterator {
    friend class HashAssignmentHelper;
    friend class qhi_priv;

protected:
    QoreHashNode* h;
    qhi_priv* priv;

    DLLLOCAL HashIterator(const HashIterator&);

    DLLLOCAL HashIterator& operator=(const HashIterator&);

    DLLLOCAL void* operator new(size_t);

public:
    DLLEXPORT HashIterator(QoreHashNode* h);

    DLLEXPORT HashIterator(QoreHashNode& h);

    DLLEXPORT ~HashIterator();


    DLLEXPORT bool next();


    DLLEXPORT bool prev();

    DLLEXPORT const char* getKey() const;

    DLLEXPORT QoreString* getKeyString() const;

    DLLEXPORT QoreValue get() const;

    DLLEXPORT const QoreTypeInfo* getTypeInfo() const;


    DLLEXPORT void deleteKey(ExceptionSink* xsink);

    DLLEXPORT QoreValue removeKeyValue();

    DLLEXPORT QoreValue getReferenced() const;

    DLLEXPORT QoreHashNode* getHash() const;

    DLLEXPORT bool first() const;

    DLLEXPORT bool last() const;

    DLLEXPORT bool empty() const;

    DLLEXPORT bool valid() const;
};


class ReverseHashIterator : public HashIterator {
public:
   DLLEXPORT ReverseHashIterator(QoreHashNode* h);

   DLLEXPORT ReverseHashIterator(QoreHashNode& h);

   DLLEXPORT ~ReverseHashIterator();


   DLLEXPORT bool next();


   DLLEXPORT bool prev();

   DLLEXPORT bool first() const;

   DLLEXPORT bool last() const;
};


class ConstHashIterator {
protected:
    const QoreHashNode* h;
    qhi_priv* priv;

    DLLLOCAL ConstHashIterator& operator=(const HashIterator&);

public:
    DLLEXPORT ConstHashIterator(const QoreHashNode* h);

    DLLEXPORT ConstHashIterator(const QoreHashNode& h);

    DLLLOCAL ConstHashIterator(const ConstHashIterator&);

    DLLEXPORT ~ConstHashIterator();


    DLLEXPORT bool next();


    DLLEXPORT bool prev();

    DLLEXPORT const char* getKey() const;

    DLLEXPORT QoreString* getKeyString() const;

    DLLEXPORT const QoreValue get() const;

    DLLEXPORT const QoreTypeInfo* getTypeInfo() const;

    DLLEXPORT QoreValue getReferenced() const;

    DLLEXPORT const QoreHashNode* getHash() const;

    DLLEXPORT bool first() const;

    DLLEXPORT bool last() const;

    DLLEXPORT bool empty() const;

    DLLEXPORT bool valid() const;

    DLLEXPORT void reset();
};


class ReverseConstHashIterator : public ConstHashIterator {
public:
   DLLEXPORT ReverseConstHashIterator(const QoreHashNode* h);

   DLLEXPORT ReverseConstHashIterator(const QoreHashNode& h);

   DLLEXPORT ~ReverseConstHashIterator();


   DLLEXPORT bool next();


   DLLEXPORT bool prev();

   DLLEXPORT bool first() const;

   DLLEXPORT bool last() const;
};

class HashAssignmentHelper {
friend class hash_assignment_priv;
public:

    DLLEXPORT HashAssignmentHelper(QoreHashNode& n_h, const char* key, bool must_already_exist = false);


    DLLEXPORT HashAssignmentHelper(QoreHashNode& n_h, const std::string& key, bool must_already_exist = false);


    DLLEXPORT HashAssignmentHelper(ExceptionSink* xsink, QoreHashNode& n_h, const QoreString& key, bool must_already_exist = false);


    DLLEXPORT HashAssignmentHelper(ExceptionSink* xsink, QoreHashNode& n_h, const QoreString* key, bool must_already_exist = false);


    DLLEXPORT HashAssignmentHelper(HashIterator &hi);

    DLLEXPORT ~HashAssignmentHelper();


    DLLEXPORT void reassign(const char* key, bool must_already_exist = false);


    DLLEXPORT void reassign(const std::string& key, bool must_already_exist = false);


    DLLEXPORT operator bool() const;


    DLLEXPORT void assign(QoreValue v, ExceptionSink* xsink);


    DLLEXPORT QoreValue swap(QoreValue v, ExceptionSink* xsink);


    DLLEXPORT QoreValue get() const;


    DLLEXPORT QoreValue operator*() const;

protected:
    class hash_assignment_priv *priv;

private:
    DLLLOCAL HashAssignmentHelper(const HashAssignmentHelper&) = delete;
    DLLLOCAL HashAssignmentHelper& operator=(const HashAssignmentHelper&) = delete;
    DLLLOCAL void* operator new(size_t) = delete;
};

#endif // _QORE_HASH_H