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

 *

 * Project:  ODS Translator

 * Purpose:  Definition of classes for OGR OpenOfficeSpreadsheet .ods driver.

 * Author:   Even Rouault, even dot rouault at spatialys.com

 *

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

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

 *

 * SPDX-License-Identifier: MIT

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

#ifndef OGR_ODS_H_INCLUDED

#define OGR_ODS_H_INCLUDED

#include "ogrsf_frmts.h"

#include "memdataset.h"

#include "ogr_expat.h"

#include <vector>

#include <string>

#include <set>

namespace OGRODS

{

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

/*                             OGRODSLayer                              */

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

class OGRODSDataSource;

class OGRODSLayer final : public OGRMemLayer

{

    OGRODSDataSource *poDS;

    bool bUpdated;

    bool bHasHeaderLine;

    OGRFeatureQuery *m_poAttrQueryODS;

    GIntBig TranslateFIDFromMemLayer(GIntBig nFID) const;

    GIntBig TranslateFIDToMemLayer(GIntBig nFID) const;

  public:

    OGRODSLayer(OGRODSDataSource *poDSIn, const char *pszName,

                bool bUpdateIn = FALSE);

    ~OGRODSLayer() override;

    void SetUpdated(bool bUpdatedIn = true);

    bool GetHasHeaderLine()

    {

        return bHasHeaderLine;

    }

    void SetHasHeaderLine(bool bIn)

    {

        bHasHeaderLine = bIn;

    }

    const char *GetName() const override

    {

        return OGRMemLayer::GetLayerDefn()->GetName();

    }

    OGRwkbGeometryType GetGeomType() const override

    {

        return wkbNone;

    }

    const OGRSpatialReference *GetSpatialRef() const override

    {

        return nullptr;

    }

    /* For external usage. Mess with FID */

    OGRFeature *GetNextFeature() override;

    OGRFeature *GetFeature(GIntBig nFeatureId) override;

    OGRErr ISetFeature(OGRFeature *poFeature) override;

    OGRErr ISetFeatureUniqPtr(std::unique_ptr<OGRFeature> poFeature) override;

    OGRErr IUpdateFeature(OGRFeature *poFeature, int nUpdatedFieldsCount,

                          const int *panUpdatedFieldsIdx,

                          int nUpdatedGeomFieldsCount,

                          const int *panUpdatedGeomFieldsIdx,

                          bool bUpdateStyleString) override;

    OGRErr DeleteFeature(GIntBig nFID) override;

    GIntBig GetFeatureCount(int) override;

    OGRErr SetAttributeFilter(const char *pszQuery) override;

    int TestCapability(const char *pszCap) const override;

    /* For internal usage, for cell resolver */

    OGRFeature *GetNextFeatureWithoutFIDHack()

    {

        return OGRMemLayer::GetNextFeature();

    }

    OGRErr SetFeatureWithoutFIDHack(OGRFeature *poFeature)

    {

        SetUpdated();

        return OGRMemLayer::ISetFeature(poFeature);

    }

    OGRErr ICreateFeature(OGRFeature *poFeature) override;

    OGRErr ICreateFeatureUniqPtr(std::unique_ptr<OGRFeature> poFeature,

                                 GIntBig *pnFID) override;

    virtual OGRErr CreateField(const OGRFieldDefn *poField,

                               int bApproxOK = TRUE) override

    {

        SetUpdated();

        return OGRMemLayer::CreateField(poField, bApproxOK);

    }

    OGRErr DeleteField(int iField) override

    {

        SetUpdated();

        return OGRMemLayer::DeleteField(iField);

    }

    OGRErr ReorderFields(int *panMap) override

    {

        SetUpdated();

        return OGRMemLayer::ReorderFields(panMap);

    }

    virtual OGRErr AlterFieldDefn(int iField, OGRFieldDefn *poNewFieldDefn,

                                  int nFlagsIn) override

    {

        SetUpdated();

        return OGRMemLayer::AlterFieldDefn(iField, poNewFieldDefn, nFlagsIn);

    }

    OGRErr SyncToDisk() override;

