GeometryFactory.h

/**********************************************************************
 *
 * GEOS - Geometry Engine Open Source
 * http://geos.osgeo.org
 *
 * Copyright (C) 2011 Sandro Santilli <strk@kbt.io>
 * Copyright (C) 2006 Refractions Research Inc.
 *
 * This is free software; you can redistribute and/or modify it under
 * the terms of the GNU Lesser General Public Licence as published
 * by the Free Software Foundation.
 * See the COPYING file for more information.
 *
 **********************************************************************
 *
 * Last port: geom/GeometryFactory.java r320 (JTS-1.12)
 *
 **********************************************************************/

#pragma once

#include <geos/geom/Geometry.h>
#include <geos/geom/GeometryCollection.h>
#include <geos/geom/GeometryFactory.h>
#include <geos/geom/MultiPoint.h>
#include <geos/geom/MultiLineString.h>
#include <geos/geom/MultiPolygon.h>
#include <geos/geom/PrecisionModel.h>
#include <geos/geom/Polygon.h>
#include <geos/util/IllegalArgumentException.h>
#include <geos/export.h>

#include <vector>
#include <memory>
#include <cassert>

namespace geos {
namespace geom {
class Coordinate;
class CircularString;
class CompoundCurve;
class CoordinateSequence;
class Envelope;
class Geometry;
class GeometryCollection;
class LineString;
class LinearRing;
class MultiLineString;
class MultiCurve;
class MultiPoint;
class MultiPolygon;
class MultiSurface;
class CurvePolygon;
}
}

namespace geos {
namespace geom { // geos::geom

class GEOS_DLL GeometryFactory {
private:

    struct GeometryFactoryDeleter {
        void
        operator()(GeometryFactory* p) const
        {
            p->destroy();
        }
    };

public:

    using Ptr = std::unique_ptr<GeometryFactory, GeometryFactoryDeleter>;

    static GeometryFactory::Ptr create();

    static GeometryFactory::Ptr create(const PrecisionModel* pm);

    static GeometryFactory::Ptr create(const PrecisionModel* pm, int newSRID);

    static GeometryFactory::Ptr create(const GeometryFactory& gf);

    static const GeometryFactory*
    getDefaultInstance();

//Skipped a lot of list to array converters

    static std::unique_ptr<Point> createPointFromInternalCoord(const Coordinate* coord,
                                        const Geometry* exemplar);

    std::unique_ptr<Geometry> toGeometry(const Envelope* envelope) const;

    const PrecisionModel* getPrecisionModel() const
    {
        return &precisionModel;
    };

    std::unique_ptr<Point> createPoint(std::size_t coordinateDimension = 2) const;
    std::unique_ptr<Point> createPoint(bool hasZ, bool hasM) const;

    std::unique_ptr<Point> createPoint(const Coordinate& coordinate) const;
    std::unique_ptr<Point> createPoint(const CoordinateXY& coordinate) const;
    std::unique_ptr<Point> createPoint(const CoordinateXYM& coordinate) const;
    std::unique_ptr<Point> createPoint(const CoordinateXYZM& coordinate) const;

    std::unique_ptr<Point> createPoint(std::unique_ptr<CoordinateSequence>&& coordinates) const;

    std::unique_ptr<Point> createPoint(const CoordinateSequence& coordinates) const;

    std::unique_ptr<GeometryCollection> createGeometryCollection() const;

    std::unique_ptr<Geometry> createEmptyGeometry(GeometryTypeId type = GEOS_GEOMETRYCOLLECTION, bool hasZ=false, bool hasM=false) const;

    template<typename T>
    std::unique_ptr<GeometryCollection> createGeometryCollection(
            std::vector<std::unique_ptr<T>> && newGeoms) const {
        // Can't use make_unique because constructor is protected
        return std::unique_ptr<GeometryCollection>(new GeometryCollection(Geometry::toGeometryArray(std::move(newGeoms)), *this));
    }

    std::unique_ptr<GeometryCollection> createGeometryCollection(
        const std::vector<const Geometry*>& newGeoms) const;

    std::unique_ptr<MultiLineString> createMultiLineString() const;

