// Boost.Geometry (aka GGL, Generic Geometry Library) // Copyright (c) 2007-2022 Barend Gehrels, Amsterdam, the Netherlands. // Copyright (c) 2008-2012 Bruno Lalande, Paris, France. // Copyright (c) 2009-2012 Mateusz Loskot, London, UK. // Copyright (c) 2017-2023 Adam Wulkiewicz, Lodz, Poland. // Copyright (c) 2020 Baidyanath Kundu, Haldia, India // This file was modified by Oracle on 2014-2021. // Modifications copyright (c) 2014-2021 Oracle and/or its affiliates. // Contributed and/or modified by Adam Wulkiewicz, on behalf of Oracle // Parts of Boost.Geometry are redesigned from Geodan's Geographic Library // (geolib/GGL), copyright (c) 1995-2010 Geodan, Amsterdam, the Netherlands. // Use, modification and distribution is subject to the Boost Software License, // Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at // http://www.boost.org/LICENSE_1_0.txt) #ifndef BOOST_GEOMETRY_IO_WKT_READ_HPP #define BOOST_GEOMETRY_IO_WKT_READ_HPP #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include // For consistency with other functions #include #include #include #include #include #include #include #include #include namespace boost { namespace geometry { /*! \brief Exception showing things wrong with WKT parsing \ingroup wkt */ struct read_wkt_exception : public geometry::exception { template read_wkt_exception(std::string const& msg, Iterator const& it, Iterator const& end, std::string const& wkt) : message(msg) , wkt(wkt) { if (it != end) { source = " at '"; source += it->c_str(); source += "'"; } complete = message + source + " in '" + wkt.substr(0, 100) + "'"; } read_wkt_exception(std::string const& msg, std::string const& wkt) : message(msg) , wkt(wkt) { complete = message + "' in (" + wkt.substr(0, 100) + ")"; } const char* what() const noexcept override { return complete.c_str(); } private : std::string source; std::string message; std::string wkt; std::string complete; }; #ifndef DOXYGEN_NO_DETAIL // (wkt: Well Known Text, defined by OGC for all geometries and implemented by e.g. databases (MySQL, PostGIS)) namespace detail { namespace wkt { inline auto make_tokenizer(std::string const& wkt) { using separator = boost::char_separator; using tokenizer = boost::tokenizer; const tokenizer tokens(wkt, separator(" \n\t\r", ",()")); return tokens; } template ::value> struct parsing_assigner { template static inline void apply(TokenizerIterator& it, TokenizerIterator const& end, Point& point, std::string const& wkt) { using coordinate_type = typename coordinate_type::type; // Stop at end of tokens, or at "," ot ")" bool finished = (it == end || *it == "," || *it == ")"); try { // Initialize missing coordinates to default constructor (zero) // OR // Use lexical_cast for conversion to double/int // Note that it is much slower than atof. However, it is more standard // and in parsing the change in performance falls probably away against // the tokenizing set(point, finished ? coordinate_type() : coordinate_cast::apply(*it)); } catch(boost::bad_lexical_cast const& blc) { BOOST_THROW_EXCEPTION(read_wkt_exception(blc.what(), it, end, wkt)); } catch(std::exception const& e) { BOOST_THROW_EXCEPTION(read_wkt_exception(e.what(), it, end, wkt)); } catch(...) { BOOST_THROW_EXCEPTION(read_wkt_exception("", it, end, wkt)); } parsing_assigner::apply( (finished ? it : ++it), end, point, wkt); } }; template struct parsing_assigner { template static inline void apply(TokenizerIterator&, TokenizerIterator const&, Point&, std::string const&) { } }; template inline void handle_open_parenthesis(Iterator& it, Iterator const& end, std::string const& wkt) { if (it == end || *it != "(") { BOOST_THROW_EXCEPTION(read_wkt_exception("Expected '('", it, end, wkt)); } ++it; } template inline void handle_close_parenthesis(Iterator& it, Iterator const& end, std::string const& wkt) { if (it != end && *it == ")") { ++it; } else { BOOST_THROW_EXCEPTION(read_wkt_exception("Expected ')'", it, end, wkt)); } } template inline void check_end(Iterator& it, Iterator const& end, std::string const& wkt) { if (it != end) { BOOST_THROW_EXCEPTION(read_wkt_exception("Too many tokens", it, end, wkt)); } } /*! \brief Internal, parses coordinate sequences, strings are formated like "(1 2,3 4,...)" \param it token-iterator, should be pre-positioned at "(", is post-positions after last ")" \param end end-token-iterator \param out Output itererator receiving coordinates */ template struct container_inserter { // Version with output iterator template static inline void apply(TokenizerIterator& it, TokenizerIterator const& end, std::string const& wkt, OutputIterator out) { handle_open_parenthesis(it, end, wkt); Point point; // Parse points until closing parenthesis while (it != end && *it != ")") { parsing_assigner::apply(it, end, point, wkt); out = point; ++out; if (it != end && *it == ",") { ++it; } } handle_close_parenthesis(it, end, wkt); } }; template ::value> struct stateful_range_appender { // NOTE: Geometry is a reference inline void append(Geometry geom, typename geometry::point_type::type const& point, bool) { geometry::append(geom, point); } }; template struct stateful_range_appender { using point_type = typename geometry::point_type::type; using size_type = typename boost::range_size < typename util::remove_cptrref::type >::type; BOOST_STATIC_ASSERT((util::is_ring::value)); inline stateful_range_appender() : pt_index(0) {} // NOTE: Geometry is a reference inline void append(Geometry geom, point_type const& point, bool is_next_expected) { bool should_append = true; if (pt_index == 0) { first_point = point; } else { // NOTE: if there are not enough Points, they're always appended should_append = is_next_expected || pt_index < core_detail::closure::minimum_ring_size::value || disjoint(point, first_point); } ++pt_index; if (should_append) { geometry::append(geom, point); } } private: static inline bool disjoint(point_type const& p1, point_type const& p2) { // TODO: pass strategy using strategy_type = typename strategies::io::services::default_strategy < point_type >::type; return detail::disjoint::disjoint_point_point(p1, p2, strategy_type()); } size_type pt_index; point_type first_point; }; // Geometry is a value-type or reference-type template struct container_appender { using point_type = typename geometry::point_type::type; template static inline void apply(TokenizerIterator& it, TokenizerIterator const& end, std::string const& wkt, Geometry out) { handle_open_parenthesis(it, end, wkt); stateful_range_appender appender; // Parse points until closing parenthesis while (it != end && *it != ")") { point_type point; parsing_assigner::apply(it, end, point, wkt); bool const is_next_expected = it != end && *it == ","; appender.append(out, point, is_next_expected); if (is_next_expected) { ++it; } } handle_close_parenthesis(it, end, wkt); } }; /*! \brief Internal, parses a point from a string like this "(x y)" \note used for parsing points and multi-points */ template struct point_parser { template static inline void apply(TokenizerIterator& it, TokenizerIterator const& end, std::string const& wkt, P& point) { handle_open_parenthesis(it, end, wkt); parsing_assigner

