Rewrite, added abstract method APIs

Author: SOF3

.editorconfig

@@ -0,0 +1,23 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+trim_trailing_whitespace = true
+
+[*.php]
+indent_style = tab
+indent_size = 4
+
+[*.json]
+indent_style = tab
+indent_size = 4
+
+[*.md]
+indent_style = space
+indent_size = 4
+
+[*.yml]
+indent_style = space
+indent_size = 2

README.md

@@ -4,3 +4,20 @@ An object-oriented path manipulation library in PHP.
 The API and implementation is largely based on the [rust `std::path` implementation](https://github.com/rust-lang/rust/blob/d8bdb3fdcbd88eb16e1a6669236122c41ed2aed3/src/libstd/path.rs).
 
 (I was listening to Tchaikovsky's Pathetique when I wrote this)
+
+## Platform behaviour
+Paths can be constructed for a specific `Platform` (either Windows or Unix)
+such that Windows paths can be interpreted correctly on Unix systems
+(although, apparently, they cannot be used to interact with the filesystem).
+
+All methods that interact with the filesystem would throw a `PlatformMismatchException`
+if a path for a different platform is used.
+This will never happen if all paths are costructed with specifying a platform.
+
+Some relative paths may be converted across platforms using `$path->toCurrentPlatform()`.
+
+## Serialization
+The path can be serialized using the PHP `serialize()` function.
+The serialized data include the platform that the path is constructed for,
+so paths can be deserialized on a different platform
+and still retain some correct behaviour.

src/Component.php

@@ -4,13 +4,17 @@
 
 namespace SOFe\Pathetique;
 
-final class Component {
-	public const PREFIX = 1;
-	public const ROOT_DIR = 2;
-	public const CURRENT_DIR = 3;
-	public const PARENT_DIR = 4;
-	public const NORMAL = 5;
+interface Component {
+	/**
+	 * Returns the directory-separator-free string for this component.
+	 *
+	 * Note that the leading `\` in `\\server\share` on DOS is not considered a directory separator,
+	 * while the leading `/` in a Unix absolute path is considered a directory separator.
+	 *
+	 * Consequently, joining `toString()` of all components with `Platform->getDirectorySeparator()`
+	 * yields the original path.
+	 */
+	public function toString() : string;
 
-	private function __construct() {
-	}
+	public function __toString() : string;
 }

src/CurrentDirectoryComponent.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace SOFe\Pathetique;
+
+/**
+ * A `.` component.
+ */
+final class CurrentDirectoryComponent implements Component {
+	public function toString() : string {
+		return ".";
+	}
+
+	public function __toString() : string {
+		return ".";
+	}
+}

src/DeviceNsPrefix.php

@@ -4,29 +4,15 @@
 
 namespace SOFe\Pathetique;
 
-use function strlen;
-
-final class DeviceNsPrefix extends Prefix {
-	/** @var string */
-	private $device;
-
-	public function __construct(string $device) {
-		$this->device = $device;
-	}
-
-	public function getDevice() : string {
-		return $this->device;
-	}
-
-	public function getFullPrefix() : string {
-		return "\\\\.\\{$this->device}";
-	}
-
-	public function getLength() : int {
-		return 4 + strlen($this->device);
+/**
+ * A Windows device namespace path prefix, e.g. `\\.\COM42`.
+ */
+final class DeviceNsPrefix implements Prefix {
+	public function toString() : string {
+		// TODO unimplemented
 	}
 
-	public function isVerbatim() : bool {
-		return false;
+	public function __toString() : string {
+		// TODO unimplemented
 	}
 }

src/DiskPrefix.php

@@ -4,27 +4,15 @@
 
 namespace SOFe\Pathetique;
 
-final class DiskPrefix extends Prefix {
-	/** @var string */
-	private $drive;
-
-	public function __construct(string $drive) {
-		$this->drive = $drive;
-	}
-
-	public function getDrive() : string {
-		return $this->drive;
-	}
-
-	public function getFullPrefix() : string {
-		return "{$this->drive}:";
-	}
-
-	public function getLength() : int {
-		return 1 + 1;
+/**
+ * A normal Windows path prefix with a disk drive, e.g. `C:\`.
+ */
+final class DiskPrefix implements Prefix {
+	public function toString() : string {
+		// TODO unimplemented
 	}
 
-	public function isVerbatim() : bool {
-		return true;
+	public function __toString() : string {
+		// TODO unimplemented
 	}
 }

src/IOException.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace SOFe\Pathetique;
+
+use Exception;
+
+class IOException extends Exception {
+}

src/NormalComponent.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace SOFe\Pathetique;
+
+/**
+ * A normal path component.
+ */
+final class NormalComponent implements Component {
+	public function toString() : string {
+		// TODO unimplemented
+	}
+
+	public function __toString() : string {
+		// TODO unimplemented
+	}
+}

src/ParentDirectoryComponent.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace SOFe\Pathetique;
+
+/**
+ * A `..` component.
+ */
+final class ParentDirectoryComponent implements Component {
+	public function toString() : string {
+		return "..";
+	}
+
+	public function __toString() : string {
+		return "..";
+	}
+}