    std::unique_ptr<MultiLineString> createMultiLineString(
        const std::vector<const Geometry*>& fromLines) const;

    std::unique_ptr<MultiLineString> createMultiLineString(
            std::vector<std::unique_ptr<LineString>> && fromLines) const;

    std::unique_ptr<MultiLineString> createMultiLineString(
            std::vector<std::unique_ptr<Geometry>> && fromLines) const;

    std::unique_ptr<MultiCurve> createMultiCurve() const;

    std::unique_ptr<MultiCurve> createMultiCurve(
            std::vector<std::unique_ptr<Geometry>> && fromCurves) const;

    std::unique_ptr<MultiCurve> createMultiCurve(
            std::vector<std::unique_ptr<Curve>> && fromCurves) const;

    std::unique_ptr<MultiPolygon> createMultiPolygon() const;

    std::unique_ptr<MultiPolygon> createMultiPolygon(
        const std::vector<const Geometry*>& fromPolys) const;

    std::unique_ptr<MultiPolygon> createMultiPolygon(
        std::vector<std::unique_ptr<Polygon>> && fromPolys) const;

    std::unique_ptr<MultiPolygon> createMultiPolygon(
            std::vector<std::unique_ptr<Geometry>> && fromPolys) const;

    std::unique_ptr<MultiSurface> createMultiSurface() const;

    std::unique_ptr<MultiSurface> createMultiSurface(
            std::vector<std::unique_ptr<Geometry>> && from) const;

    std::unique_ptr<MultiSurface> createMultiSurface(
            std::vector<std::unique_ptr<Surface>> && from) const;

    std::unique_ptr<LinearRing> createLinearRing(std::size_t coordinateDimension = 2) const;
    std::unique_ptr<LinearRing> createLinearRing(bool hasZ, bool hasM) const;

    std::unique_ptr<LinearRing> createLinearRing(
        std::unique_ptr<CoordinateSequence> && newCoords) const;

    std::unique_ptr<LinearRing> createLinearRing(
        const CoordinateSequence& coordinates) const;

    std::unique_ptr<MultiPoint> createMultiPoint() const;

    template<typename T>
    std::unique_ptr<MultiPoint> createMultiPoint(const T& fromCoords) const
    {
        std::vector<std::unique_ptr<Geometry>> pts;
        pts.reserve(fromCoords.size());
        for (const auto& c : fromCoords) {
            pts.emplace_back(createPoint(c));
        }

        return createMultiPoint(std::move(pts));
    }

    std::unique_ptr<MultiPoint> createMultiPoint(std::vector<std::unique_ptr<Point>> && newPoints) const;

    std::unique_ptr<MultiPoint> createMultiPoint(std::vector<std::unique_ptr<Geometry>> && newPoints) const;

    std::unique_ptr<MultiPoint> createMultiPoint(
        const std::vector<const Geometry*>& fromPoints) const;

    std::unique_ptr<MultiPoint> createMultiPoint(
        const CoordinateSequence& fromCoords) const;

    std::unique_ptr<Polygon> createPolygon(std::size_t coordinateDimension = 2) const;
    std::unique_ptr<Polygon> createPolygon(bool hasZ, bool hasM) const;

    std::unique_ptr<Polygon> createPolygon(std::unique_ptr<LinearRing> && shell) const;

    std::unique_ptr<Polygon> createPolygon(std::unique_ptr<LinearRing> && shell,
                                           std::vector<std::unique_ptr<LinearRing>> && holes) const;

    std::unique_ptr<Polygon> createPolygon(CoordinateSequence && coords) const;

    Polygon* createPolygon(const LinearRing& shell,
                           const std::vector<LinearRing*>& holes) const;


    std::unique_ptr<CurvePolygon> createCurvePolygon(bool hasZ, bool hasM) const;

    std::unique_ptr<CurvePolygon> createCurvePolygon(std::unique_ptr<Curve>&& shell) const;

    std::unique_ptr<CurvePolygon> createCurvePolygon(std::unique_ptr<Curve>&& shell,
                                                     std::vector<std::unique_ptr<Curve>> && holes) const;

    std::unique_ptr<LineString> createLineString(std::size_t coordinateDimension = 2) const;
    std::unique_ptr<LineString> createLineString(bool hasZ, bool hasM) const;