::apply(it, end, point, wkt); handle_close_parenthesis(it, end, wkt); } }; template struct linestring_parser { template static inline void apply(TokenizerIterator& it, TokenizerIterator const& end, std::string const& wkt, Geometry& geometry) { container_appender::apply(it, end, wkt, geometry); } }; template struct ring_parser { template static inline void apply(TokenizerIterator& it, TokenizerIterator const& end, std::string const& wkt, Ring& ring) { // A ring should look like polygon((x y,x y,x y...)) // So handle the extra opening/closing parentheses // and in between parse using the container-inserter handle_open_parenthesis(it, end, wkt); container_appender::apply(it, end, wkt, ring); handle_close_parenthesis(it, end, wkt); } }; /*! \brief Internal, parses a polygon from a string like this "((x y,x y),(x y,x y))" \note used for parsing polygons and multi-polygons */ template struct polygon_parser { using ring_return_type = typename ring_return_type::type; using appender = container_appender; template static inline void apply(TokenizerIterator& it, TokenizerIterator const& end, std::string const& wkt, Polygon& poly) { handle_open_parenthesis(it, end, wkt); int n = -1; // Stop at ")" while (it != end && *it != ")") { // Parse ring if (++n == 0) { appender::apply(it, end, wkt, exterior_ring(poly)); } else { typename ring_type::type ring; appender::apply(it, end, wkt, ring); range::push_back(geometry::interior_rings(poly), std::move(ring)); } if (it != end && *it == ",") { // Skip "," after ring is parsed ++it; } } handle_close_parenthesis(it, end, wkt); } }; template inline bool one_of(TokenizerIterator const& it, std::string const& value, bool& is_present) { if (boost::iequals(*it, value)) { is_present = true; return true; } return false; } template inline bool one_of(TokenizerIterator const& it, std::string const& value, bool& present1, bool& present2) { if (boost::iequals(*it, value)) { present1 = true; present2 = true; return true; } return false; } template inline void handle_empty_z_m(TokenizerIterator& it, TokenizerIterator const& end, bool& has_empty, bool& has_z, bool& has_m) { has_empty = false; has_z = false; has_m = false; // WKT can optionally have Z and M (measured) values as in // POINT ZM (1 1 5 60), POINT M (1 1 80), POINT Z (1 1 5) // GGL supports any of them as coordinate values, but is not aware // of any Measured value. while (it != end && (one_of(it, "M", has_m) || one_of(it, "Z", has_z) || one_of(it, "EMPTY", has_empty) || one_of(it, "MZ", has_m, has_z) || one_of(it, "ZM", has_z, has_m) ) ) { ++it; } } template ::type> struct dimension : geometry::dimension {}; // TODO: For now assume the dimension of the first type defined for GC // This should probably be unified for all algorithms template struct dimension : geometry::dimension < typename util::sequence_front < typename traits::geometry_types::type >::type > {}; /*! \brief Internal, starts parsing \param geometry_name string to compare with first token */ template inline bool initialize(TokenizerIterator& it, TokenizerIterator const& end, std::string const& wkt, std::string const& geometry_name) { if (it == end || ! boost::iequals(*it++, geometry_name)) { BOOST_THROW_EXCEPTION(read_wkt_exception(std::string("Should start with '") + geometry_name + "'", wkt)); } bool has_empty, has_z, has_m; handle_empty_z_m(it, end, has_empty, has_z, has_m); // Silence warning C4127: conditional expression is constant #if defined(_MSC_VER) #pragma warning(push) #pragma warning(disable : 4127) #endif if (has_z && dimension::value < 3) { BOOST_THROW_EXCEPTION(read_wkt_exception("Z only allowed for 3 or more dimensions", wkt)); } #if defined(_MSC_VER) #pragma warning(pop) #endif if (has_empty) { return false; } // M is ignored at all. return true; } template class Parser, typename PrefixPolicy> struct geometry_parser { static inline void apply(std::string const& wkt, Geometry& geometry) { geometry::clear(geometry); auto const tokens{make_tokenizer(wkt)}; auto it = tokens.begin(); auto const end = tokens.end(); apply(it, end, wkt, geometry); check_end(it, end, wkt); } template static inline void apply(TokenizerIterator& it, TokenizerIterator const& end, std::string const& wkt, Geometry& geometry) { if (initialize(it, end, wkt, PrefixPolicy::apply())) { Parser::apply(it, end, wkt, geometry); } } }; template class Parser, typename PrefixPolicy> struct multi_parser { static inline void apply(std::string const& wkt, MultiGeometry& geometry) { traits::clear::apply(geometry); auto const tokens{make_tokenizer(wkt)}; auto it = tokens.begin(); auto const end = tokens.end(); apply(it, end, wkt, geometry); check_end(it, end, wkt); } template static inline void apply(TokenizerIterator& it, TokenizerIterator const& end, std::string const& wkt, MultiGeometry& geometry) { if (initialize(it, end, wkt, PrefixPolicy::apply())) { handle_open_parenthesis(it, end, wkt); // Parse sub-geometries while(it != end && *it != ")") { traits::resize::apply(geometry, boost::size(geometry) + 1); Parser < typename boost::range_value::type >::apply(it, end, wkt, *(boost::end(geometry) - 1)); if (it != end && *it == ",") { // Skip "," after multi-element is parsed ++it; } } handle_close_parenthesis(it, end, wkt); } } }; template struct noparenthesis_point_parser { template static inline void apply(TokenizerIterator& it, TokenizerIterator const& end, std::string const& wkt, P& point) { parsing_assigner

::apply(it, end, point, wkt); } }; template struct multi_point_parser { static inline void apply(std::string const& wkt, MultiGeometry& geometry) { traits::clear::apply(geometry); auto const tokens{make_tokenizer(wkt)}; auto it = tokens.begin(); auto const end = tokens.end(); apply(it, end, wkt, geometry); check_end(it, end, wkt); } template static inline void apply(TokenizerIterator& it, TokenizerIterator const& end, std::string const& wkt, MultiGeometry& geometry) { if (initialize(it, end, wkt, PrefixPolicy::apply())) { handle_open_parenthesis(it, end, wkt); // If first point definition starts with "(" then parse points as (x y) // otherwise as "x y" bool using_brackets = (it != end && *it == "("); while(it != end && *it != ")") { traits::resize::apply(geometry, boost::size(geometry) + 1); if (using_brackets) { point_parser < typename boost::range_value::type >::apply(it, end, wkt, *(boost::end(geometry) - 1)); } else { noparenthesis_point_parser < typename boost::range_value::type >::apply(it, end, wkt, *(boost::end(geometry) - 1)); } if (it != end && *it == ",") { // Skip "," after point is parsed ++it; } } handle_close_parenthesis(it, end, wkt); } } }; /*! \brief Supports box parsing \note OGC does not define the box geometry, and WKT does not support boxes. However, to be generic GGL supports reading and writing from and to boxes. Boxes are outputted as a standard POLYGON. GGL can read boxes from a standard POLYGON, from a POLYGON with 2 points of from a BOX \tparam Box the box */ template struct box_parser { static inline void apply(std::string const& wkt, Box& box) { auto const tokens{make_tokenizer(wkt)}; auto it = tokens.begin(); auto const end = tokens.end(); apply(it, end, wkt, box); check_end(it, end, wkt); } template static inline void apply(TokenizerIterator& it, TokenizerIterator const& end, std::string const& wkt, Box& box) { bool should_close = false; if (it != end && boost::iequals(*it, "POLYGON")) { ++it; bool has_empty, has_z, has_m; handle_empty_z_m(it, end, has_empty, has_z, has_m); if (has_empty) { assign_zero(box); return; } handle_open_parenthesis(it, end, wkt); should_close = true; } else if (it != end && boost::iequals(*it, "BOX")) { ++it; } else { BOOST_THROW_EXCEPTION(read_wkt_exception("Should start with 'POLYGON' or 'BOX'", wkt)); } using point_type = typename point_type::type; std::vector points; container_inserter::apply(it, end, wkt, std::back_inserter(points)); if (should_close) { handle_close_parenthesis(it, end, wkt); } unsigned int index = 0; std::size_t n = boost::size(points); if (n == 2) { index = 1; } else if (n == 4 || n == 5) { // In case of 4 or 5 points, we do not check the other ones, just // take the opposite corner which is always 2 index = 2; } else { BOOST_THROW_EXCEPTION(read_wkt_exception("Box should have 2,4 or 5 points", wkt)); } geometry::detail::assign_point_to_index(points.front(), box); geometry::detail::assign_point_to_index(points[index], box); } }; /*! \brief Supports segment parsing \note OGC does not define the segment, and WKT does not support segmentes. However, it is useful to implement it, also for testing purposes \tparam Segment the segment */ template struct segment_parser { static inline void apply(std::string const& wkt, Segment& segment) { auto const tokens{make_tokenizer(wkt)}; auto it = tokens.begin(); auto const end = tokens.end(); apply(it, end, wkt, segment); check_end(it, end, wkt); } template static inline void apply(TokenizerIterator& it, TokenizerIterator const& end, std::string const& wkt, Segment& segment) { if (it != end && (boost::iequals(*it, prefix_segment::apply()) || boost::iequals(*it, prefix_linestring::apply()))) { ++it; } else { BOOST_THROW_EXCEPTION(read_wkt_exception("Should start with 'LINESTRING' or 'SEGMENT'", wkt)); } using point_type = typename point_type::type; std::vector points; container_inserter::apply(it, end, wkt, std::back_inserter(points)); if (boost::size(points) == 2) { geometry::detail::assign_point_to_index<0>(points.front(), segment); geometry::detail::assign_point_to_index<1>(points.back(), segment); } else { BOOST_THROW_EXCEPTION(read_wkt_exception("Segment should have 2 points", wkt)); } } }; struct dynamic_move_assign { template static void apply(DynamicGeometry& dynamic_geometry, Geometry & geometry) { dynamic_geometry = std::move(geometry); } }; struct dynamic_move_emplace_back { template static void apply(GeometryCollection& geometry_collection, Geometry & geometry) { traits::emplace_back::apply(geometry_collection, std::move(geometry)); } }; template < typename Geometry, template class ReadWkt, typename AppendPolicy > struct dynamic_readwkt_caller { template static inline void apply(TokenizerIterator& it, TokenizerIterator const& end, std::string const& wkt, Geometry& geometry) { static const char* tag_point = prefix_point::apply(); static const char* tag_linestring = prefix_linestring::apply(); static const char* tag_polygon = prefix_polygon::apply(); static const char* tag_multi_point = prefix_multipoint::apply(); static const char* tag_multi_linestring = prefix_multilinestring::apply(); static const char* tag_multi_polygon = prefix_multipolygon::apply(); static const char* tag_segment = prefix_segment::apply(); static const char* tag_box = prefix_box::apply(); static const char* tag_gc = prefix_geometrycollection::apply(); if (boost::iequals(*it, tag_point)) { parse_geometry(tag_point, it, end, wkt, geometry); } else if (boost::iequals(*it, tag_multi_point)) { parse_geometry(tag_multi_point, it, end, wkt, geometry); } else if (boost::iequals(*it, tag_segment)) { parse_geometry(tag_segment, it, end, wkt, geometry); } else if (boost::iequals(*it, tag_linestring)) { parse_geometry(tag_linestring, it, end, wkt, geometry, false) || parse_geometry(tag_linestring, it, end, wkt, geometry); } else if (boost::iequals(*it, tag_multi_linestring)) { parse_geometry(tag_multi_linestring, it, end, wkt, geometry); } else if (boost::iequals(*it, tag_box)) { parse_geometry(tag_box, it, end, wkt, geometry); } else if (boost::iequals(*it, tag_polygon)) { parse_geometry(tag_polygon, it, end, wkt, geometry, false) || parse_geometry(tag_polygon, it, end, wkt, geometry, false) || parse_geometry(tag_polygon, it, end, wkt, geometry); } else if (boost::iequals(*it, tag_multi_polygon)) { parse_geometry(tag_multi_polygon, it, end, wkt, geometry); } else if (boost::iequals(*it, tag_gc)) { parse_geometry(tag_gc, it, end, wkt, geometry); } else { BOOST_THROW_EXCEPTION(read_wkt_exception( "Should start with geometry's type, for example 'POINT', 'LINESTRING', 'POLYGON'", wkt)); } } private: template < template class UnaryPred, typename TokenizerIterator, typename Geom = typename util::sequence_find_if < typename traits::geometry_types::type, UnaryPred >::type, std::enable_if_t::value, int> = 0 > static bool parse_geometry(const char * , TokenizerIterator& it, TokenizerIterator const& end, std::string const& wkt, Geometry& geometry, bool = true) { Geom g; ReadWkt::type>::apply(it, end, wkt, g); AppendPolicy::apply(geometry, g); return true; } template < template class UnaryPred, typename TokenizerIterator, typename Geom = typename util::sequence_find_if < typename traits::geometry_types::type, UnaryPred >::type, std::enable_if_t::value, int> = 0 > static bool parse_geometry(const char * name, TokenizerIterator& , TokenizerIterator const& , std::string const& wkt, Geometry& , bool throw_on_misfit = true) { if (throw_on_misfit) { std::string msg = std::string("Unable to store '") + name + "' in this geometry"; BOOST_THROW_EXCEPTION(read_wkt_exception(msg, wkt)); } return false; } }; }} // namespace detail::wkt #endif // DOXYGEN_NO_DETAIL #ifndef DOXYGEN_NO_DISPATCH namespace dispatch { template ::type> struct read_wkt {}; template struct read_wkt : detail::wkt::geometry_parser < Point, detail::wkt::point_parser, detail::wkt::prefix_point > {}; template struct read_wkt : detail::wkt::geometry_parser < L, detail::wkt::linestring_parser, detail::wkt::prefix_linestring > {}; template struct read_wkt : detail::wkt::geometry_parser < Ring, detail::wkt::ring_parser, detail::wkt::prefix_polygon > {}; template struct read_wkt : detail::wkt::geometry_parser < Geometry, detail::wkt::polygon_parser, detail::wkt::prefix_polygon > {}; template struct read_wkt : detail::wkt::multi_point_parser < MultiGeometry, detail::wkt::prefix_multipoint > {}; template struct read_wkt : detail::wkt::multi_parser < MultiGeometry, detail::wkt::linestring_parser, detail::wkt::prefix_multilinestring > {}; template struct read_wkt : detail::wkt::multi_parser < MultiGeometry, detail::wkt::polygon_parser, detail::wkt::prefix_multipolygon > {}; // Box (Non-OGC) template struct read_wkt : detail::wkt::box_parser {}; // Segment (Non-OGC) template struct read_wkt : detail::wkt::segment_parser {}; template struct read_wkt { static inline void apply(std::string const& wkt, DynamicGeometry& dynamic_geometry) { auto tokens{detail::wkt::make_tokenizer(wkt)}; auto it = tokens.begin(); auto const end = tokens.end(); if (it == end) { BOOST_THROW_EXCEPTION(read_wkt_exception( "Should start with geometry's type, for example 'POINT', 'LINESTRING', 'POLYGON'", wkt)); } detail::wkt::dynamic_readwkt_caller < DynamicGeometry, dispatch::read_wkt, detail::wkt::dynamic_move_assign >::apply(it, end, wkt, dynamic_geometry); detail::wkt::check_end(it, end, wkt); } }; template struct read_wkt { static inline void apply(std::string const& wkt, Geometry& geometry) { range::clear(geometry); auto tokens{detail::wkt::make_tokenizer(wkt)}; auto it = tokens.begin(); auto const end = tokens.end(); apply(it, end, wkt, geometry); detail::wkt::check_end(it, end, wkt); } template static inline void apply(TokenizerIterator& it, TokenizerIterator const& end, std::string const& wkt, Geometry& geometry) { if (detail::wkt::initialize(it, end, wkt, detail::wkt::prefix_geometrycollection::apply())) { detail::wkt::handle_open_parenthesis(it, end, wkt); // Stop at ")" while (it != end && *it != ")") { detail::wkt::dynamic_readwkt_caller < Geometry, dispatch::read_wkt, detail::wkt::dynamic_move_emplace_back >::apply(it, end, wkt, geometry); if (it != end && *it == ",") { // Skip "," after geometry is parsed ++it; } } detail::wkt::handle_close_parenthesis(it, end, wkt); } } }; } // namespace dispatch #endif // DOXYGEN_NO_DISPATCH /*! \brief Parses OGC Well-Known Text (\ref WKT) into a geometry (any geometry) \ingroup wkt \tparam Geometry \tparam_geometry \param wkt string containing \ref WKT \param geometry \param_geometry output geometry \ingroup wkt \qbk{[include reference/io/read_wkt.qbk]} */ template inline void read_wkt(std::string const& wkt, Geometry& geometry) { geometry::concepts::check(); dispatch::read_wkt::apply(wkt, geometry); } /*! \brief Parses OGC Well-Known Text (\ref WKT) into a geometry (any geometry) and returns it \ingroup wkt \tparam Geometry \tparam_geometry \param wkt string containing \ref WKT \ingroup wkt \qbk{[include reference/io/from_wkt.qbk]} */ template inline Geometry from_wkt(std::string const& wkt) { Geometry geometry; geometry::concepts::check(); dispatch::read_wkt::apply(wkt, geometry); return geometry; } }} // namespace boost::geometry #endif // BOOST_GEOMETRY_IO_WKT_READ_HPP