<?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\data\runtime;

use pocketmine\block\utils\BrewingStandSlot;
use pocketmine\block\utils\WallConnectionType;
use pocketmine\math\Facing;

/**
 * Interface implemented by {@link RuntimeDataReader}, {@link RuntimeDataWriter} and {@link RuntimeDataSizeCalculator}.
 * Used to describe the structure of runtime data to an implementation.
 *
 * This interface should be considered **sealed**.
 * You may use it as a type for parameters and return values, but it should not be implemented outside of this package.
 * New methods may be added without warning.
 */
interface RuntimeDataDescriber extends RuntimeEnumDescriber{
	public function int(int $bits, int &$value) : void;

	/**
	 * @deprecated Use {@link RuntimeDataDescriber::boundedIntAuto()} instead.
	 */
	public function boundedInt(int $bits, int $min, int $max, int &$value) : void;

	/**
	 * Same as boundedInt() but automatically calculates the required number of bits from the range.
	 * The range bounds must be constant.
	 */
	public function boundedIntAuto(int $min, int $max, int &$value) : void;

	public function bool(bool &$value) : void;

	public function horizontalFacing(int &$facing) : void;

	/**
	 * @param int[] $faces
	 */
	public function facingFlags(array &$faces) : void;

	/**
	 * @param int[] $faces
	 */
	public function horizontalFacingFlags(array &$faces) : void;

	public function facing(int &$facing) : void;

	public function facingExcept(int &$facing, int $except) : void;

	public function axis(int &$axis) : void;

	public function horizontalAxis(int &$axis) : void;

	/**
	 * @param WallConnectionType[] $connections
	 * @phpstan-param array<Facing::NORTH|Facing::EAST|Facing::SOUTH|Facing::WEST, WallConnectionType> $connections
	 */
	public function wallConnections(array &$connections) : void;

	/**
	 * @param BrewingStandSlot[] $slots
	 * @phpstan-param array<int, BrewingStandSlot> $slots
	 *
	 * @deprecated Use {@link enumSet()} instead.
	 */
	public function brewingStandSlots(array &$slots) : void;

	public function railShape(int &$railShape) : void;

	public function straightOnlyRailShape(int &$railShape) : void;

	/**
	 * @phpstan-template T of \UnitEnum
	 * @phpstan-param T &$case
	 * @phpstan-param-out T $case
	 */
	public function enum(\UnitEnum &$case) : void;

	/**
	 * @param \UnitEnum[] &$set
	 * @param \UnitEnum[] $allCases
	 *
	 * @phpstan-template T of \UnitEnum
	 * @phpstan-param array<int, T> &$set
	 * @phpstan-param array<int, T> $allCases
	 */
	public function enumSet(array &$set, array $allCases) : void;
}