Simplify registry method generation

build/generate-registry-annotations.php

@@ -23,21 +23,62 @@ declare(strict_types=1);
 
 namespace pocketmine\build\update_registry_annotations;
 
-use pocketmine\utils\RegistryUtils;
 use function basename;
 use function class_exists;
 use function count;
 use function dirname;
 use function file_get_contents;
 use function file_put_contents;
+use function implode;
+use function ksort;
 use function preg_match;
+use function sprintf;
 use function str_replace;
 use function substr;
+use const SORT_STRING;
 
 if(count($argv) !== 2){
 	die("Provide a path to process");
 }
 
+/**
+ * @param object[] $members
+ */
+function generateMethodAnnotations(string $namespaceName, array $members) : string{
+	$selfName = basename(__FILE__);
+	$lines = ["/**"];
+	$lines[] = " * This doc-block is generated automatically, do not modify it manually.";
+	$lines[] = " * This must be regenerated whenever registry members are added, removed or changed.";
+	$lines[] = " * @see build/$selfName";
+	$lines[] = " * @generate-registry-docblock";
+	$lines[] = " *";
+
+	static $lineTmpl = " * @method static %2\$s %s()";
+	$memberLines = [];
+	foreach($members as $name => $member){
+		$reflect = new \ReflectionClass($member);
+		while($reflect !== false and $reflect->isAnonymous()){
+			$reflect = $reflect->getParentClass();
+		}
+		if($reflect === false){
+			$typehint = "object";
+		}elseif($reflect->getNamespaceName() === $namespaceName){
+			$typehint = $reflect->getShortName();
+		}else{
+			$typehint = '\\' . $reflect->getName();
+		}
+		$accessor = mb_strtoupper($name);
+		$memberLines[$accessor] = sprintf($lineTmpl, $accessor, $typehint);
+	}
+	ksort($memberLines, SORT_STRING);
+
+	foreach($memberLines as $line){
+		$lines[] = $line;
+	}
+	$lines[] = " */";
+	return implode("\n", $lines);
+}
+
 require dirname(__DIR__) . '/vendor/autoload.php';
 
 foreach(new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($argv[1], \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::CURRENT_AS_PATHNAME)) as $file){
@@ -59,12 +100,12 @@ foreach(new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($argv[1],
 	}
 	$reflect = new \ReflectionClass($className);
 	$docComment = $reflect->getDocComment();
-	if($docComment === false || (preg_match("/^\s*\*\s*\@see .+::_generateMethodAnnotations\(\)$/m", $docComment) !== 1 && preg_match("/^\s*\*\s*@generate-registry-docblock$/m", $docComment) !== 1)){
+	if($docComment === false || preg_match("/^\s*\*\s*@generate-registry-docblock$/m", $docComment) !== 1){
 		continue;
 	}
 	echo "Found registry in $file\n";
 
-	$replacement = RegistryUtils::_generateMethodAnnotations($matches[1], $className::getAll());
+	$replacement = generateMethodAnnotations($matches[1], $className::getAll());
 
 	$newContents = str_replace($docComment, $replacement, $contents);
 	if($newContents !== $contents){

src/block/VanillaBlocks.php

@@ -29,7 +29,8 @@ use function assert;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static WoodenButton ACACIA_BUTTON()
  * @method static WoodenDoor ACACIA_DOOR()

src/block/utils/BannerPatternType.php

@@ -28,7 +28,8 @@ use pocketmine\utils\EnumTrait;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static BannerPatternType BORDER()
  * @method static BannerPatternType BRICKS()

src/block/utils/BellAttachmentType.php

@@ -28,7 +28,8 @@ use pocketmine\utils\EnumTrait;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static BellAttachmentType CEILING()
  * @method static BellAttachmentType FLOOR()

src/block/utils/BrewingStandSlot.php

@@ -28,7 +28,8 @@ use pocketmine\utils\EnumTrait;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static BrewingStandSlot EAST()
  * @method static BrewingStandSlot NORTHWEST()

src/block/utils/CoralType.php

@@ -28,7 +28,8 @@ use pocketmine\utils\EnumTrait;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static CoralType BRAIN()
  * @method static CoralType BUBBLE()

src/block/utils/DyeColor.php

@@ -29,7 +29,8 @@ use pocketmine\utils\EnumTrait;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static DyeColor BLACK()
  * @method static DyeColor BLUE()

src/block/utils/MushroomBlockType.php

@@ -28,7 +28,8 @@ use pocketmine\utils\EnumTrait;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static MushroomBlockType ALL_CAP()
  * @method static MushroomBlockType CAP_EAST()

src/block/utils/RecordType.php

@@ -31,7 +31,8 @@ use pocketmine\utils\EnumTrait;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static RecordType DISK_11()
  * @method static RecordType DISK_13()

src/block/utils/SkullType.php

@@ -28,7 +28,8 @@ use pocketmine\utils\EnumTrait;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static SkullType CREEPER()
  * @method static SkullType DRAGON()

src/block/utils/SlabType.php

@@ -28,7 +28,8 @@ use pocketmine\utils\EnumTrait;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static SlabType BOTTOM()
  * @method static SlabType DOUBLE()

src/block/utils/StairShape.php

@@ -28,7 +28,8 @@ use pocketmine\utils\EnumTrait;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static StairShape INNER_LEFT()
  * @method static StairShape INNER_RIGHT()

src/block/utils/TreeType.php

@@ -28,7 +28,8 @@ use pocketmine\utils\EnumTrait;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static TreeType ACACIA()
  * @method static TreeType BIRCH()

src/crafting/FurnaceType.php

@@ -28,7 +28,8 @@ use pocketmine\utils\EnumTrait;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static FurnaceType BLAST_FURNACE()
  * @method static FurnaceType FURNACE()

src/entity/effect/VanillaEffects.php

@@ -30,7 +30,8 @@ use function assert;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static AbsorptionEffect ABSORPTION()
  * @method static Effect BLINDNESS()

src/item/ItemUseResult.php

@@ -28,7 +28,8 @@ use pocketmine\utils\EnumTrait;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static ItemUseResult FAIL()
  * @method static ItemUseResult NONE()

src/item/PotionType.php

@@ -30,7 +30,8 @@ use pocketmine\utils\EnumTrait;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static PotionType AWKWARD()
  * @method static PotionType FIRE_RESISTANCE()

src/item/ToolTier.php

@@ -28,7 +28,8 @@ use pocketmine\utils\EnumTrait;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static ToolTier DIAMOND()
  * @method static ToolTier GOLD()

src/item/VanillaItems.php

@@ -29,7 +29,8 @@ use function assert;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static Boat ACACIA_BOAT()
  * @method static Apple APPLE()

src/item/enchantment/VanillaEnchantments.php

@@ -29,7 +29,8 @@ use pocketmine\utils\RegistryTrait;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static ProtectionEnchantment BLAST_PROTECTION()
  * @method static Enchantment EFFICIENCY()

src/player/GameMode.php

@@ -31,7 +31,8 @@ use function mb_strtolower;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static GameMode ADVENTURE()
  * @method static GameMode CREATIVE()

src/player/UsedChunkStatus.php

@@ -28,7 +28,8 @@ use pocketmine\utils\EnumTrait;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static UsedChunkStatus NEEDED()
  * @method static UsedChunkStatus REQUESTED()

src/plugin/PluginEnableOrder.php

@@ -29,7 +29,8 @@ use function mb_strtolower;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static PluginEnableOrder POSTWORLD()
  * @method static PluginEnableOrder STARTUP()

src/utils/RegistryUtils.php

@@ -1,92 +0,0 @@
-<?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 get_class;
-use function implode;
-use function ksort;
-use function mb_strtoupper;
-use function sprintf;
-use const SORT_STRING;
-
-final class RegistryUtils{
-
-	/**
-	 * Generates code for static methods for all known registry members.
-	 *
-	 * @param object[] $members
-	 */
-	public static function _generateGetters(array $members) : string{
-		$lines = [];
-
-		static $fnTmpl = '
-public static function %1$s() : %2$s{
-	return self::fromString("%1$s");
-}';
-
-		foreach($members as $name => $member){
-			$lines[] = sprintf($fnTmpl, mb_strtoupper($name), '\\' . get_class($member));
-		}
-		return "//region auto-generated code\n" . implode("\n", $lines) . "\n\n//endregion\n";
-	}
-
-	/**
-	 * Generates a block of @ method annotations for accessors for this registry's known members.
-	 *
-	 * @param object[] $members
-	 */
-	public static function _generateMethodAnnotations(string $namespaceName, array $members) : string{
-		$selfName = __METHOD__;
-		$lines = ["/**"];
-		$lines[] = " * This doc-block is generated automatically, do not modify it manually.";
-		$lines[] = " * This must be regenerated whenever registry members are added, removed or changed.";
-		$lines[] = " * @see \\$selfName()";
-		$lines[] = " *";
-
-		static $lineTmpl = " * @method static %2\$s %s()";
-		$memberLines = [];
-		foreach($members as $name => $member){
-			$reflect = new \ReflectionClass($member);
-			while($reflect !== false and $reflect->isAnonymous()){
-				$reflect = $reflect->getParentClass();
-			}
-			if($reflect === false){
-				$typehint = "object";
-			}elseif($reflect->getNamespaceName() === $namespaceName){
-				$typehint = $reflect->getShortName();
-			}else{
-				$typehint = '\\' . $reflect->getName();
-			}
-			$accessor = mb_strtoupper($name);
-			$memberLines[$accessor] = sprintf($lineTmpl, $accessor, $typehint);
-		}
-		ksort($memberLines, SORT_STRING);
-
-		foreach($memberLines as $line){
-			$lines[] = $line;
-		}
-		$lines[] = " */";
-		return implode("\n", $lines);
-	}
-}

src/world/sound/NoteInstrument.php

@@ -28,7 +28,8 @@ use pocketmine\utils\EnumTrait;
 /**
  * This doc-block is generated automatically, do not modify it manually.
  * This must be regenerated whenever registry members are added, removed or changed.
- * @see \pocketmine\utils\RegistryUtils::_generateMethodAnnotations()
+ * @see build/generate-registry-annotations.php
+ * @generate-registry-docblock
  *
  * @method static NoteInstrument BASS_DRUM()
  * @method static NoteInstrument CLICKS_AND_STICKS()