Add methods for casting between signed and unsigned counterparts

olafkryus · Apr 4, 2020 · d4a3e78 · d4a3e78
1 parent 15e34a8
commit d4a3e78
Show file tree

Hide file tree

Showing 6 changed files with 138 additions and 0 deletions.
diff --git a/src/DataType/Byte.php b/src/DataType/Byte.php
@@ -19,4 +19,26 @@ public function __construct(string $value, int $endianness = BinaryValue::ENDIAN
 
         parent::__construct($value, $endianness);
     }
+
+    /**
+     * @return UnsignedByte
+     * @throws \Exception
+     */
+    public function asUnsigned(): UnsignedByte
+    {
+        return new UnsignedByte($this->__toString(), $this->getEndianness());
+    }
+
+    /**
+     * @return UnsignedByte
+     * @throws \Exception
+     */
+    public function toUnsigned(): UnsignedByte
+    {
+        if ($this->toInt() < 0) {
+            throw new \Exception("Value too small for type Unsigned Byte.");
+        }
+
+        return $this->asUnsigned();
+    }
 }
diff --git a/src/DataType/Dword.php b/src/DataType/Dword.php
@@ -19,4 +19,26 @@ public function __construct(string $value, int $endianness = BinaryValue::ENDIAN
 
         parent::__construct($value, $endianness);
     }
+
+    /**
+     * @return UnsignedDword
+     * @throws \Exception
+     */
+    public function asUnsigned(): UnsignedDword
+    {
+        return new UnsignedDword($this->__toString(), $this->getEndianness());
+    }
+
+    /**
+     * @return UnsignedDword
+     * @throws \Exception
+     */
+    public function toUnsigned(): UnsignedDword
+    {
+        if ($this->toInt() < 0) {
+            throw new \Exception("Value too small for type Unsigned Dword.");
+        }
+
+        return $this->asUnsigned();
+    }
 }
diff --git a/src/DataType/UnsignedByte.php b/src/DataType/UnsignedByte.php
@@ -20,6 +20,30 @@ public function __construct(string $value, int $endianness = BinaryValue::ENDIAN
         parent::__construct($value, $endianness, false);
     }
 
+    /**
+     * @return Byte
+     * @throws \Exception
+     */
+    public function asSigned(): Byte
+    {
+        return new Byte($this->__toString(), $this->getEndianness());
+    }
+
+    /**
+     * @return Byte
+     * @throws \Exception
+     */
+    public function toSigned(): Byte
+    {
+        $value = $this->asSigned();
+
+        if ($value->toInt() < 0) {
+            throw new \Exception("Value too big for type Byte.");
+        }
+
+        return $value;
+    }
+
     /**
      * @return int
      */

diff --git a/src/DataType/UnsignedDword.php b/src/DataType/UnsignedDword.php
@@ -20,6 +20,30 @@ public function __construct(string $value, int $endianness = BinaryValue::ENDIAN
         parent::__construct($value, $endianness, false);
     }
 
+    /**
+     * @return Dword
+     * @throws \Exception
+     */
+    public function asSigned(): Dword
+    {
+        return new Dword($this->__toString(), $this->getEndianness());
+    }
+
+    /**
+     * @return Dword
+     * @throws \Exception
+     */
+    public function toSigned(): Dword
+    {
+        $value = $this->asSigned();
+
+        if ($value->toInt() < 0) {
+            throw new \Exception("Value too big for type Dword.");
+        }
+
+        return $value;
+    }
+
     /**
      * @return UnsignedWord
      * @throws \Exception

diff --git a/src/DataType/UnsignedWord.php b/src/DataType/UnsignedWord.php
@@ -20,6 +20,30 @@ public function __construct(string $value, int $endianness = BinaryValue::ENDIAN
         parent::__construct($value, $endianness, false);
     }
 
+    /**
+     * @return Word
+     * @throws \Exception
+     */
+    public function asSigned(): Word
+    {
+        return new Word($this->__toString(), $this->getEndianness());
+    }
+
+    /**
+     * @return Word
+     * @throws \Exception
+     */
+    public function toSigned(): Word
+    {
+        $value = $this->asSigned();
+
+        if ($value->toInt() < 0) {
+            throw new \Exception("Value too big for type Word.");
+        }
+
+        return $value;
+    }
+
     /**
      * @return UnsignedByte
      * @throws \Exception

diff --git a/src/DataType/Word.php b/src/DataType/Word.php
@@ -19,4 +19,26 @@ public function __construct(string $value, int $endianness = BinaryValue::ENDIAN
 
         parent::__construct($value, $endianness);
     }
+
+    /**
+     * @return UnsignedWord
+     * @throws \Exception
+     */
+    public function asUnsigned(): UnsignedWord
+    {
+        return new UnsignedWord($this->__toString(), $this->getEndianness());
+    }
+
+    /**
+     * @return UnsignedWord
+     * @throws \Exception
+     */
+    public function toUnsigned(): UnsignedWord
+    {
+        if ($this->toInt() < 0) {
+            throw new \Exception("Value too small for type Unsigned Word.");
+        }
+
+        return $this->asUnsigned();
+    }
 }