cleanup (#162)

* reorganise files so LibGEOS.jl is clean

* move generated file to its own folder

* geointerface never has an underscore

* sort function names

Author: rafaqz

gen/generator.toml

@@ -1,6 +1,6 @@
 [general]
 library_name = "libgeos"
-output_file_path = "../src/libgeos_api.jl"
+output_file_path = "../src/generated/libgeos_api.jl"
 # prologue_file_path = "prologue.jl"
 use_julia_native_enum_type = false
 print_using_CEnum = false

src/LibGEOS.jl

@@ -8,253 +8,100 @@ using CEnum
 
 const GI = GeoInterface
 
-export Point,
-    MultiPoint,
+export GeometryCollection,
     LineString,
-    MultiLineString,
     LinearRing,
-    Polygon,
+    MultiLineString,
+    MultiPoint,
     MultiPolygon,
-    GeometryCollection,
-    readgeom,
-    writegeom,
-    project,
-    projectNormalized,
-    interpolate,
-    interpolateNormalized,
+    Point,
+    Polygon,
+    STRtree
+
+export 
+    area,
+    boundary,
     buffer,
     bufferWithStyle,
-    envelope,
-    intersection,
-    convexhull,
-    difference,
-    symmetricDifference,
-    boundary,
-    union,
-    unaryUnion,
-    pointOnSurface,
     centroid,
-    node,
-    polygonize,
-    lineMerge,
-    simplify,
-    topologyPreserveSimplify,
-    uniquePoints,
-    sharedPaths,
-    snap,
+    constrainedDelaunayTriangulation,
+    containsproperly,
+    convexhull,
+    coveredby,
+    covers,
+    crosses,
     delaunayTriangulation,
     delaunayTriangulationEdges,
-    constrainedDelaunayTriangulation,
+    difference,
     disjoint,
-    touches,
-    intersects,
-    crosses,
-    within,
-    overlaps,
+    distance,
+    endPoint,
+    envelope,
     equals,
     equalsexact,
-    containsproperly,
-    covers,
-    coveredby,
-    prepareGeom,
-    isEmpty,
-    isSimple,
-    isRing,
-    hasZ,
-    isClosed,
-    isValid,
-    interiorRing,
-    interiorRings,
     exteriorRing,
-    numGeometries,
-    numPoints,
-    startPoint,
-    endPoint,
-    area,
     geomLength,
-    distance,
-    hausdorffdistance,
-    nearestPoints,
+    getGeometries,
+    getGeometry,
     getPrecision,
-    setPrecision,
-    getXMin,
-    getYMin,
     getXMax,
+    getXMin,
     getYMax,
+    getYMin,
+    hasZ,
+    hausdorffdistance,
+    interiorRing,
+    interiorRings,
+    interpolate,
+    interpolateNormalized,
+    intersection,
+    intersects,
+    isClosed,
+    isEmpty,
+    isRing,
+    isSimple,
+    isValid,
+    lineMerge,
     minimumRotatedRectangle,
-    getGeometry,
-    getGeometries,
-    STRtree,
-    query
-
-mutable struct GEOSError <: Exception
-    msg::String
-end
-Base.showerror(io::IO, err::GEOSError) = print(io, "GEOSError\n\t$(err.msg)")
-
-function geosjl_errorhandler(message::Ptr{UInt8}, userdata)
-    if unsafe_string(message) == "%s"
-        throw(GEOSError(unsafe_string(Cstring(userdata))))
-    else
-        throw(GEOSError(unsafe_string(message)))
-    end
-end
-
-"""
-
-    GEOSContext
-
-Every LibGEOS object needs to live somewhere in memory. Also many LibGEOS functions
-need scratch memory or caches to do their job.
-
-A `GEOSContext` governs such memory. Almost every function in LibGEOS accepts a `context`
-argument, that allows passing a context explicitly. If no context is passed, a global context is used.
-
-Using the global context is fine, as long as no multi threading is used.
-If multi threading is used, the global context should be avoided and every operation should only
-involve objects that live in the context passed to the operation.
-"""
-mutable struct GEOSContext
-    ptr::Ptr{Cvoid}  # GEOSContextHandle_t
-
-    function GEOSContext()
-        context = new(GEOS_init_r())
-        GEOSContext_setNoticeHandler_r(context, C_NULL)
-        GEOSContext_setErrorHandler_r(
-            context,
-            @cfunction(geosjl_errorhandler, Ptr{Cvoid}, (Ptr{UInt8}, Ptr{Cvoid}))
-        )
-        finalizer(context -> (GEOS_finish_r(context); context.ptr = C_NULL), context)
-        context
-    end
-end
-
-function Base.:(==)(c1::GEOSContext, c2::GEOSContext)
-    (c1.ptr == c2.ptr)
-end
-function Base.hash(c::GEOSContext, h::UInt)
-    hash(c.ptr, h)
-end
-
-"Get a copy of a string from GEOS, freeing the GEOS managed memory."
-function string_copy_free(s::Cstring, context::GEOSContext = get_global_context())::String
-    copy = unsafe_string(s)
-    GEOSFree_r(context, pointer(s))
-    return copy
-end
-
-include("libgeos_api.jl")
-
-mutable struct WKTReader
-    ptr::Ptr{GEOSWKTReader}
-
-    function WKTReader(context::GEOSContext)
-        reader = new(GEOSWKTReader_create_r(context))
-        finalizer(function (reader)
-            GEOSWKTReader_destroy_r(context, reader)
-            reader.ptr = C_NULL
-        end, reader)
-        reader
-    end
-end
-
-mutable struct WKTWriter
-    ptr::Ptr{GEOSWKTWriter}
-
-    function WKTWriter(
-        context::GEOSContext;
-        trim::Bool = true,
-        outputdim::Int = 3,
-        roundingprecision::Int = -1,
-    )
-        writer = new(GEOSWKTWriter_create_r(context))
-        GEOSWKTWriter_setTrim_r(context, writer, UInt8(trim))
-        GEOSWKTWriter_setOutputDimension_r(context, writer, outputdim)
-        GEOSWKTWriter_setRoundingPrecision_r(context, writer, roundingprecision)
-        finalizer(function (writer)
-            GEOSWKTWriter_destroy_r(context, writer)
-            writer.ptr = C_NULL
-        end, writer)
-        writer
-    end
-end
-
-mutable struct WKBReader
-    ptr::Ptr{GEOSWKBReader}
-
-    function WKBReader(context::GEOSContext)
-        reader = new(GEOSWKBReader_create_r(context))
-        finalizer(function (reader)
-            GEOSWKBReader_destroy_r(context, reader)
-            reader.ptr = C_NULL
-        end, reader)
-        reader
-    end
-end
-
-mutable struct WKBWriter
-    ptr::Ptr{GEOSWKBWriter}
-
-    function WKBWriter(context::GEOSContext)
-        writer = new(GEOSWKBWriter_create_r(context))
-        finalizer(function (writer)
-            GEOSWKBWriter_destroy_r(context, writer)
-            writer.ptr = C_NULL
-        end, writer)
-        writer
-    end
-end
-
-const _GLOBAL_CONTEXT = Ref{GEOSContext}()
-const _GLOBAL_CONTEXT_ALLOWED = Ref(false)
-
-function get_global_context()::GEOSContext
-    if _GLOBAL_CONTEXT_ALLOWED[]
-        _GLOBAL_CONTEXT[]
-    else
-        msg = """
-        LibGEOS global context disallowed, a `GEOSContext` must be passed explicitly.
-        Alternatively you can allow the global context by calling:
-        `LibGEOS.allow_global_context!(true)`
-        """
-        error(msg)
-    end
-end
-
-"""
-
-    allow_global_context!(bool::Bool)
-
-Allow (bool=true) or disallow (bool=false) using the global LibGEOS context.
-
-
-    allow_global_context!(f, bool::Bool)
-
-Call `f` with global context usage allowed according to `bool`
-
-Generally this function should only be used as a debugging tool, mostly for multithreaded programs.
-See also [`GEOSContext`](@ref).
-"""
-function allow_global_context!(bool::Bool)
-    _GLOBAL_CONTEXT_ALLOWED[] = bool
-end
+    nearestPoints,
+    node,
+    numGeometries,
+    numPoints,
+    overlaps,
+    pointOnSurface,
+    polygonize,
+    prepareGeom,
+    project,
+    projectNormalized,
+    query,
+    readgeom,
+    setPrecision,
+    sharedPaths,
+    simplify,
+    snap,
+    startPoint,
+    symmetricDifference,
+    topologyPreserveSimplify,
+    touches,
+    unaryUnion,
+    union,
+    uniquePoints,
+    within,
+    writegeom
 
-function allow_global_context!(f, bool::Bool)
-    old = _GLOBAL_CONTEXT_ALLOWED[]
-    allow_global_context!(bool)
-    f()
-    allow_global_context!(old)
-end
+include("generated/libgeos_api.jl")
+include("error.jl")
+include("context.jl")
+include("wellknown.jl")
+include("geos_types.jl")
+include("geos_functions.jl")
+include("geointerface.jl")
+include("strtree.jl")
+include("deprecated.jl")
 
 function __init__()
     _GLOBAL_CONTEXT_ALLOWED[] = true
     _GLOBAL_CONTEXT[] = GEOSContext()
 end
 
-include("geos_types.jl")
-include("geos_functions.jl")
-include("geo_interface.jl")
-include("strtree.jl")
-include("deprecated.jl")
-
 end  # module