deck_list_node_tree.h

Go to the documentation of this file.

#ifndef COCKATRICE_DECKLIST_NODE_TREE_H
#define COCKATRICE_DECKLIST_NODE_TREE_H
 
#include "tree/deck_list_card_node.h"
#include "tree/inner_deck_list_node.h"
 
#include <QList>
#include <QSet>
#include <QString>
#include <functional>
 
class AbstractDecklistNode;
class QXmlStreamReader;
class QXmlStreamWriter;
 
class DecklistNodeTree
{
    InnerDecklistNode *root; 
    int totalCards = 0;
 
public:
    explicit DecklistNodeTree();
    explicit DecklistNodeTree(const DecklistNodeTree &other);
    DecklistNodeTree &operator=(const DecklistNodeTree &other);
 
    virtual ~DecklistNodeTree();

    InnerDecklistNode *getRoot() const
    {
        return root;
    }
 
    bool isEmpty() const;

    void clear();

    QList<const DecklistCardNode *> getCardNodes(const QSet<QString> &restrictToZones = {}) const;

    QList<const InnerDecklistNode *> getZoneNodes(const QSet<QString> &restrictToZones = {}) const;

    QString computeDeckHash() const;

    void write(QXmlStreamWriter *xml) const;

    void readZoneElement(QXmlStreamReader *xml);
 
    DecklistCardNode *addCard(const QString &cardName,
                              int amount,
                              const QString &zoneName,
                              int position,
                              const QString &cardSetName = QString(),
                              const QString &cardSetCollectorNumber = QString(),
                              const QString &cardProviderId = QString(),
                              const bool formatLegal = true);
    bool deleteNode(AbstractDecklistNode *node, InnerDecklistNode *rootNode = nullptr);

    InnerDecklistNode *addCustomZone(const QString &boardZoneName, const QString &zoneName);

    bool renameCustomZone(const QString &oldZoneName, const QString &newZoneName);

    bool moveCustomZone(const QString &zoneName, const QString &newBoardZoneName);

    bool removeCustomZone(const QString &zoneName);

    QList<const InnerDecklistNode *> getCustomZones(const QString &boardZoneName) const;

    bool hasZoneName(const QString &zoneName) const;

    InnerDecklistNode *findCustomZoneByName(const QString &zoneName) const;

    void forEachCard(const std::function<void(InnerDecklistNode *, DecklistCardNode *)> &func) const;
 
private:
    // Helpers for traversing the tree
    InnerDecklistNode *getZoneObjFromName(const QString &zoneName);
    InnerDecklistNode *findBoardZone(const QString &boardZoneName) const;
    InnerDecklistNode *findOrCreateBoardZone(const QString &boardZoneName);

    void pruneEmptyBoardZone(InnerDecklistNode *container);
};
 
#endif // COCKATRICE_DECKLIST_NODE_TREE_H