WIP: empty point NaN

Author: BenMorel

src/Io/EwkbReader.php

@@ -17,6 +17,12 @@
  */
 final readonly class EwkbReader extends AbstractWkbReader
 {
+    public function __construct(
+        bool $supportEmptyPointWithNan = true,
+    ) {
+        parent::__construct($supportEmptyPointWithNan);
+    }
+
     /**
      * @throws GeometryIoException
      */

src/Io/EwkbWriter.php

@@ -4,8 +4,10 @@
 
 namespace Brick\Geo\Io;
 
+use Brick\Geo\Exception\GeometryIoException;
 use Brick\Geo\Geometry;
 use Brick\Geo\Io\Internal\AbstractWkbWriter;
+use Brick\Geo\Io\Internal\WkbByteOrder;
 use Brick\Geo\Io\Internal\WkbTools;
 use Override;
 
@@ -14,6 +16,18 @@
  */
 final readonly class EwkbWriter extends AbstractWkbWriter
 {
+    /**
+     * @param bool $supportEmptyPointWithNan Whether to support PostGIS-style empty points with NaN coordinates.
+     *
+     * @throws GeometryIoException
+     */
+    public function __construct(
+        ?WkbByteOrder $byteOrder = null,
+        bool $supportEmptyPointWithNan = true,
+    ) {
+        parent::__construct($byteOrder, $supportEmptyPointWithNan);
+    }
+
     #[Override]
     protected function packHeader(Geometry $geometry, bool $outer) : string
     {

src/Io/Internal/AbstractWkbReader.php

@@ -29,6 +29,19 @@
  */
 abstract readonly class AbstractWkbReader
 {
+    /**
+     * Whether to support PostGIS-style empty points with NaN coordinates.
+     * This is not part of the WKB standard.
+     * This will be disabled by default in WKB, but enabled by default in EWKB.
+     */
+    private bool $supportEmptyPointWithNan;
+
+    public function __construct(
+        bool $supportEmptyPointWithNan,
+    ) {
+        $this->supportEmptyPointWithNan = $supportEmptyPointWithNan;
+    }
+
     /**
      * @throws GeometryIoException
      */

src/Io/Internal/AbstractWkbWriter.php

@@ -26,13 +26,23 @@
     private WkbByteOrder $byteOrder;
     private WkbByteOrder $machineByteOrder;
 
+    /**
+     * Whether to support PostGIS-style empty points with NaN coordinates.
+     * This is not part of the WKB standard.
+     * This will be disabled by default in WKB, but enabled by default in EWKB.
+     */
+    private bool $supportEmptyPointWithNan;
+
     /**
      * @throws GeometryIoException
      */
-    public function __construct(?WkbByteOrder $byteOrder = null)
-    {
+    public function __construct(
+        ?WkbByteOrder $byteOrder = null,
+        bool $supportEmptyPointWithNan,
+    ) {
         $this->machineByteOrder = WkbTools::getMachineByteOrder();
         $this->byteOrder = $byteOrder ?? $this->machineByteOrder;
+        $this->supportEmptyPointWithNan = $supportEmptyPointWithNan;
     }
 
     /**

src/Io/WkbReader.php

@@ -17,6 +17,12 @@
  */
 final readonly class WkbReader extends AbstractWkbReader
 {
+    public function __construct(
+        bool $supportEmptyPointWithNan = false,
+    ) {
+        parent::__construct($supportEmptyPointWithNan);
+    }
+
     /**
      * @param string $wkb  The WKB to read.
      * @param int    $srid The optional SRID of the geometry.

src/Io/WkbWriter.php

@@ -4,15 +4,29 @@
 
 namespace Brick\Geo\Io;
 
+use Brick\Geo\Exception\GeometryIoException;
 use Brick\Geo\Geometry;
 use Brick\Geo\Io\Internal\AbstractWkbWriter;
+use Brick\Geo\Io\Internal\WkbByteOrder;
 use Override;
 
 /**
  * Writes geometries in the WKB format.
  */
 final readonly class WkbWriter extends AbstractWkbWriter
 {
+    /**
+     * @param bool $supportEmptyPointWithNan Whether to support PostGIS-style empty points with NaN coordinates.
+     *
+     * @throws GeometryIoException
+     */
+    public function __construct(
+        ?WkbByteOrder $byteOrder = null,
+        bool $supportEmptyPointWithNan = false,
+    ) {
+        parent::__construct($byteOrder, $supportEmptyPointWithNan);
+    }
+
     #[Override]
     protected function packHeader(Geometry $geometry, bool $outer) : string
     {