2019-10-13 05:59:52 +00:00
|
|
|
<?php
|
|
|
|
|
2021-05-09 20:15:43 +00:00
|
|
|
declare (strict_types=1);
|
2022-06-06 17:12:56 +00:00
|
|
|
namespace Rector\BetterPhpDocParser\PhpDocParser;
|
2019-02-28 21:50:53 +00:00
|
|
|
|
2022-06-06 17:12:56 +00:00
|
|
|
use PhpParser\Node;
|
|
|
|
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocChildNode;
|
|
|
|
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocNode;
|
|
|
|
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
|
|
|
|
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagValueNode;
|
|
|
|
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTextNode;
|
|
|
|
use PHPStan\PhpDocParser\Lexer\Lexer;
|
|
|
|
use PHPStan\PhpDocParser\Parser\ConstExprParser;
|
|
|
|
use PHPStan\PhpDocParser\Parser\PhpDocParser;
|
|
|
|
use PHPStan\PhpDocParser\Parser\TokenIterator;
|
|
|
|
use PHPStan\PhpDocParser\Parser\TypeParser;
|
|
|
|
use Rector\BetterPhpDocParser\Contract\PhpDocParser\PhpDocNodeDecoratorInterface;
|
|
|
|
use Rector\BetterPhpDocParser\PhpDocInfo\TokenIteratorFactory;
|
|
|
|
use Rector\BetterPhpDocParser\ValueObject\Parser\BetterTokenIterator;
|
|
|
|
use Rector\BetterPhpDocParser\ValueObject\PhpDocAttributeKey;
|
|
|
|
use Rector\BetterPhpDocParser\ValueObject\StartAndEnd;
|
|
|
|
use Rector\Core\Configuration\CurrentNodeProvider;
|
|
|
|
use Rector\Core\Exception\ShouldNotHappenException;
|
2022-06-07 06:40:10 +00:00
|
|
|
use RectorPrefix20220607\Symplify\PackageBuilder\Reflection\PrivatesCaller;
|
2019-09-26 14:26:44 +00:00
|
|
|
/**
|
2021-03-12 19:13:27 +00:00
|
|
|
* @see \Rector\Tests\BetterPhpDocParser\PhpDocParser\TagValueNodeReprint\TagValueNodeReprintTest
|
2019-09-26 14:26:44 +00:00
|
|
|
*/
|
2022-06-07 08:22:29 +00:00
|
|
|
final class BetterPhpDocParser extends PhpDocParser
|
2019-02-28 21:50:53 +00:00
|
|
|
{
|
|
|
|
/**
|
2021-12-04 12:47:17 +00:00
|
|
|
* @readonly
|
2022-06-02 09:05:21 +00:00
|
|
|
* @var \Rector\Core\Configuration\CurrentNodeProvider
|
2019-02-28 21:50:53 +00:00
|
|
|
*/
|
2022-06-02 09:05:21 +00:00
|
|
|
private $currentNodeProvider;
|
2020-02-29 18:57:31 +00:00
|
|
|
/**
|
2021-12-04 12:47:17 +00:00
|
|
|
* @readonly
|
2021-05-10 23:39:21 +00:00
|
|
|
* @var \Rector\BetterPhpDocParser\PhpDocInfo\TokenIteratorFactory
|
2020-02-29 18:57:31 +00:00
|
|
|
*/
|
2021-05-10 23:39:21 +00:00
|
|
|
private $tokenIteratorFactory;
|
2020-05-05 14:37:29 +00:00
|
|
|
/**
|
2022-06-02 09:05:21 +00:00
|
|
|
* @var PhpDocNodeDecoratorInterface[]
|
2021-12-04 12:47:17 +00:00
|
|
|
* @readonly
|
2020-05-05 14:37:29 +00:00
|
|
|
*/
|
2022-06-02 09:05:21 +00:00
|
|
|
private $phpDocNodeDecorators;
|
|
|
|
/**
|
|
|
|
* @readonly
|
|
|
|
* @var \Symplify\PackageBuilder\Reflection\PrivatesCaller
|
|
|
|
*/
|
|
|
|
private $privatesCaller;
|
|
|
|
/**
|
|
|
|
* @param PhpDocNodeDecoratorInterface[] $phpDocNodeDecorators
|
|
|
|
*/
|
2022-06-07 08:22:29 +00:00
|
|
|
public function __construct(TypeParser $typeParser, ConstExprParser $constExprParser, CurrentNodeProvider $currentNodeProvider, TokenIteratorFactory $tokenIteratorFactory, array $phpDocNodeDecorators, PrivatesCaller $privatesCaller = null)
|
2021-05-09 20:15:43 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
$privatesCaller = $privatesCaller ?? new PrivatesCaller();
|
2022-06-02 09:05:21 +00:00
|
|
|
$this->currentNodeProvider = $currentNodeProvider;
|
2021-05-10 23:39:21 +00:00
|
|
|
$this->tokenIteratorFactory = $tokenIteratorFactory;
|
2022-06-02 09:05:21 +00:00
|
|
|
$this->phpDocNodeDecorators = $phpDocNodeDecorators;
|
|
|
|
$this->privatesCaller = $privatesCaller;
|
2019-02-28 21:50:53 +00:00
|
|
|
parent::__construct($typeParser, $constExprParser);
|
2020-01-03 22:44:40 +00:00
|
|
|
}
|
2022-06-07 08:22:29 +00:00
|
|
|
public function parse(TokenIterator $tokenIterator) : PhpDocNode
|
2019-02-28 21:50:53 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
$tokenIterator->consumeTokenType(Lexer::TOKEN_OPEN_PHPDOC);
|
|
|
|
$tokenIterator->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
|
2019-02-28 21:50:53 +00:00
|
|
|
$children = [];
|
2022-06-07 08:22:29 +00:00
|
|
|
if (!$tokenIterator->isCurrentTokenType(Lexer::TOKEN_CLOSE_PHPDOC)) {
|
2019-02-28 21:50:53 +00:00
|
|
|
$children[] = $this->parseChildAndStoreItsPositions($tokenIterator);
|
2022-06-07 08:22:29 +00:00
|
|
|
while ($tokenIterator->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL) && !$tokenIterator->isCurrentTokenType(Lexer::TOKEN_CLOSE_PHPDOC)) {
|
2019-02-28 21:50:53 +00:00
|
|
|
$children[] = $this->parseChildAndStoreItsPositions($tokenIterator);
|
|
|
|
}
|
|
|
|
}
|
2020-06-04 22:17:31 +00:00
|
|
|
// might be in the middle of annotations
|
2022-06-07 08:22:29 +00:00
|
|
|
$tokenIterator->tryConsumeTokenType(Lexer::TOKEN_CLOSE_PHPDOC);
|
|
|
|
$phpDocNode = new PhpDocNode($children);
|
2022-06-02 09:05:21 +00:00
|
|
|
// decorate FQN classes etc.
|
|
|
|
$node = $this->currentNodeProvider->getNode();
|
2022-06-07 08:22:29 +00:00
|
|
|
if (!$node instanceof Node) {
|
|
|
|
throw new ShouldNotHappenException();
|
2022-06-02 09:05:21 +00:00
|
|
|
}
|
|
|
|
foreach ($this->phpDocNodeDecorators as $phpDocNodeDecorator) {
|
|
|
|
$phpDocNodeDecorator->decorate($phpDocNode, $node);
|
|
|
|
}
|
2021-04-04 09:01:11 +00:00
|
|
|
return $phpDocNode;
|
2019-02-28 21:50:53 +00:00
|
|
|
}
|
2022-06-07 08:22:29 +00:00
|
|
|
public function parseTag(TokenIterator $tokenIterator) : PhpDocTagNode
|
2019-08-26 09:37:02 +00:00
|
|
|
{
|
2022-06-02 09:05:21 +00:00
|
|
|
// replace generic nodes with DoctrineAnnotations
|
2022-06-07 08:22:29 +00:00
|
|
|
if (!$tokenIterator instanceof BetterTokenIterator) {
|
|
|
|
throw new ShouldNotHappenException();
|
2021-10-23 21:09:26 +00:00
|
|
|
}
|
2019-10-02 19:18:45 +00:00
|
|
|
$tag = $this->resolveTag($tokenIterator);
|
2021-01-30 15:06:43 +00:00
|
|
|
$phpDocTagValueNode = $this->parseTagValue($tokenIterator, $tag);
|
2022-06-07 08:22:29 +00:00
|
|
|
return new PhpDocTagNode($tag, $phpDocTagValueNode);
|
2019-08-26 09:37:02 +00:00
|
|
|
}
|
2021-04-04 09:01:11 +00:00
|
|
|
/**
|
2021-12-10 10:22:23 +00:00
|
|
|
* @param BetterTokenIterator $tokenIterator
|
2021-04-04 09:01:11 +00:00
|
|
|
*/
|
2022-06-07 08:22:29 +00:00
|
|
|
public function parseTagValue(TokenIterator $tokenIterator, string $tag) : PhpDocTagValueNode
|
2019-02-28 21:50:53 +00:00
|
|
|
{
|
2021-04-06 17:33:09 +00:00
|
|
|
$startPosition = $tokenIterator->currentPosition();
|
2021-04-04 09:01:11 +00:00
|
|
|
$tagValueNode = parent::parseTagValue($tokenIterator, $tag);
|
2021-04-06 17:33:09 +00:00
|
|
|
$endPosition = $tokenIterator->currentPosition();
|
2022-06-07 08:22:29 +00:00
|
|
|
$startAndEnd = new StartAndEnd($startPosition, $endPosition);
|
|
|
|
$tagValueNode->setAttribute(PhpDocAttributeKey::START_AND_END, $startAndEnd);
|
2021-04-06 17:33:09 +00:00
|
|
|
return $tagValueNode;
|
2020-08-05 20:45:36 +00:00
|
|
|
}
|
2021-05-12 13:15:45 +00:00
|
|
|
/**
|
|
|
|
* @return PhpDocTextNode|PhpDocTagNode
|
|
|
|
*/
|
2022-06-07 08:22:29 +00:00
|
|
|
private function parseChildAndStoreItsPositions(TokenIterator $tokenIterator) : PhpDocChildNode
|
2019-02-28 21:50:53 +00:00
|
|
|
{
|
2021-04-06 17:33:09 +00:00
|
|
|
$betterTokenIterator = $this->tokenIteratorFactory->createFromTokenIterator($tokenIterator);
|
|
|
|
$startPosition = $betterTokenIterator->currentPosition();
|
2021-05-12 13:15:45 +00:00
|
|
|
/** @var PhpDocChildNode $phpDocNode */
|
2021-04-06 17:33:09 +00:00
|
|
|
$phpDocNode = $this->privatesCaller->callPrivateMethod($this, 'parseChild', [$betterTokenIterator]);
|
|
|
|
$endPosition = $betterTokenIterator->currentPosition();
|
2022-06-07 08:22:29 +00:00
|
|
|
$startAndEnd = new StartAndEnd($startPosition, $endPosition);
|
|
|
|
$phpDocNode->setAttribute(PhpDocAttributeKey::START_AND_END, $startAndEnd);
|
2021-04-06 17:33:09 +00:00
|
|
|
return $phpDocNode;
|
2019-02-28 21:50:53 +00:00
|
|
|
}
|
2022-06-07 08:22:29 +00:00
|
|
|
private function resolveTag(BetterTokenIterator $tokenIterator) : string
|
2019-10-02 19:18:45 +00:00
|
|
|
{
|
|
|
|
$tag = $tokenIterator->currentTokenValue();
|
|
|
|
$tokenIterator->next();
|
2021-04-04 09:01:11 +00:00
|
|
|
// there is a space → stop
|
|
|
|
if ($tokenIterator->isPrecededByHorizontalWhitespace()) {
|
2019-10-04 12:55:26 +00:00
|
|
|
return $tag;
|
|
|
|
}
|
2019-10-02 19:18:45 +00:00
|
|
|
// is not e.g "@var "
|
|
|
|
// join tags like "@ORM\Column" etc.
|
2022-06-07 08:22:29 +00:00
|
|
|
if (!$tokenIterator->isCurrentTokenType(Lexer::TOKEN_IDENTIFIER)) {
|
2019-10-02 19:18:45 +00:00
|
|
|
return $tag;
|
|
|
|
}
|
2021-04-04 09:01:11 +00:00
|
|
|
// @todo use joinUntil("(")?
|
2019-10-02 19:18:45 +00:00
|
|
|
$tag .= $tokenIterator->currentTokenValue();
|
|
|
|
$tokenIterator->next();
|
|
|
|
return $tag;
|
|
|
|
}
|
2019-02-28 21:50:53 +00:00
|
|
|
}
|