#ifndef CSM_WOLRD_REGIONMAP_H
#define CSM_WOLRD_REGIONMAP_H

#include <map>
#include <string>
#include <utility>
#include <vector>

#include <QAbstractTableModel>
#include <QModelIndex>
#include <QVariant>

#include "cellcoordinates.hpp"
#include <components/esm/refid.hpp>

class QObject;

namespace CSMWorld
{
    class Data;
    struct Cell;

    template <typename ESXRecordT>
    struct Record;

    /// \brief Model for the region map
    ///
    /// This class does not holds any record data (other than for the purpose of buffering).
    class RegionMap : public QAbstractTableModel
    {
        Q_OBJECT

    public:
        enum Role
        {
            Role_Region = Qt::UserRole,
            Role_CellId = Qt::UserRole + 1
        };

    private:
        struct CellDescription
        {
            bool mDeleted;
            ESM::RefId mRegion;
            std::string mName;

            CellDescription();

            CellDescription(const Record<Cell>& cell);
        };

        Data& mData;
        std::map<CellCoordinates, CellDescription> mMap;
        CellCoordinates mMin; ///< inclusive
        CellCoordinates mMax; ///< exclusive
        std::map<ESM::RefId, unsigned int> mColours; ///< region ID, colour (RGBA)

        CellCoordinates getIndex(const QModelIndex& index) const;
        ///< Translates a Qt model index into a cell index (which can contain negative components)

        QModelIndex getIndex(const CellCoordinates& index) const;

        CellCoordinates getIndex(const Cell& cell) const;

        void buildRegions();

        void buildMap();

        void addCell(const CellCoordinates& index, const CellDescription& description);
        ///< May be called on a cell that is already in the map (in which case an update is
        // performed)

        void addCells(int start, int end);

        void removeCell(const CellCoordinates& index);
        ///< May be called on a cell that is not in the map (in which case the call is ignored)

        void addRegion(const ESM::RefId& region, unsigned int colour);
        ///< May be called on a region that is already listed (in which case an update is
        /// performed)
        ///
        /// \note This function does not update the region map.

        void removeRegion(const ESM::RefId& region);
        ///< May be called on a region that is not listed (in which case the call is ignored)
        ///
        /// \note This function does not update the region map.

        void updateRegions(const std::vector<ESM::RefId>& regions);
        ///< Update cells affected by the listed regions

        void updateSize();

        std::pair<CellCoordinates, CellCoordinates> getSize() const;

    public:
        RegionMap(Data& data);

        int rowCount(const QModelIndex& parent = QModelIndex()) const override;

        int columnCount(const QModelIndex& parent = QModelIndex()) const override;

        QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override;
        ///< \note Calling this function with role==Role_CellId may return the ID of a cell
        /// that does not exist.

        Qt::ItemFlags flags(const QModelIndex& index) const override;

    private slots:

        void regionsAboutToBeRemoved(const QModelIndex& parent, int start, int end);

        void regionsInserted(const QModelIndex& parent, int start, int end);

        void regionsChanged(const QModelIndex& topLeft, const QModelIndex& bottomRight);

        void cellsAboutToBeRemoved(const QModelIndex& parent, int start, int end);

        void cellsInserted(const QModelIndex& parent, int start, int end);

        void cellsChanged(const QModelIndex& topLeft, const QModelIndex& bottomRight);
    };
}

#endif