/******************************************************************************

 *

 * Project:  PCIDSK Database File

 * Purpose:  Read/write PCIDSK Database File used by the PCI software, using

 *           the external PCIDSK library.

 * Author:   Frank Warmerdam, warmerdam@pobox.com

 *

 ******************************************************************************

 * Copyright (c) 2009, Frank Warmerdam <warmerdam@pobox.com>

 * Copyright (c) 2009-2013, Even Rouault <even dot rouault at spatialys.com>

 *

 * SPDX-License-Identifier: MIT

 ****************************************************************************/

#ifndef PCIDSKDATASET2_H_INCLUDED

#define PCIDSKDATASET2_H_INCLUDED

#define GDAL_PCIDSK_DRIVER

#include "cpl_string.h"

#include "gdal_pam.h"

#include "ogrsf_frmts.h"

#include "ogr_spatialref.h"

#include "pcidsk.h"

#include "pcidsk_pct.h"

#include "pcidsk_vectorsegment.h"

#include <unordered_map>

using namespace PCIDSK;

class OGRPCIDSKLayer;

/************************************************************************/

/*                            PCIDSK2Dataset                            */

/************************************************************************/

class PCIDSK2Dataset final : public GDALPamDataset

{

    friend class PCIDSK2Band;

    mutable OGRSpatialReference *m_poSRS = nullptr;

    std::unordered_map<std::string, std::string> m_oCacheMetadataItem{};

    char **papszLastMDListValue;

    PCIDSK::PCIDSKFile *poFile;

    std::vector<OGRPCIDSKLayer *> apoLayers;

    static GDALDataType PCIDSKTypeToGDAL(PCIDSK::eChanType eType);

    void ProcessRPC();

    const OGRSpatialReference *GetSpatialRef(bool bRasterOnly) const;

  public:

    PCIDSK2Dataset();

    ~PCIDSK2Dataset() override;

    static GDALDataset *Open(GDALOpenInfo *);

    static GDALDataset *LLOpen(const char *pszFilename, PCIDSK::PCIDSKFile *,

                               GDALAccess eAccess,

                               char **papszSiblingFiles = nullptr);

    static GDALDataset *Create(const char *pszFilename, int nXSize, int nYSize,

                               int nBands, GDALDataType eType,

                               CSLConstList papszParamList);

    char **GetFileList() override;

    CPLErr GetGeoTransform(GDALGeoTransform &gt) const override;

    CPLErr SetGeoTransform(const GDALGeoTransform &gt) override;

    const OGRSpatialReference *GetSpatialRef() const override;

    const OGRSpatialReference *GetSpatialRefRasterOnly() const override;

    CPLErr SetSpatialRef(const OGRSpatialReference *poSRS) override;

    char **GetMetadataDomainList() override;

    CPLErr SetMetadata(CSLConstList, const char *) override;

    CSLConstList GetMetadata(const char *) override;

    CPLErr SetMetadataItem(const char *, const char *, const char *) override;

    const char *GetMetadataItem(const char *, const char *) override;

    CPLErr FlushCache(bool bAtClosing) override;

    CPLErr IBuildOverviews(const char *, int, const int *, int, const int *,

                           GDALProgressFunc, void *,

                           CSLConstList papszOptions) override;

    int GetLayerCount() const override

    {

        return (int)apoLayers.size();

    }

    const OGRLayer *GetLayer(int) const override;

    int TestCapability(const char *) const override;

    OGRLayer *ICreateLayer(const char *pszName,

                           const OGRGeomFieldDefn *poGeomFieldDefn,

                           CSLConstList papszOptions) override;

};

/************************************************************************/

/*                             PCIDSK2Band                              */

/************************************************************************/

class PCIDSK2Band final : public GDALPamRasterBand

{

    friend class PCIDSK2Dataset;

    PCIDSK::PCIDSKChannel *poChannel;

    PCIDSK::PCIDSKFile *poFile;

    void RefreshOverviewList();

    std::vector<PCIDSK2Band *> apoOverviews;

    std::unordered_map<std::string, std::string> m_oCacheMetadataItem{};

    char **papszLastMDListValue;

    bool CheckForColorTable();

    GDALColorTable *poColorTable;

    bool bCheckedForColorTable;

    int nPCTSegNumber;

    char **papszCategoryNames;

    void Initialize();

  public:

    PCIDSK2Band(PCIDSK::PCIDSKFile *poFileIn,

                PCIDSK::PCIDSKChannel *poChannelIn);

    explicit PCIDSK2Band(PCIDSK::PCIDSKChannel *);

    ~PCIDSK2Band() override;

    CPLErr IReadBlock(int, int, void *) override;

    CPLErr IWriteBlock(int, int, void *) override;

    int GetOverviewCount() override;

    GDALRasterBand *GetOverview(int) override;

    GDALColorInterp GetColorInterpretation() override;

    GDALColorTable *GetColorTable() override;

    CPLErr SetColorTable(GDALColorTable *) override;

    void SetDescription(const char *) override;

    char **GetMetadataDomainList() override;

    CPLErr SetMetadata(CSLConstList, const char *) override;

    CSLConstList GetMetadata(const char *) override;

    CPLErr SetMetadataItem(const char *, const char *, const char *) override;

    const char *GetMetadataItem(const char *, const char *) override;

    double GetNoDataValue(int *) override;

    CPLErr SetNoDataValue(double dfNoData) override;

    char **GetCategoryNames() override;

};

/************************************************************************/

/*                            OGRPCIDSKLayer                            */

/************************************************************************/

class OGRPCIDSKLayer final : public OGRLayer,

                             public OGRGetNextFeatureThroughRaw<OGRPCIDSKLayer>

{

    GDALDataset *m_poDS = nullptr;

    PCIDSK::PCIDSKVectorSegment *poVecSeg;

    PCIDSK::PCIDSKSegment *poSeg;

    OGRFeatureDefn *poFeatureDefn;

    OGRFeature *GetNextRawFeature();

    int iRingStartField;

    PCIDSK::ShapeId hLastShapeId;

    bool bUpdateAccess;

    OGRSpatialReference *poSRS;

    std::unordered_map<std::string, int> m_oMapFieldNameToIdx{};

    bool m_bEOF = false;

  public:

    OGRPCIDSKLayer(GDALDataset *poDS, PCIDSK::PCIDSKSegment *,

                   PCIDSK::PCIDSKVectorSegment *, bool bUpdate);

    ~OGRPCIDSKLayer() override;

    void ResetReading() override;

    DEFINE_GET_NEXT_FEATURE_THROUGH_RAW(OGRPCIDSKLayer)

    OGRFeature *GetFeature(GIntBig nFeatureId) override;

    OGRErr ISetFeature(OGRFeature *poFeature) override;

    const OGRFeatureDefn *GetLayerDefn() const override

    {

        return poFeatureDefn;

    }

    int TestCapability(const char *) const override;

    OGRErr DeleteFeature(GIntBig nFID) override;

    OGRErr ICreateFeature(OGRFeature *poFeature) override;

    virtual OGRErr CreateField(const OGRFieldDefn *poField,

                               int bApproxOK = TRUE) override;

    GIntBig GetFeatureCount(int) override;

    OGRErr IGetExtent(int iGeomField, OGREnvelope *psExtent,

                      bool bForce) override;

    GDALDataset *GetDataset() override

    {

        return m_poDS;

    }

};

#endif /*  PCIDSKDATASET2_H_INCLUDED */