GDAL
ogr_wkb.h
1 /******************************************************************************
2  *
3  * Project: OGR
4  * Purpose: WKB geometry related methods
5  * Author: Even Rouault <even dot rouault at spatialys.com>
6  *
7  ******************************************************************************
8  * Copyright (c) 2022, Even Rouault <even dot rouault at spatialys.com>
9  *
10  * Permission is hereby granted, free of charge, to any person obtaining a
11  * copy of this software and associated documentation files (the "Software"),
12  * to deal in the Software without restriction, including without limitation
13  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
14  * and/or sell copies of the Software, and to permit persons to whom the
15  * Software is furnished to do so, subject to the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be included
18  * in all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
21  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
23  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
25  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
26  * DEALINGS IN THE SOFTWARE.
27  ****************************************************************************/
28 
29 #ifndef OGR_WKB_H_INCLUDED
30 #define OGR_WKB_H_INCLUDED
31 
32 #include "cpl_port.h"
33 #include "ogr_core.h"
34 
35 bool CPL_DLL OGRWKBGetGeomType(const GByte *pabyWkb, size_t nWKBSize,
36  bool &bNeedSwap, uint32_t &nType);
37 bool OGRWKBPolygonGetArea(const GByte *&pabyWkb, size_t &nWKBSize,
38  double &dfArea);
39 bool OGRWKBMultiPolygonGetArea(const GByte *&pabyWkb, size_t &nWKBSize,
40  double &dfArea);
41 
42 bool CPL_DLL OGRWKBGetBoundingBox(const GByte *pabyWkb, size_t nWKBSize,
43  OGREnvelope &sEnvelope);
44 
45 bool CPL_DLL OGRWKBIntersectsPessimistic(const GByte *pabyWkb, size_t nWKBSize,
46  const OGREnvelope &sEnvelope);
47 
48 void CPL_DLL OGRWKBFixupCounterClockWiseExternalRing(GByte *pabyWkb,
49  size_t nWKBSize);
50 
59 const GByte CPL_DLL *WKBFromEWKB(GByte *pabyEWKB, size_t nEWKBSize,
60  size_t &nWKBSizeOut, int *pnSRIDOut);
61 
62 /************************************************************************/
63 /* OGRAppendBuffer */
64 /************************************************************************/
65 
67 class CPL_DLL OGRAppendBuffer
68 {
69  public:
72 
74  virtual ~OGRAppendBuffer();
75 
79  inline void *GetPtrForNewBytes(size_t nItemSize)
80  {
81  if (nItemSize > m_nCapacity - m_nSize)
82  {
83  if (!Grow(nItemSize))
84  return nullptr;
85  }
86  void *pRet = static_cast<GByte *>(m_pRawBuffer) + m_nSize;
87  m_nSize += nItemSize;
88  return pRet;
89  }
90 
92  inline size_t GetSize() const
93  {
94  return m_nSize;
95  }
96 
97  protected:
99  size_t m_nCapacity = 0;
100 
102  size_t m_nSize = 0;
103 
105  void *m_pRawBuffer = nullptr;
106 
110  virtual bool Grow(size_t nItemSize) = 0;
111 
112  private:
113  OGRAppendBuffer(const OGRAppendBuffer &) = delete;
114  OGRAppendBuffer &operator=(const OGRAppendBuffer &) = delete;
115 };
116 
117 /************************************************************************/
118 /* OGRWKTToWKBTranslator */
119 /************************************************************************/
120 
123 {
124  OGRAppendBuffer &m_oAppendBuffer;
125  bool m_bCanUseStrtod = false;
126 
127  public:
129  explicit OGRWKTToWKBTranslator(OGRAppendBuffer &oAppendBuffer);
130 
138  size_t TranslateWKT(void *pabyWKTStart, size_t nLength,
139  bool bCanAlterByteAfter);
140 };
141 
142 #endif // OGR_WKB_H_INCLUDED
GByte
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:196
OGRAppendBuffer::GetSize
size_t GetSize() const
Return the number of valid bytes in the buffer.
Definition: ogr_wkb.h:92
OGRAppendBuffer::GetPtrForNewBytes
void * GetPtrForNewBytes(size_t nItemSize)
Return the pointer at which nItemSize bytes can be written, or nullptr in case of error.
Definition: ogr_wkb.h:79
OGRAppendBuffer
Append buffer that can be grown dynamically.
Definition: ogr_wkb.h:67
OGRWKTToWKBTranslator
Translate WKT geometry to WKB geometry and append it to a buffer.
Definition: ogr_wkb.h:122
cpl_port.h
OGREnvelope
Simple container for a bounding region (rectangle)
Definition: ogr_core.h:57
ogr_core.h