wkb.h

Go to the documentation of this file.

#ifndef SQL_GIS_WKB_H_INCLUDED
#define SQL_GIS_WKB_H_INCLUDED
 
// Copyright (c) 2017, 2025, Oracle and/or its affiliates.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, version 2.0,
// as published by the Free Software Foundation.
//
// This program is designed to work with certain software (including
// but not limited to OpenSSL) that is licensed under separate terms,
// as designated in a particular file or component or in included license
// documentation.  The authors of MySQL hereby grant you an additional
// permission to link the program and your derivative works with the
// separately licensed software that they have either included with
// the program or referenced in the documentation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License, version 2.0, for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA.
 
/// @file
///
/// This file declares the interface of the WKB parser for geometries and the
/// parser for the internal geometry representation.
 
#include <memory>  // std::unique_ptr
 
#include "sql/gis/geometries.h"
#include "sql/gis/srid.h"
 
class THD;
class String;
namespace dd {
class Spatial_reference_system;
}
 
namespace gis {
 
/// Parses an SRID from a little-endian string.
///
/// @param[in] str The string.
/// @param[in] length Length of the string.
/// @param[out] srid The SRID read from the string.
///
/// @retval false Success.
/// @retval true Error. my_error() has not been called.
bool parse_srid(const char *str, std::size_t length, srid_t *srid);
 
///
/// Parses a geometry WKB string and constructs a geometry object.
///
/// The geometry is allocated on the heap and ownership is transferred to the
/// caller.
///
/// If ignore_axis_order is true, the string is assumed to be on the geometry
/// storage format, not general WKB. The storage format differs from ordinary
/// WKB by having a fixed x=longitude, y=latitude mapping.
///
/// @warning This function checks if there are so many nested levels of geometry
/// collections that the stack will be exhausted. If that happens, my_error is
/// called and the function exits with no geometry value. However, if thd is
/// nullptr, this check is disabled, and the caller is responsible for checking
/// that there is enough stack to parse the WKB string.
///
/// @param[in] thd Thread handle.
/// @param srs The SRS of the geometry.
/// @param wkb The WKB string.
/// @param length Length of the WKB string.
/// @param ignore_axis_order Ignore SRS axis order and assume it's always
/// long-lat.
///
/// @return The geometry. If an error occurred, the return value is a null
/// pointer. In case of stack overrun, my_error has been called.
std::unique_ptr<Geometry> parse_wkb(THD *thd,
                                    const dd::Spatial_reference_system *srs,
                                    const char *wkb, std::size_t length,
                                    bool ignore_axis_order = false);
 
/// Parses a little-endian geometry string (SRID + WKB).
///
/// The geometry is allocated on the heap and ownership is transferred to the
/// caller.
///
/// @param[in] thd Thread handle
/// @param[in] func_name The function name to use in error messages.
/// @param[in] str The geometry string.
/// @param[out] srs The spatial reference system of the geometry.
/// @param[out] geometry The geometry.
/// @param[in] treat_unknown_srid_as_cartesian Whether to treat unknown
/// SRIDs as Cartesian. If false, raise an error if the SRID is unknown.
///
/// @retval false Success.
/// @retval true Error. my_error() has been called.
bool parse_geometry(THD *thd, const char *func_name, const String *str,
                    const dd::Spatial_reference_system **srs,
                    std::unique_ptr<Geometry> *geometry,
                    bool treat_unknown_srid_as_cartesian = false);
 
/// Writes a little-endian geometry string (SRID + WKB).
///
/// @param[in] srs The SRS of the geometry.
/// @param[in] geometry The geometry.
/// @param[out] str The string to write the geometry to.
///
/// @retval false Success.
/// @retval true Error. my_error() has been called.
bool write_geometry(const dd::Spatial_reference_system *srs, Geometry &geometry,
                    String *str);
 
}  // namespace gis
 
#endif  // SQL_GIS_WKB_H_INCLUDED