<?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\Fixer\Phpdoc;

use PhpCsFixer\AbstractFixer;
use PhpCsFixer\DocBlock\DocBlock;
use PhpCsFixer\Fixer\ConfigurableFixerInterface;
use PhpCsFixer\Fixer\ConfigurableFixerTrait;
use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\Future;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
use PhpCsFixer\Utils;
use ECSPrefix202510\Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
/**
 * @phpstan-type _AutogeneratedInputConfiguration array{
 *  order?: list<string>,
 * }
 * @phpstan-type _AutogeneratedComputedConfiguration array{
 *  order: list<string>,
 * }
 *
 * @implements ConfigurableFixerInterface<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration>
 *
 * @author Graham Campbell <hello@gjcampbell.co.uk>
 * @author Jakub Kwaśniewski <jakub@zero-85.pl>
 *
 * @no-named-arguments Parameter names are not covered by the backward compatibility promise.
 */
final class PhpdocOrderFixer extends AbstractFixer implements ConfigurableFixerInterface
{
    /** @use ConfigurableFixerTrait<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration> */
    use ConfigurableFixerTrait;
    /** @var list<string> */
    private $configurationOrder;
    public function getDefinition() : FixerDefinitionInterface
    {
        $code = <<<'EOF'
<?php

namespace ECSPrefix202510;

/**
* Hello there!
*
* @throws Exception|RuntimeException foo
* @custom Test!
* @return int  Return the number of changes.
* @param string $foo
* @param bool   $bar Bar
*/

EOF;
        return new FixerDefinition('Annotations in PHPDoc should be ordered in defined sequence.', [new CodeSample($code), new CodeSample($code, ['order' => ['param', 'return', 'throws']]), new CodeSample($code, ['order' => ['param', 'throws', 'return']]), new CodeSample($code, ['order' => ['param', 'custom', 'throws', 'return']])]);
    }
    public function isCandidate(Tokens $tokens) : bool
    {
        return $tokens->isTokenKindFound(\T_DOC_COMMENT);
    }
    /**
     * {@inheritdoc}
     *
     * Must run before PhpdocAlignFixer, PhpdocSeparationFixer, PhpdocTrimFixer.
     * Must run after AlignMultilineCommentFixer, CommentToPhpdocFixer, PhpdocAddMissingParamAnnotationFixer, PhpdocIndentFixer, PhpdocScalarFixer, PhpdocToCommentFixer, PhpdocTypesFixer.
     */
    public function getPriority() : int
    {
        return -2;
    }
    protected function createConfigurationDefinition() : FixerConfigurationResolverInterface
    {
        return new FixerConfigurationResolver([(new FixerOptionBuilder('order', 'Sequence in which annotations in PHPDoc should be ordered.'))->setAllowedTypes(['string[]'])->setAllowedValues([static function (array $order) : bool {
            if (\count($order) < 2) {
                throw new InvalidOptionsException('The option "order" value is invalid. Minimum two tags are required.');
            }
            $unique = \array_unique($order);
            if (\count($order) !== \count($unique)) {
                $duplicates = \array_keys(\array_filter(\array_count_values($order), static function (int $count) : bool {
                    return $count > 1;
                }));
                throw new InvalidOptionsException(\sprintf('The option "order" value is invalid. Tag%s %s %s duplicated.', \count($duplicates) > 1 ? 's' : '', Utils::naturalLanguageJoin($duplicates), \count($duplicates) > 1 ? 'are' : 'is'));
            }
            return \true;
        }])->setDefault(Future::getV4OrV3(['param', 'return', 'throws'], ['param', 'throws', 'return']))->getOption()]);
    }
    protected function configurePostNormalisation() : void
    {
        $this->configurationOrder = [];
        foreach ($this->configuration['order'] as $type) {
            $this->configurationOrder[] = $type;
            if (!\in_array('phpstan-' . $type, $this->configuration['order'], \true)) {
                $this->configurationOrder[] = 'phpstan-' . $type;
            }
            if (!\in_array('psalm-' . $type, $this->configuration['order'], \true)) {
                $this->configurationOrder[] = 'psalm-' . $type;
            }
        }
    }
    protected function applyFix(\SplFileInfo $file, Tokens $tokens) : void
    {
        foreach ($tokens as $index => $token) {
            if (!$token->isGivenKind(\T_DOC_COMMENT)) {
                continue;
            }
            // assuming annotations are already grouped by tags
            $content = $token->getContent();
            // sort annotations
            $successors = $this->configurationOrder;
            while (\count($successors) >= 3) {
                $predecessor = \array_shift($successors);
                $content = $this->moveAnnotationsBefore($predecessor, $successors, $content);
            }
            // we're parsing the content last time to make sure the internal
            // state of the docblock is correct after the modifications
            $predecessors = $this->configurationOrder;
            $last = \array_pop($predecessors);
            $content = $this->moveAnnotationsAfter($last, $predecessors, $content);
            // persist the content at the end
            $tokens[$index] = new Token([\T_DOC_COMMENT, $content]);
        }
    }
    /**
     * Move all given annotations in before given set of annotations.
     *
     * @param string       $move   Tag of annotations that should be moved
     * @param list<string> $before Tags of annotations that should moved annotations be placed before
     */
    private function moveAnnotationsBefore(string $move, array $before, string $content) : string
    {
        $doc = new DocBlock($content);
        $toBeMoved = $doc->getAnnotationsOfType($move);
        // nothing to do if there are no annotations to be moved
        if (0 === \count($toBeMoved)) {
            return $content;
        }
        $others = $doc->getAnnotationsOfType($before);
        if (0 === \count($others)) {
            return $content;
        }
        // get the index of the final line of the final toBoMoved annotation
        $end = \end($toBeMoved)->getEnd();
        $line = $doc->getLine($end);
        // move stuff about if required
        foreach ($others as $other) {
            if ($other->getStart() < $end) {
                // we're doing this to maintain the original line indices
                $line->setContent($line->getContent() . $other->getContent());
                $other->remove();
            }
        }
        return $doc->getContent();
    }
    /**
     * Move all given annotations after given set of annotations.
     *
     * @param string       $move  Tag of annotations that should be moved
     * @param list<string> $after Tags of annotations that should moved annotations be placed after
     */
    private function moveAnnotationsAfter(string $move, array $after, string $content) : string
    {
        $doc = new DocBlock($content);
        $toBeMoved = $doc->getAnnotationsOfType($move);
        // nothing to do if there are no annotations to be moved
        if (0 === \count($toBeMoved)) {
            return $content;
        }
        $others = $doc->getAnnotationsOfType($after);
        // nothing to do if there are no other annotations
        if (0 === \count($others)) {
            return $content;
        }
        // get the index of the first line of the first toBeMoved annotation
        $start = $toBeMoved[0]->getStart();
        $line = $doc->getLine($start);
        // move stuff about if required
        foreach (\array_reverse($others) as $other) {
            if ($other->getEnd() > $start) {
                // we're doing this to maintain the original line indices
                $line->setContent($other->getContent() . $line->getContent());
                $other->remove();
            }
        }
        return $doc->getContent();
    }
}
