mirrors/PocketMine-MP
1
0
Fork 0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2025-06-13 15:05:33 +00:00
Code Issues Projects Releases Wiki Activity

Move code & docblock generation methods out of RegistryTrait

Browse Source 
this allows generating a docblock / code for a registry without the class needing to exist or be populated yet, which makes code generation significantly less cumbersome.
This commit is contained in:
Dylan K. Taylor 2020-08-07 21:43:19 +01:00
parent ff2a3baa8e
commit 192e31a397
2 changed files with 80 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
src/utils/RegistryTrait.php
View File

@ -112,55 +112,4 @@ trait RegistryTrait{
return self::preprocessMember($o); return self::preprocessMember($o);
}, self::$members); }, self::$members);
} }
/**
* Generates code for static methods for all known registry members.
*/
public static function _generateGetters() : string{
$lines = [];
static $fnTmpl = '
public static function %1$s() : %2$s{
return self::fromString("%1$s");
}';
foreach(self::_registryGetAll() as $name => $member){
$lines[] = sprintf($fnTmpl, $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.
*/
public static function _generateMethodAnnotations() : string{
$traitName = (new \ReflectionClass(__TRAIT__))->getShortName();
$fnName = (new \ReflectionMethod(__METHOD__))->getShortName();
$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 $traitName::$fnName()";
$lines[] = " *";
static $lineTmpl = " * @method static %2\$s %s()";
$thisNamespace = (new \ReflectionClass(__CLASS__))->getNamespaceName();
foreach(self::_registryGetAll() as $name => $member){
$reflect = new \ReflectionClass($member);
while($reflect !== false and $reflect->isAnonymous()){
$reflect = $reflect->getParentClass();
}
if($reflect === false){
$typehint = "object";
}elseif($reflect->getName() === __CLASS__){
$typehint = "self";
}elseif(strpos($reflect->getName(), $thisNamespace) === 0){
$typehint = substr($reflect->getName(), strlen($thisNamespace . '\\'));
}else{
$typehint = '\\' . $reflect->getName();
}
$lines[] = sprintf($lineTmpl, $name, $typehint);
}
$lines[] = " */\n";
return implode("\n", $lines);
}
} }

80
src/utils/RegistryUtils.php Normal file
View File

@ -0,0 +1,80 @@
<?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 mb_strtoupper;
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()";
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();
}
$lines[] = sprintf($lineTmpl, mb_strtoupper($name), $typehint);
}
$lines[] = " */";
return implode("\n", $lines);
}
}