    std::unique_ptr<LineString> createLineString(const LineString& ls) const;

    std::unique_ptr<LineString> createLineString(
        std::unique_ptr<CoordinateSequence> && coordinates) const;

    std::unique_ptr<LineString> createLineString(
        const CoordinateSequence& coordinates) const;

    std::unique_ptr<CircularString> createCircularString(bool hasZ, bool hasM) const;

    std::unique_ptr<CircularString> createCircularString(const CircularString& ls) const;

    std::unique_ptr<CircularString> createCircularString(
        std::unique_ptr<CoordinateSequence> && coordinates) const;

    std::unique_ptr<CircularString> createCircularString(
        const CoordinateSequence& coordinates) const;

    std::unique_ptr<CompoundCurve> createCompoundCurve() const;

    std::unique_ptr<CompoundCurve> createCompoundCurve(std::vector<std::unique_ptr<SimpleCurve>>&&) const;

    std::unique_ptr<Geometry> createEmpty(int dimension) const;

    std::unique_ptr<Geometry> createEmpty(GeometryTypeId typeId) const;

    std::unique_ptr<Geometry> createMulti(std::unique_ptr<Geometry> && geom) const;

    std::unique_ptr<Geometry> buildGeometry(std::vector<std::unique_ptr<Geometry>> && geoms) const;

    std::unique_ptr<Geometry> buildGeometry(std::vector<std::unique_ptr<Point>> && geoms) const;

    std::unique_ptr<Geometry> buildGeometry(std::vector<std::unique_ptr<LineString>> && geoms) const;

    std::unique_ptr<Geometry> buildGeometry(std::vector<std::unique_ptr<Polygon>> && geoms) const;

    //
    template <class T>
    std::unique_ptr<Geometry>
    buildGeometry(T from, T toofar) const
    {
        bool isHeterogeneous = false;
        std::size_t count = 0;
        int geomClass = -1;
        for(T i = from; i != toofar; ++i) {
            ++count;
            const Geometry* g = *i;
            if(geomClass < 0) {
                geomClass = g->getSortIndex();
            }
            else if(geomClass != g->getSortIndex()) {
                isHeterogeneous = true;
            }
        }

        // for the empty geometry, return an empty GeometryCollection
        if(count == 0) {
            return std::unique_ptr<Geometry>(createGeometryCollection());
        }

        // for the single geometry, return a clone
        if(count == 1) {
            return (*from)->clone();
        }

        // Now we know it is a collection

        // FIXME:
        // Until we tweak all the createMulti* interfaces
        // to support taking iterators we'll have to build
        // a custom vector here.
        std::vector<std::unique_ptr<Geometry>> fromGeoms;
        for(T i = from; i != toofar; ++i) {
            fromGeoms.push_back((*i)->clone());
        }

        // for an heterogeneous ...
        if(isHeterogeneous) {
            return createGeometryCollection(std::move(fromGeoms));
        }

        // At this point we know the collection is not hetereogenous.
        switch((*from)->getDimension()) {
            case Dimension::A: return createMultiPolygon(std::move(fromGeoms));
            case Dimension::L: return createMultiLineString(std::move(fromGeoms));
            case Dimension::P: return createMultiPoint(std::move(fromGeoms));
            default:
                throw geos::util::IllegalArgumentException(std::string("Invalid geometry type."));
        }
    }

    std::unique_ptr<Geometry> buildGeometry(const std::vector<const Geometry*>& geoms) const;

    int getSRID() const
    {
        return SRID;
    };

    std::unique_ptr<Geometry> createGeometry(const Geometry* g) const;

    void destroyGeometry(Geometry* g) const;

    void destroy();

protected:

    GeometryFactory();

    GeometryFactory(const PrecisionModel* pm);

    GeometryFactory(const PrecisionModel* pm, int newSRID);

    GeometryFactory(const GeometryFactory& gf);

    virtual ~GeometryFactory();

private:

    PrecisionModel precisionModel;
    int SRID;

    mutable int _refCount;
    bool _autoDestroy;

    friend class Geometry;

    void addRef() const;
    void dropRef() const;

};

} // namespace geos::geom
} // namespace geos