Publish script used to generate ItemTypeIds

build/generate-item-ids.php

@@ -0,0 +1,95 @@
+<?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\build\generate_item_serializer_ids;
+
+use pocketmine\errorhandler\ErrorToExceptionHandler;
+use pocketmine\network\mcpe\convert\ItemTypeDictionaryFromDataHelper;
+use pocketmine\network\mcpe\protocol\serializer\ItemTypeDictionary;
+use pocketmine\utils\Utils;
+use function asort;
+use function count;
+use function dirname;
+use function explode;
+use function fclose;
+use function file_get_contents;
+use function fopen;
+use function fwrite;
+use function strtoupper;
+
+require dirname(__DIR__) . '/vendor/autoload.php';
+
+function constifyMcId(string $id) : string{
+	return strtoupper(explode(":", $id, 2)[1]);
+}
+
+function generateItemIds(ItemTypeDictionary $dictionary) : void{
+	$ids = [];
+	foreach($dictionary->getEntries() as $entry){
+		if($entry->getNumericId() < 256){ //blockitems are serialized via BlockStateSerializer
+			continue;
+		}
+		$ids[$entry->getStringId()] = $entry->getStringId();
+	}
+	asort($ids, SORT_STRING);
+
+	$file = ErrorToExceptionHandler::trapAndRemoveFalse(fn() => fopen(dirname(__DIR__) . '/src/data/bedrock/item/ItemTypeIds.php', 'wb'));
+
+	fwrite($file, <<<'HEADER'
+<?php
+
+declare(strict_types=1);
+
+namespace pocketmine\data\bedrock\item;
+
+/**
+ * This class is generated automatically from the item type dictionary for the current version. Do not edit it manually.
+ */
+final class ItemTypeIds{
+
+HEADER
+	);
+
+	foreach(Utils::stringifyKeys($ids) as $id){
+		fwrite($file, "\tpublic const " . constifyMcId($id) . " = \"" . $id . "\";\n");
+	}
+	fwrite($file, "}\n");
+	fclose($file);
+}
+
+if(count($argv) !== 2){
+	fwrite(STDERR, "This script regenerates ItemTypeIds from a given item dictionary file\n");
+	fwrite(STDERR, "Required argument: path to item type dictionary file\n");
+	exit(1);
+}
+
+$raw = file_get_contents($argv[1]);
+if($raw === false){
+	fwrite(STDERR, "Failed to read item type dictionary file\n");
+	exit(1);
+}
+
+$dictionary = ItemTypeDictionaryFromDataHelper::loadFromString($raw);
+generateItemIds($dictionary);
+
+echo "Done. Don't forget to run CS fixup after generating code.\n";

src/data/bedrock/item/ItemTypeIds.php

@@ -23,6 +23,9 @@ declare(strict_types=1);
 
 namespace pocketmine\data\bedrock\item;
 
+/**
+ * This class is generated automatically from the item type dictionary for the current version. Do not edit it manually.
+ */
 final class ItemTypeIds{
 	public const ACACIA_BOAT = "minecraft:acacia_boat";
 	public const ACACIA_CHEST_BOAT = "minecraft:acacia_chest_boat";

src/network/mcpe/convert/GlobalItemTypeDictionary.php

@@ -24,36 +24,18 @@ declare(strict_types=1);
 namespace pocketmine\network\mcpe\convert;
 
 use pocketmine\network\mcpe\protocol\serializer\ItemTypeDictionary;
-use pocketmine\network\mcpe\protocol\types\ItemTypeEntry;
-use pocketmine\utils\AssumptionFailedError;
 use pocketmine\utils\SingletonTrait;
 use pocketmine\utils\Utils;
 use Webmozart\PathUtil\Path;
 use function file_get_contents;
-use function is_array;
-use function is_bool;
-use function is_int;
-use function is_string;
-use function json_decode;
 
 final class GlobalItemTypeDictionary{
 	use SingletonTrait;
 
 	private static function make() : self{
 		$data = Utils::assumeNotFalse(file_get_contents(Path::join(\pocketmine\BEDROCK_DATA_PATH, 'required_item_list.json')), "Missing required resource file");
-		$table = json_decode($data, true);
+		$dictionary = ItemTypeDictionaryFromDataHelper::loadFromString($data);
-		if(!is_array($table)){
+		return new self($dictionary);
-			throw new AssumptionFailedError("Invalid item list format");
-		}
-
-		$params = [];
-		foreach($table as $name => $entry){
-			if(!is_array($entry) || !is_string($name) || !isset($entry["component_based"], $entry["runtime_id"]) || !is_bool($entry["component_based"]) || !is_int($entry["runtime_id"])){
-				throw new AssumptionFailedError("Invalid item list format");
-			}
-			$params[] = new ItemTypeEntry($name, $entry["runtime_id"], $entry["component_based"]);
-		}
-		return new self(new ItemTypeDictionary($params));
 	}
 
 	public function __construct(

src/network/mcpe/convert/ItemTypeDictionaryFromDataHelper.php

@@ -0,0 +1,52 @@
+<?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\network\mcpe\convert;
+
+use pocketmine\network\mcpe\protocol\serializer\ItemTypeDictionary;
+use pocketmine\network\mcpe\protocol\types\ItemTypeEntry;
+use pocketmine\utils\AssumptionFailedError;
+use function is_array;
+use function is_bool;
+use function is_int;
+use function is_string;
+use function json_decode;
+
+final class ItemTypeDictionaryFromDataHelper{
+
+	public static function loadFromString(string $data) : ItemTypeDictionary{
+		$table = json_decode($data, true);
+		if(!is_array($table)){
+			throw new AssumptionFailedError("Invalid item list format");
+		}
+
+		$params = [];
+		foreach($table as $name => $entry){
+			if(!is_array($entry) || !is_string($name) || !isset($entry["component_based"], $entry["runtime_id"]) || !is_bool($entry["component_based"]) || !is_int($entry["runtime_id"])){
+				throw new AssumptionFailedError("Invalid item list format");
+			}
+			$params[] = new ItemTypeEntry($name, $entry["runtime_id"], $entry["component_based"]);
+		}
+		return new ItemTypeDictionary($params);
+	}
+}