121 lines
3.9 KiB
PHP
121 lines
3.9 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/*
|
|
* This file is part of PHP CS Fixer.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
* Dariusz Rumiński <dariusz.ruminski@gmail.com>
|
|
*
|
|
* This source file is subject to the MIT license that is bundled
|
|
* with this source code in the file LICENSE.
|
|
*/
|
|
|
|
namespace PhpCsFixer;
|
|
|
|
use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;
|
|
use PhpCsFixer\Tokenizer\Token;
|
|
use PhpCsFixer\Tokenizer\Tokens;
|
|
|
|
/**
|
|
* This abstract fixer is responsible for ensuring that a certain number of
|
|
* lines prefix a namespace declaration.
|
|
*
|
|
* @author Graham Campbell <hello@gjcampbell.co.uk>
|
|
*
|
|
* @internal
|
|
*/
|
|
abstract class AbstractLinesBeforeNamespaceFixer extends AbstractFixer implements WhitespacesAwareFixerInterface
|
|
{
|
|
/**
|
|
* Make sure # of line breaks prefixing namespace is within given range.
|
|
*
|
|
* @param int $expectedMin min. # of line breaks
|
|
* @param int $expectedMax max. # of line breaks
|
|
*/
|
|
protected function fixLinesBeforeNamespace(Tokens $tokens, int $index, int $expectedMin, int $expectedMax): void
|
|
{
|
|
// Let's determine the total numbers of new lines before the namespace
|
|
// and the opening token
|
|
$openingTokenIndex = null;
|
|
$precedingNewlines = 0;
|
|
$newlineInOpening = false;
|
|
$openingToken = null;
|
|
|
|
for ($i = 1; $i <= 2; ++$i) {
|
|
if (isset($tokens[$index - $i])) {
|
|
$token = $tokens[$index - $i];
|
|
|
|
if ($token->isGivenKind(T_OPEN_TAG)) {
|
|
$openingToken = $token;
|
|
$openingTokenIndex = $index - $i;
|
|
$newlineInOpening = str_contains($token->getContent(), "\n");
|
|
|
|
if ($newlineInOpening) {
|
|
++$precedingNewlines;
|
|
}
|
|
|
|
break;
|
|
}
|
|
|
|
if (false === $token->isGivenKind(T_WHITESPACE)) {
|
|
break;
|
|
}
|
|
|
|
$precedingNewlines += substr_count($token->getContent(), "\n");
|
|
}
|
|
}
|
|
|
|
if ($precedingNewlines >= $expectedMin && $precedingNewlines <= $expectedMax) {
|
|
return;
|
|
}
|
|
|
|
$previousIndex = $index - 1;
|
|
$previous = $tokens[$previousIndex];
|
|
|
|
if (0 === $expectedMax) {
|
|
// Remove all the previous new lines
|
|
if ($previous->isWhitespace()) {
|
|
$tokens->clearAt($previousIndex);
|
|
}
|
|
|
|
// Remove new lines in opening token
|
|
if ($newlineInOpening) {
|
|
$tokens[$openingTokenIndex] = new Token([T_OPEN_TAG, rtrim($openingToken->getContent()).' ']);
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
$lineEnding = $this->whitespacesConfig->getLineEnding();
|
|
$newlinesForWhitespaceToken = $expectedMax;
|
|
|
|
if (null !== $openingToken) {
|
|
// Use the configured line ending for the PHP opening tag
|
|
$content = rtrim($openingToken->getContent());
|
|
$newContent = $content.$lineEnding;
|
|
$tokens[$openingTokenIndex] = new Token([T_OPEN_TAG, $newContent]);
|
|
--$newlinesForWhitespaceToken;
|
|
}
|
|
|
|
if (0 === $newlinesForWhitespaceToken) {
|
|
// We have all the needed new lines in the opening tag
|
|
if ($previous->isWhitespace()) {
|
|
// Let's remove the previous token containing extra new lines
|
|
$tokens->clearAt($previousIndex);
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
if ($previous->isWhitespace()) {
|
|
// Fix the previous whitespace token
|
|
$tokens[$previousIndex] = new Token([T_WHITESPACE, str_repeat($lineEnding, $newlinesForWhitespaceToken).substr($previous->getContent(), strrpos($previous->getContent(), "\n") + 1)]);
|
|
} else {
|
|
// Add a new whitespace token
|
|
$tokens->insertAt($index, new Token([T_WHITESPACE, str_repeat($lineEnding, $newlinesForWhitespaceToken)]));
|
|
}
|
|
}
|
|
}
|