    GDALDataset *GetDataset() override;

};

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

/*                           OGRODSDataSource                           */

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

#define STACK_SIZE 5

typedef enum

{

    STATE_DEFAULT,

    STATE_TABLE,

    STATE_ROW,

    STATE_CELL,

    STATE_TEXTP,

} HandlerStateEnum;

typedef struct

{

    HandlerStateEnum eVal;

    int nBeginDepth;

} HandlerState;

class OGRODSDataSource final : public GDALDataset

{

    char *pszName;

    bool bUpdatable;

    bool bUpdated;

    bool bAnalysedFile;

    int nLayers;

    OGRLayer **papoLayers;

    VSILFILE *fpSettings;

    std::string osCurrentConfigTableName;

    std::string osConfigName;

    int nVerticalSplitFlags;

    std::set<std::string> osSetLayerHasSplitter;

    void AnalyseSettings();

    VSILFILE *fpContent;

    void AnalyseFile();

    bool bFirstLineIsHeaders;

    int bAutodetectTypes;

    XML_Parser oParser;

    bool bStopParsing;

    int nWithoutEventCounter;

    int nDataHandlerCounter;

    int nCurLine;

    int nEmptyRowsAccumulated;

    int nRowsRepeated;

    int nCurCol;

    int nCellsRepeated;

    // Accumulated memory allocations related to repeated cells.

    size_t m_nAccRepeatedMemory = 0;

    bool bEndTableParsing;

    OGRODSLayer *poCurLayer;

    int nStackDepth;

    int nDepth;

    HandlerState stateStack[STACK_SIZE];

    CPLString osValueType;

    CPLString osValue;

    bool m_bValueFromTableCellAttribute = false;

    std::string osFormula;

    std::vector<std::string> apoFirstLineValues;

    std::vector<std::string> apoFirstLineTypes;

    std::vector<std::string> apoCurLineValues;

    std::vector<std::string> apoCurLineTypes;

    void PushState(HandlerStateEnum eVal);

    void startElementDefault(const char *pszName, const char **ppszAttr);

    void startElementTable(const char *pszName, const char **ppszAttr);

    void endElementTable(const char *pszName);

    void startElementRow(const char *pszName, const char **ppszAttr);

    void endElementRow(const char *pszName);

    void startElementCell(const char *pszName, const char **ppszAttr);

    void endElementCell(const char *pszName);

    void dataHandlerTextP(const char *data, int nLen);

    void DetectHeaderLine();

    OGRFieldType GetOGRFieldType(const char *pszValue, const char *pszValueType,

                                 OGRFieldSubType &eSubType);

    void DeleteLayer(const char *pszLayerName);

    void FillRepeatedCells(bool wasLastCell);

  public:

    explicit OGRODSDataSource(CSLConstList papszOpenOptionsIn);

    ~OGRODSDataSource() override;

    CPLErr Close(GDALProgressFunc = nullptr, void * = nullptr) override;

    int Open(const char *pszFilename, VSILFILE *fpContentIn,

             VSILFILE *fpSettingsIn, int bUpdatableIn);

    int Create(const char *pszName, CSLConstList papszOptions);

    int GetLayerCount() const override;

    const OGRLayer *GetLayer(int) const override;

    int TestCapability(const char *) const override;

    OGRLayer *ICreateLayer(const char *pszName,

                           const OGRGeomFieldDefn *poGeomFieldDefn,

                           CSLConstList papszOptions) override;

    OGRErr DeleteLayer(int iLayer) override;

    CPLErr FlushCache(bool bAtClosing) override;

    void startElementCbk(const char *pszName, const char **ppszAttr);

    void endElementCbk(const char *pszName);

    void dataHandlerCbk(const char *data, int nLen);

    void startElementStylesCbk(const char *pszName, const char **ppszAttr);

    void endElementStylesCbk(const char *pszName);

    void dataHandlerStylesCbk(const char *data, int nLen);

    bool GetUpdatable()

    {

        return bUpdatable;

    }

    void SetUpdated()

    {

        bUpdated = true;

    }

};

}  // namespace OGRODS

#endif /* ndef OGR_ODS_H_INCLUDED */