peripherad

Back Back Up Advanced Editor

<?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\Operator;

use PhpCsFixer\AbstractFixer;
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\Preg;
use PhpCsFixer\Tokenizer\CT;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
use PhpCsFixer\Tokenizer\TokensAnalyzer;
use PhpCsFixer\Utils;
use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;

/**
 * @phpstan-type _AutogeneratedInputConfiguration array{
 *  default?: 'align'|'align_by_scope'|'align_single_space'|'align_single_space_by_scope'|'align_single_space_minimal'|'align_single_space_minimal_by_scope'|'at_least_single_space'|'no_space'|'single_space'|null,
 *  operators?: array<string, ?string>,
 * }
 * @phpstan-type _AutogeneratedComputedConfiguration array{
 *  default: 'align'|'align_by_scope'|'align_single_space'|'align_single_space_by_scope'|'align_single_space_minimal'|'align_single_space_minimal_by_scope'|'at_least_single_space'|'no_space'|'single_space'|null,
 *  operators: array<string, ?string>,
 * }
 *
 * @implements ConfigurableFixerInterface<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration>
 *
 * @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
 *
 * @no-named-arguments Parameter names are not covered by the backward compatibility promise.
 */
final class BinaryOperatorSpacesFixer extends AbstractFixer implements ConfigurableFixerInterface
{
    /** @use ConfigurableFixerTrait<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration> */
    use ConfigurableFixerTrait;

/**
     * @internal
     */
    public const SINGLE_SPACE = 'single_space';

/**
     * @internal
     */
    public const AT_LEAST_SINGLE_SPACE = 'at_least_single_space';

/**
     * @internal
     */
    public const NO_SPACE = 'no_space';

/**
     * @internal
     */
    public const ALIGN = 'align';

/**
     * @internal
     */
    public const ALIGN_BY_SCOPE = 'align_by_scope';

/**
     * @internal
     */
    public const ALIGN_SINGLE_SPACE = 'align_single_space';

/**
     * @internal
     */
    public const ALIGN_SINGLE_SPACE_BY_SCOPE = 'align_single_space_by_scope';

/**
     * @internal
     */
    public const ALIGN_SINGLE_SPACE_MINIMAL = 'align_single_space_minimal';

/**
     * @internal
     */
    public const ALIGN_SINGLE_SPACE_MINIMAL_BY_SCOPE = 'align_single_space_minimal_by_scope';

/**
     * Placeholder used as anchor for right alignment.
     *
     * @internal
     */
    public const ALIGN_PLACEHOLDER = "\x2 ALIGNABLE%d \x3";

/**
     * @var non-empty-list<string>
     */
    private const SUPPORTED_OPERATORS = [
        '=',
        '*',
        '/',
        '%',
        '<',
        '>',
        '|',
        '^',
        '+',
        '-',
        '&',
        '&=',
        '&&',
        '||',
        '.=',
        '/=',
        '=>',
        '==',
        '>=',
        '===',
        '!=',
        '<>',
        '!==',
        '<=',
        'and',
        'or',
        'xor',
        '-=',
        '%=',
        '*=',
        '|=',
        '+=',
        '<<',
        '<<=',
        '>>',
        '>>=',
        '^=',
        '**',
        '**=',
        '<=>',
        '??',
        '??=',
    ];

/**
     * @var non-empty-list<null|string>
     */
    private const ALLOWED_VALUES = [
        self::ALIGN,
        self::ALIGN_BY_SCOPE,
        self::ALIGN_SINGLE_SPACE,
        self::ALIGN_SINGLE_SPACE_MINIMAL,
        self::ALIGN_SINGLE_SPACE_BY_SCOPE,
        self::ALIGN_SINGLE_SPACE_MINIMAL_BY_SCOPE,
        self::SINGLE_SPACE,
        self::NO_SPACE,
        self::AT_LEAST_SINGLE_SPACE,
        null,
    ];

/**
     * Keep track of the deepest level ever achieved while
     * parsing the code. Used later to replace alignment
     * placeholders with spaces.
     */
    private int $deepestLevel;

/**
     * Level counter of the current nest level.
     * So one level alignments are not mixed with
     * other level ones.
     */
    private int $currentLevel;

private TokensAnalyzer $tokensAnalyzer;

/**
     * @var array<string, string>
     */
    private array $alignOperatorTokens = [];

/**
     * @var array<string, string>
     */
    private array $operators = [];

public function getDefinition(): FixerDefinitionInterface
    {
        return new FixerDefinition(
            'Binary operators should be surrounded by space as configured.',
            [
                new CodeSample(
                    <<<'PHP'
                        <?php
                        $a= 1  + $b^ $d !==  $e or   $f;

PHP,
                ),
                new CodeSample(
                    <<<'PHP'
                        <?php
                        $aa=  1;
                        $b=2;

$c = $d    xor    $e;
                        $f    -=  1;

PHP,
                    ['operators' => ['=' => self::ALIGN, 'xor' => null]],
                ),
                new CodeSample(
                    <<<'PHP'
                        <?php
                        $a = $b +=$c;
                        $d = $ee+=$f;

$g = $b     +=$c;
                        $h = $ee+=$f;

PHP,
                    ['operators' => ['+=' => self::ALIGN_SINGLE_SPACE]],
                ),
                new CodeSample(
                    <<<'PHP'
                        <?php
                        $a = $b===$c;
                        $d = $f   ===  $g;
                        $h = $i===  $j;

PHP,
                    ['operators' => ['===' => self::ALIGN_SINGLE_SPACE_MINIMAL]],
                ),
                new CodeSample(
                    <<<'PHP'
                        <?php
                        $foo = \json_encode($bar, JSON_PRESERVE_ZERO_FRACTION | JSON_PRETTY_PRINT);

PHP,
                    ['operators' => ['|' => self::NO_SPACE]],
                ),
                new CodeSample(
                    <<<'PHP'
                        <?php
                        $array = [
                            "foo"            =>   1,
                            "baaaaaaaaaaar"  =>  11,
                        ];

PHP,
                    ['operators' => ['=>' => self::SINGLE_SPACE]],
                ),
                new CodeSample(
                    <<<'PHP'
                        <?php
                        $array = [
                            "foo" => 12,
                            "baaaaaaaaaaar"  => 13,