ogr_wkb.h

/******************************************************************************
 *
 * Project:  OGR
 * Purpose:  WKB geometry related methods
 * Author:   Even Rouault <even dot rouault at spatialys.com>
 *
 ******************************************************************************
 * Copyright (c) 2022, Even Rouault <even dot rouault at spatialys.com>
 *
 * SPDX-License-Identifier: MIT
 ****************************************************************************/
 
#ifndef OGR_WKB_H_INCLUDED
#define OGR_WKB_H_INCLUDED
 
#include <cstdint>
 
#include "cpl_port.h"
#include "ogr_core.h"
 
#include <vector>
 
bool CPL_DLL OGRWKBGetGeomType(const GByte *pabyWkb, size_t nWKBSize,
                               bool &bNeedSwap, uint32_t &nType);
bool OGRWKBPolygonGetArea(const GByte *&pabyWkb, size_t &nWKBSize,
                          double &dfArea);
bool OGRWKBMultiPolygonGetArea(const GByte *&pabyWkb, size_t &nWKBSize,
                               double &dfArea);
 
bool CPL_DLL OGRWKBGetBoundingBox(const GByte *pabyWkb, size_t nWKBSize,
                                  OGREnvelope3D &sEnvelope);
 
bool CPL_DLL OGRWKBGetBoundingBox(const GByte *pabyWkb, size_t nWKBSize,
                                  OGREnvelope &sEnvelope);
 
bool CPL_DLL OGRWKBIntersectsPessimistic(const GByte *pabyWkb, size_t nWKBSize,
                                         const OGREnvelope &sEnvelope);
 
void CPL_DLL OGRWKBFixupCounterClockWiseExternalRing(GByte *pabyWkb,
                                                     size_t nWKBSize);

const GByte CPL_DLL *WKBFromEWKB(GByte *pabyEWKB, size_t nEWKBSize,
                                 size_t &nWKBSizeOut, int *pnSRIDOut);

class CPL_DLL OGRWKBPointUpdater
{
  public:
    OGRWKBPointUpdater();
    virtual ~OGRWKBPointUpdater();

    virtual bool update(bool bNeedSwap, void *x, void *y, void *z, void *m) = 0;
};
 
bool CPL_DLL OGRWKBUpdatePoints(GByte *pabyWkb, size_t nWKBSize,
                                OGRWKBPointUpdater &oUpdater);

struct CPL_DLL OGRWKBTransformCache
{
#ifdef OGR_WKB_TRANSFORM_ALL_AT_ONCE
    std::vector<bool> abNeedSwap{};
    std::vector<bool> abIsEmpty{};
    std::vector<void *> apdfX{};
    std::vector<void *> apdfY{};
    std::vector<void *> apdfZ{};
    std::vector<void *> apdfM{};
    std::vector<double> adfX{};
    std::vector<double> adfY{};
    std::vector<double> adfZ{};
    std::vector<double> adfM{};
    std::vector<int> anErrorCodes{};
 
    void clear();
#endif
};
 
class OGRCoordinateTransformation;
bool CPL_DLL OGRWKBTransform(GByte *pabyWkb, size_t nWKBSize,
                             OGRCoordinateTransformation *poCT,
                             OGRWKBTransformCache &oCache,
                             OGREnvelope3D &sEnvelope);
 
/************************************************************************/
/*                       OGRAppendBuffer                                */
/************************************************************************/

class CPL_DLL OGRAppendBuffer
{
  public:
    OGRAppendBuffer();

    virtual ~OGRAppendBuffer();

    inline void *GetPtrForNewBytes(size_t nItemSize)
    {
        if (nItemSize > m_nCapacity - m_nSize)
        {
            if (!Grow(nItemSize))
                return nullptr;
        }
        void *pRet = static_cast<GByte *>(m_pRawBuffer) + m_nSize;
        m_nSize += nItemSize;
        return pRet;
    }

    inline size_t GetSize() const
    {
        return m_nSize;
    }
 
  protected:
    size_t m_nCapacity = 0;

    size_t m_nSize = 0;

    void *m_pRawBuffer = nullptr;

    virtual bool Grow(size_t nItemSize) = 0;
 
  private:
    OGRAppendBuffer(const OGRAppendBuffer &) = delete;
    OGRAppendBuffer &operator=(const OGRAppendBuffer &) = delete;
};
 
/************************************************************************/
/*                       OGRWKTToWKBTranslator                          */
/************************************************************************/

class CPL_DLL OGRWKTToWKBTranslator
{
    OGRAppendBuffer &m_oAppendBuffer;
    bool m_bCanUseStrtod = false;
 
  public:
    explicit OGRWKTToWKBTranslator(OGRAppendBuffer &oAppendBuffer);

    size_t TranslateWKT(void *pabyWKTStart, size_t nLength,
                        bool bCanAlterByteAfter);
};
 
#endif  // OGR_WKB_H_INCLUDED