QoreListNode.h

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

#define _QORE_QORELISTNODE_H

#include <qore/AbstractQoreNode.h>

#ifdef min
#undef min
#endif
#ifdef max
#undef max
#endif

class ResolvedCallReferenceNode;


class QoreListNode : public AbstractQoreNode {
    friend class StackList;
    friend hashdecl qore_list_private;

private:
    DLLLOCAL QoreListNode(const QoreListNode&);

    DLLLOCAL QoreListNode& operator=(const QoreListNode&);

protected:

    hashdecl qore_list_private *priv;


    DLLEXPORT virtual ~QoreListNode();


    DLLEXPORT virtual bool derefImpl(ExceptionSink* xsink);


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

public:
    DLLEXPORT QoreListNode();

    DLLEXPORT QoreListNode(const QoreTypeInfo* valueTypeInfo);


    DLLEXPORT virtual bool getAsBoolImpl() const;


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


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

    //DLLEXPORT virtual bool needs_eval() 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 virtual bool is_value() const;

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

    DLLEXPORT QoreValue& getEntryReference(size_t index);


    DLLEXPORT QoreValue retrieveEntry(size_t index);


    DLLEXPORT const QoreValue retrieveEntry(size_t index) const;


    DLLEXPORT QoreValue getReferencedEntry(size_t index) const;


    DLLEXPORT int getEntryAsInt(size_t index) const;


    DLLEXPORT int setEntry(size_t index, QoreValue val, ExceptionSink* xsink);


    DLLEXPORT int push(QoreValue val, ExceptionSink* xsink);


    DLLEXPORT int insert(QoreValue val, ExceptionSink* xsink);


    DLLEXPORT QoreValue pop();


    DLLEXPORT QoreValue shift();


    DLLEXPORT int merge(const QoreListNode* list, ExceptionSink* xsink);


    DLLEXPORT QoreListNode* evalList(ExceptionSink* xsink) const;


    DLLEXPORT QoreListNode* evalList(bool &needs_deref, ExceptionSink* xsink) const;

    DLLEXPORT QoreListNode* copy() const;


    DLLEXPORT QoreListNode* copyListFrom(size_t index) const;


    DLLEXPORT QoreListNode* sort(ExceptionSink* xsink) const;


    DLLEXPORT QoreListNode* sort(const ResolvedCallReferenceNode* fr, ExceptionSink* xsink) const;


    DLLEXPORT QoreListNode* sortStable(ExceptionSink* xsink) const;


    DLLEXPORT QoreListNode* sortStable(const ResolvedCallReferenceNode* fr, ExceptionSink* xsink) const;


    DLLEXPORT QoreListNode* sortDescending(ExceptionSink* xsink) const;


    DLLEXPORT QoreListNode* sortDescending(const ResolvedCallReferenceNode* fr, ExceptionSink* xsink) const;


    DLLEXPORT QoreListNode* sortDescendingStable(ExceptionSink* xsink) const;


    DLLEXPORT QoreListNode* sortDescendingStable(const ResolvedCallReferenceNode* fr, ExceptionSink* xsink) const;


    DLLEXPORT QoreValue min(ExceptionSink* xsink) const;


    DLLEXPORT QoreValue max(ExceptionSink* xsink) const;


    DLLEXPORT QoreValue min(const ResolvedCallReferenceNode* fr, ExceptionSink* xsink) const;


    DLLEXPORT QoreValue max(const ResolvedCallReferenceNode* fr, ExceptionSink* xsink) const;


    DLLEXPORT QoreListNode* splice(qore_offset_t offset);


    DLLEXPORT QoreListNode* splice(qore_offset_t offset, qore_offset_t length);


    DLLEXPORT QoreListNode* splice(qore_offset_t offset, qore_offset_t length, const QoreValue l, ExceptionSink* xsink);


    DLLEXPORT QoreListNode* extract(qore_offset_t offset);


    DLLEXPORT QoreListNode* extract(qore_offset_t offset, qore_offset_t length);


    DLLEXPORT QoreListNode* extract(qore_offset_t offset, qore_offset_t length, const QoreValue l, ExceptionSink* xsink);


    DLLEXPORT size_t size() const;


    DLLEXPORT bool empty() const;

    DLLEXPORT QoreListNode* reverse() const;

    DLLEXPORT QoreListNode* listRefSelf() const;


    DLLEXPORT const QoreTypeInfo* getValueTypeInfo() const;


    DLLEXPORT const QoreTypeInfo* getTypeInfo() const;

    // needed only while parsing
    DLLLOCAL QoreListNode(bool i);

    DLLLOCAL bool isFinalized() const;

    DLLLOCAL void setFinalized();

    DLLLOCAL bool isVariableList() const;

    DLLLOCAL void setVariableList();

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

#include <qore/ReferenceHolder.h>


typedef ReferenceHolder<QoreListNode> QoreListNodeHolder;


class ListIterator {
protected:
    QoreListNode* l;
    qore_offset_t pos;

    DLLLOCAL void *operator new(size_t);

public:

    DLLEXPORT ListIterator(QoreListNode* lst, size_t n_pos = -1);


    DLLEXPORT ListIterator(QoreListNode& lst, size_t n_pos = -1);


    DLLEXPORT bool next();


    DLLEXPORT bool prev();


    DLLEXPORT int set(size_t n_pos);


    DLLEXPORT QoreValue getReferencedValue() const;


    DLLEXPORT QoreValue getValue() const;

    DLLEXPORT bool first() const;

    DLLEXPORT bool last() const;

    DLLLOCAL size_t index() const { return pos; }

    DLLLOCAL size_t max() const { return l->size(); }

    DLLLOCAL QoreListNode* getList() { return l; }

    DLLLOCAL bool empty() const {
        return l->empty();
    }

    DLLLOCAL bool valid() const {
        return pos == -1 ? false : true;
    }
};


class ConstListIterator {
protected:
    const QoreListNode* l;
    qore_offset_t pos;

public:

    DLLEXPORT ConstListIterator(const QoreListNode* lst, size_t n_pos = -1);


    DLLEXPORT ConstListIterator(const QoreListNode& lst, size_t n_pos = -1);


    DLLEXPORT bool next();


    DLLEXPORT bool prev();


    DLLEXPORT int set(size_t n_pos);


    DLLEXPORT QoreValue getReferencedValue() const;


    DLLEXPORT const QoreValue getValue() const;

    DLLEXPORT bool first() const;

    DLLEXPORT bool last() const;

    DLLLOCAL size_t index() const { return pos; }

    DLLLOCAL size_t max() const { return l->size(); }

    DLLLOCAL const QoreListNode* getList() const { return l; }

    DLLLOCAL bool empty() const {
        return l->empty();
    }

    DLLLOCAL bool valid() const {
        return pos == -1 ? false : true;
    }

    DLLEXPORT void reset();
};

#endif