openmw/apps/opencs/model/world/idtable.hpp

#ifndef CSM_WOLRD_IDTABLE_H
#define CSM_WOLRD_IDTABLE_H

#include <QModelIndex>
#include <QVariant>

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

#include "columns.hpp"
#include "idtablebase.hpp"
#include "universalid.hpp"

class QObject;

namespace CSMWorld
{
    class CollectionBase;
    struct RecordBase;

    class IdTable : public IdTableBase
    {
        Q_OBJECT

    private:
        CollectionBase* mIdCollection;

        // not implemented
        IdTable(const IdTable&);
        IdTable& operator=(const IdTable&);

    public:
        IdTable(CollectionBase* idCollection, unsigned int features = 0);
        ///< The ownership of \a idCollection is not transferred.

        virtual ~IdTable() = default;

        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;

        QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;

        bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole) override;

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

        bool removeRows(int row, int count, const QModelIndex& parent = QModelIndex()) override;

        QModelIndex index(int row, int column, const QModelIndex& parent = QModelIndex()) const override;

        QModelIndex parent(const QModelIndex& index) const override;

        void addRecord(const std::string& id, UniversalId::Type type = UniversalId::Type_None);
        ///< \param type Will be ignored, unless the collection supports multiple record types

        void addRecordWithData(const std::string& id, const std::map<int, QVariant>& data,
            UniversalId::Type type = UniversalId::Type_None);
        ///< \param type Will be ignored, unless the collection supports multiple record types

        void cloneRecord(
            const ESM::RefId& origin, const ESM::RefId& destination, UniversalId::Type type = UniversalId::Type_None);

        bool touchRecord(const std::string& id);
        ///< Will change the record state to modified, if it is not already.

        std::string getId(int row) const;

        QModelIndex getModelIndex(const std::string& id, int column) const override;

        void setRecord(
            const std::string& id, std::unique_ptr<RecordBase> record, UniversalId::Type type = UniversalId::Type_None);
        ///< Add record or overwrite existing record.

        const RecordBase& getRecord(const std::string& id) const;

        int searchColumnIndex(Columns::ColumnId id) const override;
        ///< Return index of column with the given \a id. If no such column exists, -1 is returned.

        int findColumnIndex(Columns::ColumnId id) const override;
        ///< Return index of column with the given \a id. If no such column exists, an exception is
        /// thrown.

        void reorderRows(int baseIndex, const std::vector<int>& newOrder);
        ///< Reorder the rows [baseIndex, baseIndex+newOrder.size()) according to the indices
        /// given in \a newOrder (baseIndex+newOrder[0] specifies the new index of row baseIndex).

        std::pair<UniversalId, std::string> view(int row) const override;
        ///< Return the UniversalId and the hint for viewing \a row. If viewing is not
        /// supported by this table, return (UniversalId::Type_None, "").

        /// Is \a id flagged as deleted?
        bool isDeleted(const std::string& id) const override;

        int getColumnId(int column) const override;

    protected:
        virtual CollectionBase* idCollection() const;
    };

    /// An IdTable customized to handle the more unique needs of LandTextureId's which behave
    /// differently from other records. The major difference is that base records cannot be
    /// modified.
    class LandTextureIdTable : public IdTable
    {
    public:
        struct ImportResults
        {
            using StringPair = std::pair<std::string, std::string>;

            /// The newly added records
            std::vector<std::string> createdRecords;
            /// The 1st string is the original id, the 2nd is the mapped id
            std::vector<StringPair> recordMapping;
        };

        LandTextureIdTable(CollectionBase* idCollection, unsigned int features = 0);

        /// Finds and maps/recreates the specified ids.
        ImportResults importTextures(const std::vector<std::string>& ids);
    };
}

#endif