BinaryStream.php

<?php
 
/*
 *
 *  ____            _        _   __  __ _                  __  __ ____
 * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
 * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
 * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
 * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * @author PocketMine Team
 * @link http://www.pocketmine.net/
 *
 *
*/
 
declare(strict_types=1);
 
namespace pocketmine\utils;
 
use function chr;
use function ord;
use function strlen;
use function substr;
 
class BinaryStream{
    //TODO: use typed properties when https://bugs.php.net/bug.php?id=81090 is fixed
 
    protected $offset;
    protected $buffer;
 
    public function __construct(string $buffer = "", int $offset = 0){
        $this->buffer = $buffer;
        $this->offset = $offset;
    }
 
    public function rewind() : void{
        $this->offset = 0;
    }
 
    public function setOffset(int $offset) : void{
        $this->offset = $offset;
    }
 
    public function getOffset() : int{
        return $this->offset;
    }
 
    public function getBuffer() : string{
        return $this->buffer;
    }
 
    public function get(int $len) : string{
        if($len === 0){
            return "";
        }
        if($len < 0){
            throw new \InvalidArgumentException("Length must be positive");
        }
 
        $remaining = strlen($this->buffer) - $this->offset;
        if($remaining < $len){
            throw new BinaryDataException("Not enough bytes left in buffer: need $len, have $remaining");
        }
 
        return $len === 1 ? $this->buffer[$this->offset++] : substr($this->buffer, ($this->offset += $len) - $len, $len);
    }
 
    public function getRemaining() : string{
        $buflen = strlen($this->buffer);
        if($this->offset >= $buflen){
            throw new BinaryDataException("No bytes left to read");
        }
        $str = substr($this->buffer, $this->offset);
        $this->offset = $buflen;
        return $str;
    }
 
    public function put(string $str) : void{
        $this->buffer .= $str;
    }
 
    public function getBool() : bool{
        return $this->get(1) !== "\x00";
    }
 
    public function putBool(bool $v) : void{
        $this->buffer .= ($v ? "\x01" : "\x00");
    }
 
    public function getByte() : int{
        return ord($this->get(1));
    }
 
    public function putByte(int $v) : void{
        $this->buffer .= chr($v);
    }
 
    public function getShort() : int{
        return Binary::readShort($this->get(2));
    }
 
    public function getSignedShort() : int{
        return Binary::readSignedShort($this->get(2));
    }
 
    public function putShort(int $v) : void{
        $this->buffer .= Binary::writeShort($v);
    }
 
    public function getLShort() : int{
        return Binary::readLShort($this->get(2));
    }
 
    public function getSignedLShort() : int{
        return Binary::readSignedLShort($this->get(2));
    }
 
    public function putLShort(int $v) : void{
        $this->buffer .= Binary::writeLShort($v);
    }
 
    public function getTriad() : int{
        return Binary::readTriad($this->get(3));
    }
 
    public function putTriad(int $v) : void{
        $this->buffer .= Binary::writeTriad($v);
    }
 
    public function getLTriad() : int{
        return Binary::readLTriad($this->get(3));
    }
 
    public function putLTriad(int $v) : void{
        $this->buffer .= Binary::writeLTriad($v);
    }
 
    public function getInt() : int{
        return Binary::readInt($this->get(4));
    }
 
    public function putInt(int $v) : void{
        $this->buffer .= Binary::writeInt($v);
    }
 
    public function getLInt() : int{
        return Binary::readLInt($this->get(4));
    }
 
    public function putLInt(int $v) : void{
        $this->buffer .= Binary::writeLInt($v);
    }
 
    public function getFloat() : float{
        return Binary::readFloat($this->get(4));
    }
 
    public function getRoundedFloat(int $accuracy) : float{
        return Binary::readRoundedFloat($this->get(4), $accuracy);
    }
 
    public function putFloat(float $v) : void{
        $this->buffer .= Binary::writeFloat($v);
    }
 
    public function getLFloat() : float{
        return Binary::readLFloat($this->get(4));
    }
 
    public function getRoundedLFloat(int $accuracy) : float{
        return Binary::readRoundedLFloat($this->get(4), $accuracy);
    }
 
    public function putLFloat(float $v) : void{
        $this->buffer .= Binary::writeLFloat($v);
    }
 
    public function getDouble() : float{
        return Binary::readDouble($this->get(8));
    }
 
    public function putDouble(float $v) : void{
        $this->buffer .= Binary::writeDouble($v);
    }
 
    public function getLDouble() : float{
        return Binary::readLDouble($this->get(8));
    }
 
    public function putLDouble(float $v) : void{
        $this->buffer .= Binary::writeLDouble($v);
    }
 
    public function getLong() : int{
        return Binary::readLong($this->get(8));
    }
 
    public function putLong(int $v) : void{
        $this->buffer .= Binary::writeLong($v);
    }
 
    public function getLLong() : int{
        return Binary::readLLong($this->get(8));
    }
 
    public function putLLong(int $v) : void{
        $this->buffer .= Binary::writeLLong($v);
    }
 
    public function getUnsignedVarInt() : int{
        return Binary::readUnsignedVarInt($this->buffer, $this->offset);
    }
 
    public function putUnsignedVarInt(int $v) : void{
        $this->put(Binary::writeUnsignedVarInt($v));
    }
 
    public function getVarInt() : int{
        return Binary::readVarInt($this->buffer, $this->offset);
    }
 
    public function putVarInt(int $v) : void{
        $this->put(Binary::writeVarInt($v));
    }
 
    public function getUnsignedVarLong() : int{
        return Binary::readUnsignedVarLong($this->buffer, $this->offset);
    }
 
    public function putUnsignedVarLong(int $v) : void{
        $this->buffer .= Binary::writeUnsignedVarLong($v);
    }
 
    public function getVarLong() : int{
        return Binary::readVarLong($this->buffer, $this->offset);
    }
 
    public function putVarLong(int $v) : void{
        $this->buffer .= Binary::writeVarLong($v);
    }
 
    public function feof() : bool{
        return !isset($this->buffer[$this->offset]);
    }
}