Chris@16: // Boost.Geometry (aka GGL, Generic Geometry Library)
Chris@16: 
Chris@16: // Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands.
Chris@16: // Copyright (c) 2008-2012 Bruno Lalande, Paris, France.
Chris@16: // Copyright (c) 2009-2012 Mateusz Loskot, London, UK.
Chris@101: // Copyright (c) 2014 Adam Wulkiewicz, Lodz, Poland.
Chris@16: 
Chris@16: // Parts of Boost.Geometry are redesigned from Geodan's Geographic Library
Chris@16: // (geolib/GGL), copyright (c) 1995-2010 Geodan, Amsterdam, the Netherlands.
Chris@16: 
Chris@16: // Use, modification and distribution is subject to the Boost Software License,
Chris@16: // Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
Chris@16: // http://www.boost.org/LICENSE_1_0.txt)
Chris@16: 
Chris@16: #ifndef BOOST_GEOMETRY_IO_WKT_WRITE_HPP
Chris@16: #define BOOST_GEOMETRY_IO_WKT_WRITE_HPP
Chris@16: 
Chris@16: #include <ostream>
Chris@16: #include <string>
Chris@16: 
Chris@16: #include <boost/array.hpp>
Chris@16: #include <boost/range.hpp>
Chris@16: 
Chris@101: #include <boost/variant/apply_visitor.hpp>
Chris@101: #include <boost/variant/static_visitor.hpp>
Chris@101: #include <boost/variant/variant_fwd.hpp>
Chris@101: 
Chris@101: #include <boost/geometry/algorithms/detail/interior_iterator.hpp>
Chris@16: #include <boost/geometry/algorithms/assign.hpp>
Chris@16: #include <boost/geometry/algorithms/convert.hpp>
Chris@101: #include <boost/geometry/algorithms/disjoint.hpp>
Chris@16: #include <boost/geometry/algorithms/not_implemented.hpp>
Chris@16: #include <boost/geometry/core/exterior_ring.hpp>
Chris@16: #include <boost/geometry/core/interior_rings.hpp>
Chris@16: #include <boost/geometry/core/ring_type.hpp>
Chris@101: #include <boost/geometry/core/tags.hpp>
Chris@16: 
Chris@16: #include <boost/geometry/geometries/concepts/check.hpp>
Chris@16: #include <boost/geometry/geometries/ring.hpp>
Chris@16: 
Chris@16: #include <boost/geometry/io/wkt/detail/prefix.hpp>
Chris@16: 
Chris@16: 
Chris@16: namespace boost { namespace geometry
Chris@16: {
Chris@16: 
Chris@16: // Silence warning C4512: 'boost::geometry::wkt_manipulator<Geometry>' : assignment operator could not be generated
Chris@16: #if defined(_MSC_VER)
Chris@16: #pragma warning(push)  
Chris@16: #pragma warning(disable : 4512)  
Chris@16: #endif
Chris@16: 
Chris@16: #ifndef DOXYGEN_NO_DETAIL
Chris@16: namespace detail { namespace wkt
Chris@16: {
Chris@16: 
Chris@16: template <typename P, int I, int Count>
Chris@16: struct stream_coordinate
Chris@16: {
Chris@16:     template <typename Char, typename Traits>
Chris@16:     static inline void apply(std::basic_ostream<Char, Traits>& os, P const& p)
Chris@16:     {
Chris@16:         os << (I > 0 ? " " : "") << get<I>(p);
Chris@16:         stream_coordinate<P, I + 1, Count>::apply(os, p);
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@16: template <typename P, int Count>
Chris@16: struct stream_coordinate<P, Count, Count>
Chris@16: {
Chris@16:     template <typename Char, typename Traits>
Chris@16:     static inline void apply(std::basic_ostream<Char, Traits>&, P const&)
Chris@16:     {}
Chris@16: };
Chris@16: 
Chris@16: struct prefix_linestring_par
Chris@16: {
Chris@16:     static inline const char* apply() { return "LINESTRING("; }
Chris@16: };
Chris@16: 
Chris@16: struct prefix_ring_par_par
Chris@16: {
Chris@16:     // Note, double parentheses are intentional, indicating WKT ring begin/end
Chris@16:     static inline const char* apply() { return "POLYGON(("; }
Chris@16: };
Chris@16: 
Chris@16: struct opening_parenthesis
Chris@16: {
Chris@16:     static inline const char* apply() { return "("; }
Chris@16: };
Chris@16: 
Chris@16: struct closing_parenthesis
Chris@16: {
Chris@16:     static inline const char* apply() { return ")"; }
Chris@16: };
Chris@16: 
Chris@16: struct double_closing_parenthesis
Chris@16: {
Chris@16:     static inline const char* apply() { return "))"; }
Chris@16: };
Chris@16: 
Chris@16: /*!
Chris@16: \brief Stream points as \ref WKT
Chris@16: */
Chris@16: template <typename Point, typename Policy>
Chris@16: struct wkt_point
Chris@16: {
Chris@16:     template <typename Char, typename Traits>
Chris@16:     static inline void apply(std::basic_ostream<Char, Traits>& os, Point const& p)
Chris@16:     {
Chris@16:         os << Policy::apply() << "(";
Chris@16:         stream_coordinate<Point, 0, dimension<Point>::type::value>::apply(os, p);
Chris@16:         os << ")";
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@16: /*!
Chris@16: \brief Stream ranges as WKT
Chris@16: \note policy is used to stream prefix/postfix, enabling derived classes to override this
Chris@16: */
Chris@16: template <typename Range, typename PrefixPolicy, typename SuffixPolicy>
Chris@16: struct wkt_range
Chris@16: {
Chris@16:     template <typename Char, typename Traits>
Chris@16:     static inline void apply(std::basic_ostream<Char, Traits>& os,
Chris@101:                 Range const& range, bool force_closed)
Chris@16:     {
Chris@16:         typedef typename boost::range_iterator<Range const>::type iterator_type;
Chris@16: 
Chris@101:         typedef stream_coordinate
Chris@101:             <
Chris@101:                 point_type, 0, dimension<point_type>::type::value
Chris@101:             > stream_type;
Chris@101: 
Chris@16:         bool first = true;
Chris@16: 
Chris@16:         os << PrefixPolicy::apply();
Chris@16: 
Chris@16:         // TODO: check EMPTY here
Chris@16: 
Chris@101:         iterator_type begin = boost::begin(range);
Chris@101:         iterator_type end = boost::end(range);
Chris@101:         for (iterator_type it = begin; it != end; ++it)
Chris@16:         {
Chris@16:             os << (first ? "" : ",");
Chris@101:             stream_type::apply(os, *it);
Chris@16:             first = false;
Chris@16:         }
Chris@16: 
Chris@101:         // optionally, close range to ring by repeating the first point
Chris@101:         if (force_closed 
Chris@101:             && boost::size(range) > 1
Chris@101:             && geometry::disjoint(*begin, *(end - 1)))
Chris@101:         {
Chris@101:             os << ",";
Chris@101:             stream_type::apply(os, *begin);
Chris@101:         }
Chris@101: 
Chris@16:         os << SuffixPolicy::apply();
Chris@16:     }
Chris@16: 
Chris@101:     template <typename Char, typename Traits>
Chris@101:     static inline void apply(std::basic_ostream<Char, Traits>& os,
Chris@101:                 Range const& range)
Chris@101:     {
Chris@101:         apply(os, range, false);
Chris@101:     }
Chris@101: 
Chris@16: private:
Chris@16:     typedef typename boost::range_value<Range>::type point_type;
Chris@16: };
Chris@16: 
Chris@16: /*!
Chris@16: \brief Stream sequence of points as WKT-part, e.g. (1 2),(3 4)
Chris@16: \note Used in polygon, all multi-geometries
Chris@16: */
Chris@16: template <typename Range>
Chris@16: struct wkt_sequence
Chris@16:     : wkt_range
Chris@16:         <
Chris@16:             Range,
Chris@16:             opening_parenthesis,
Chris@16:             closing_parenthesis
Chris@16:         >
Chris@16: {};
Chris@16: 
Chris@16: template <typename Polygon, typename PrefixPolicy>
Chris@16: struct wkt_poly
Chris@16: {
Chris@16:     template <typename Char, typename Traits>
Chris@16:     static inline void apply(std::basic_ostream<Char, Traits>& os,
Chris@16:                 Polygon const& poly)
Chris@16:     {
Chris@16:         typedef typename ring_type<Polygon const>::type ring;
Chris@101:         bool const force_closed = true;
Chris@16: 
Chris@16:         os << PrefixPolicy::apply();
Chris@16:         // TODO: check EMPTY here
Chris@16:         os << "(";
Chris@101:         wkt_sequence<ring>::apply(os, exterior_ring(poly), force_closed);
Chris@16: 
Chris@101:         typename interior_return_type<Polygon const>::type
Chris@101:             rings = interior_rings(poly);
Chris@101:         for (typename detail::interior_iterator<Polygon const>::type
Chris@101:                 it = boost::begin(rings); it != boost::end(rings); ++it)
Chris@16:         {
Chris@16:             os << ",";
Chris@101:             wkt_sequence<ring>::apply(os, *it, force_closed);
Chris@16:         }
Chris@16:         os << ")";
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@101: template <typename Multi, typename StreamPolicy, typename PrefixPolicy>
Chris@101: struct wkt_multi
Chris@101: {
Chris@101:     template <typename Char, typename Traits>
Chris@101:     static inline void apply(std::basic_ostream<Char, Traits>& os,
Chris@101:                 Multi const& geometry)
Chris@101:     {
Chris@101:         os << PrefixPolicy::apply();
Chris@101:         // TODO: check EMPTY here
Chris@101:         os << "(";
Chris@101: 
Chris@101:         for (typename boost::range_iterator<Multi const>::type
Chris@101:                     it = boost::begin(geometry);
Chris@101:             it != boost::end(geometry);
Chris@101:             ++it)
Chris@101:         {
Chris@101:             if (it != boost::begin(geometry))
Chris@101:             {
Chris@101:                 os << ",";
Chris@101:             }
Chris@101:             StreamPolicy::apply(os, *it);
Chris@101:         }
Chris@101: 
Chris@101:         os << ")";
Chris@101:     }
Chris@101: };
Chris@101: 
Chris@16: template <typename Box>
Chris@16: struct wkt_box
Chris@16: {
Chris@16:     typedef typename point_type<Box>::type point_type;
Chris@16: 
Chris@16:     template <typename Char, typename Traits>
Chris@16:     static inline void apply(std::basic_ostream<Char, Traits>& os,
Chris@16:                 Box const& box)
Chris@16:     {
Chris@16:         // Convert to ring, then stream
Chris@16:         typedef model::ring<point_type> ring_type;
Chris@16:         ring_type ring;
Chris@16:         geometry::convert(box, ring);
Chris@16:         os << "POLYGON(";
Chris@16:         wkt_sequence<ring_type>::apply(os, ring);
Chris@16:         os << ")";
Chris@16:     }
Chris@16: 
Chris@16:     private:
Chris@16: 
Chris@16:         inline wkt_box()
Chris@16:         {
Chris@16:             // Only streaming of boxes with two dimensions is support, otherwise it is a polyhedron!
Chris@16:             //assert_dimension<B, 2>();
Chris@16:         }
Chris@16: };
Chris@16: 
Chris@16: 
Chris@16: template <typename Segment>
Chris@16: struct wkt_segment
Chris@16: {
Chris@16:     typedef typename point_type<Segment>::type point_type;
Chris@16: 
Chris@16:     template <typename Char, typename Traits>
Chris@16:     static inline void apply(std::basic_ostream<Char, Traits>& os,
Chris@16:                 Segment const& segment)
Chris@16:     {
Chris@16:         // Convert to two points, then stream
Chris@16:         typedef boost::array<point_type, 2> sequence;
Chris@16: 
Chris@16:         sequence points;
Chris@16:         geometry::detail::assign_point_from_index<0>(segment, points[0]);
Chris@16:         geometry::detail::assign_point_from_index<1>(segment, points[1]);
Chris@16: 
Chris@16:         // In Boost.Geometry a segment is represented
Chris@16:         // in WKT-format like (for 2D): LINESTRING(x y,x y)
Chris@16:         os << "LINESTRING";
Chris@16:         wkt_sequence<sequence>::apply(os, points);
Chris@16:     }
Chris@16: 
Chris@16:     private:
Chris@16: 
Chris@16:         inline wkt_segment()
Chris@16:         {}
Chris@16: };
Chris@16: 
Chris@16: }} // namespace detail::wkt
Chris@16: #endif // DOXYGEN_NO_DETAIL
Chris@16: 
Chris@16: #ifndef DOXYGEN_NO_DISPATCH
Chris@16: namespace dispatch
Chris@16: {
Chris@16: 
Chris@16: template <typename Geometry, typename Tag = typename tag<Geometry>::type>
Chris@16: struct wkt: not_implemented<Tag>
Chris@16: {};
Chris@16: 
Chris@16: template <typename Point>
Chris@16: struct wkt<Point, point_tag>
Chris@16:     : detail::wkt::wkt_point
Chris@16:         <
Chris@16:             Point,
Chris@16:             detail::wkt::prefix_point
Chris@16:         >
Chris@16: {};
Chris@16: 
Chris@16: template <typename Linestring>
Chris@16: struct wkt<Linestring, linestring_tag>
Chris@16:     : detail::wkt::wkt_range
Chris@16:         <
Chris@16:             Linestring,
Chris@16:             detail::wkt::prefix_linestring_par,
Chris@16:             detail::wkt::closing_parenthesis
Chris@16:         >
Chris@16: {};
Chris@16: 
Chris@16: /*!
Chris@16: \brief Specialization to stream a box as WKT
Chris@16: \details A "box" does not exist in WKT.
Chris@16: It is therefore streamed as a polygon
Chris@16: */
Chris@16: template <typename Box>
Chris@16: struct wkt<Box, box_tag>
Chris@16:     : detail::wkt::wkt_box<Box>
Chris@16: {};
Chris@16: 
Chris@16: template <typename Segment>
Chris@16: struct wkt<Segment, segment_tag>
Chris@16:     : detail::wkt::wkt_segment<Segment>
Chris@16: {};
Chris@16: 
Chris@16: /*!
Chris@16: \brief Specialization to stream a ring as WKT
Chris@16: \details A ring or "linear_ring" does not exist in WKT.
Chris@16: A ring is equivalent to a polygon without inner rings
Chris@16: It is therefore streamed as a polygon
Chris@16: */
Chris@16: template <typename Ring>
Chris@16: struct wkt<Ring, ring_tag>
Chris@16:     : detail::wkt::wkt_range
Chris@16:         <
Chris@16:             Ring,
Chris@16:             detail::wkt::prefix_ring_par_par,
Chris@16:             detail::wkt::double_closing_parenthesis
Chris@16:         >
Chris@16: {};
Chris@16: 
Chris@16: /*!
Chris@16: \brief Specialization to stream polygon as WKT
Chris@16: */
Chris@16: template <typename Polygon>
Chris@16: struct wkt<Polygon, polygon_tag>
Chris@16:     : detail::wkt::wkt_poly
Chris@16:         <
Chris@16:             Polygon,
Chris@16:             detail::wkt::prefix_polygon
Chris@16:         >
Chris@16: {};
Chris@16: 
Chris@101: template <typename Multi>
Chris@101: struct wkt<Multi, multi_point_tag>
Chris@101:     : detail::wkt::wkt_multi
Chris@101:         <
Chris@101:             Multi,
Chris@101:             detail::wkt::wkt_point
Chris@101:                 <
Chris@101:                     typename boost::range_value<Multi>::type,
Chris@101:                     detail::wkt::prefix_null
Chris@101:                 >,
Chris@101:             detail::wkt::prefix_multipoint
Chris@101:         >
Chris@101: {};
Chris@101: 
Chris@101: template <typename Multi>
Chris@101: struct wkt<Multi, multi_linestring_tag>
Chris@101:     : detail::wkt::wkt_multi
Chris@101:         <
Chris@101:             Multi,
Chris@101:             detail::wkt::wkt_sequence
Chris@101:                 <
Chris@101:                     typename boost::range_value<Multi>::type
Chris@101:                 >,
Chris@101:             detail::wkt::prefix_multilinestring
Chris@101:         >
Chris@101: {};
Chris@101: 
Chris@101: template <typename Multi>
Chris@101: struct wkt<Multi, multi_polygon_tag>
Chris@101:     : detail::wkt::wkt_multi
Chris@101:         <
Chris@101:             Multi,
Chris@101:             detail::wkt::wkt_poly
Chris@101:                 <
Chris@101:                     typename boost::range_value<Multi>::type,
Chris@101:                     detail::wkt::prefix_null
Chris@101:                 >,
Chris@101:             detail::wkt::prefix_multipolygon
Chris@101:         >
Chris@101: {};
Chris@101: 
Chris@16: 
Chris@16: template <typename Geometry>
Chris@16: struct devarianted_wkt
Chris@16: {
Chris@16:     template <typename OutputStream>
Chris@16:     static inline void apply(OutputStream& os, Geometry const& geometry)
Chris@16:     {
Chris@16:         wkt<Geometry>::apply(os, geometry);
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@16: template <BOOST_VARIANT_ENUM_PARAMS(typename T)>
Chris@16: struct devarianted_wkt<variant<BOOST_VARIANT_ENUM_PARAMS(T)> >
Chris@16: {
Chris@16:     template <typename OutputStream>
Chris@16:     struct visitor: static_visitor<void>
Chris@16:     {
Chris@16:         OutputStream& m_os;
Chris@16: 
Chris@16:         visitor(OutputStream& os)
Chris@16:             : m_os(os)
Chris@16:         {}
Chris@16: 
Chris@16:         template <typename Geometry>
Chris@16:         inline void operator()(Geometry const& geometry) const
Chris@16:         {
Chris@16:             devarianted_wkt<Geometry>::apply(m_os, geometry);
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     template <typename OutputStream>
Chris@16:     static inline void apply(
Chris@16:         OutputStream& os,
Chris@16:         variant<BOOST_VARIANT_ENUM_PARAMS(T)> const& geometry
Chris@16:     )
Chris@16:     {
Chris@16:         apply_visitor(visitor<OutputStream>(os), geometry);
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@16: 
Chris@16: } // namespace dispatch
Chris@16: #endif // DOXYGEN_NO_DISPATCH
Chris@16: 
Chris@16: /*!
Chris@16: \brief Generic geometry template manipulator class, takes corresponding output class from traits class
Chris@16: \ingroup wkt
Chris@16: \details Stream manipulator, streams geometry classes as \ref WKT streams
Chris@16: \par Example:
Chris@16: Small example showing how to use the wkt class
Chris@16: \dontinclude doxygen_1.cpp
Chris@16: \skip example_as_wkt_point
Chris@16: \line {
Chris@16: \until }
Chris@16: */
Chris@16: template <typename Geometry>
Chris@16: class wkt_manipulator
Chris@16: {
Chris@16: public:
Chris@16: 
Chris@16:     inline wkt_manipulator(Geometry const& g)
Chris@16:         : m_geometry(g)
Chris@16:     {}
Chris@16: 
Chris@16:     template <typename Char, typename Traits>
Chris@16:     inline friend std::basic_ostream<Char, Traits>& operator<<(
Chris@16:             std::basic_ostream<Char, Traits>& os,
Chris@16:             wkt_manipulator const& m)
Chris@16:     {
Chris@16:         dispatch::devarianted_wkt<Geometry>::apply(os, m.m_geometry);
Chris@16:         os.flush();
Chris@16:         return os;
Chris@16:     }
Chris@16: 
Chris@16: private:
Chris@16:     Geometry const& m_geometry;
Chris@16: };
Chris@16: 
Chris@16: /*!
Chris@16: \brief Main WKT-streaming function
Chris@101: \tparam Geometry \tparam_geometry
Chris@101: \param geometry \param_geometry
Chris@16: \ingroup wkt
Chris@101: \qbk{[include reference/io/wkt.qbk]}
Chris@16: */
Chris@16: template <typename Geometry>
Chris@16: inline wkt_manipulator<Geometry> wkt(Geometry const& geometry)
Chris@16: {
Chris@16:     concept::check<Geometry const>();
Chris@16: 
Chris@16:     return wkt_manipulator<Geometry>(geometry);
Chris@16: }
Chris@16: 
Chris@16: #if defined(_MSC_VER)
Chris@16: #pragma warning(pop)  
Chris@16: #endif
Chris@16: 
Chris@16: }} // namespace boost::geometry
Chris@16: 
Chris@16: #endif // BOOST_GEOMETRY_IO_WKT_WRITE_HPP