google_forms/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/TokenHelper.php

535 lines
14 KiB
PHP
Raw Permalink Normal View History

2024-08-21 06:34:30 +00:00
<?php declare(strict_types = 1);
namespace SlevomatCodingStandard\Helpers;
use PHP_CodeSniffer\Files\File;
use function array_key_exists;
use function array_merge;
use function count;
use const T_ANON_CLASS;
use const T_ARRAY;
use const T_ARRAY_HINT;
use const T_BREAK;
use const T_CALLABLE;
use const T_CLASS;
use const T_CLOSURE;
use const T_COMMENT;
use const T_CONTINUE;
use const T_DOC_COMMENT;
use const T_DOC_COMMENT_CLOSE_TAG;
use const T_DOC_COMMENT_OPEN_TAG;
use const T_DOC_COMMENT_STAR;
use const T_DOC_COMMENT_STRING;
use const T_DOC_COMMENT_TAG;
use const T_DOC_COMMENT_WHITESPACE;
use const T_ENUM;
use const T_EXIT;
use const T_FALSE;
use const T_FN;
use const T_FUNCTION;
use const T_INTERFACE;
use const T_NAME_FULLY_QUALIFIED;
use const T_NAME_QUALIFIED;
use const T_NAME_RELATIVE;
use const T_NS_SEPARATOR;
use const T_NULL;
use const T_OPEN_SHORT_ARRAY;
use const T_PARENT;
use const T_PHPCS_DISABLE;
use const T_PHPCS_ENABLE;
use const T_PHPCS_IGNORE;
use const T_PHPCS_IGNORE_FILE;
use const T_PHPCS_SET;
use const T_PRIVATE;
use const T_PROTECTED;
use const T_PUBLIC;
use const T_READONLY;
use const T_RETURN;
use const T_SELF;
use const T_STATIC;
use const T_STRING;
use const T_THROW;
use const T_TRAIT;
use const T_TRUE;
use const T_TYPE_INTERSECTION;
use const T_TYPE_UNION;
use const T_VAR;
use const T_WHITESPACE;
/**
* @internal
*/
class TokenHelper
{
/** @var array<int, (int|string)> */
public static $arrayTokenCodes = [
T_ARRAY,
T_OPEN_SHORT_ARRAY,
];
/** @var array<int, (int|string)> */
public static $typeKeywordTokenCodes = [
T_CLASS,
T_TRAIT,
T_INTERFACE,
T_ENUM,
];
/** @var array<int, (int|string)> */
public static $typeWithAnonymousClassKeywordTokenCodes = [
T_CLASS,
T_ANON_CLASS,
T_TRAIT,
T_INTERFACE,
T_ENUM,
];
/** @var array<int, (int|string)> */
public static $ineffectiveTokenCodes = [
T_WHITESPACE,
T_COMMENT,
T_DOC_COMMENT,
T_DOC_COMMENT_OPEN_TAG,
T_DOC_COMMENT_CLOSE_TAG,
T_DOC_COMMENT_STAR,
T_DOC_COMMENT_STRING,
T_DOC_COMMENT_TAG,
T_DOC_COMMENT_WHITESPACE,
T_PHPCS_DISABLE,
T_PHPCS_ENABLE,
T_PHPCS_IGNORE,
T_PHPCS_IGNORE_FILE,
T_PHPCS_SET,
];
/** @var array<int, (int|string)> */
public static $annotationTokenCodes = [
T_DOC_COMMENT_TAG,
T_PHPCS_DISABLE,
T_PHPCS_ENABLE,
T_PHPCS_IGNORE,
T_PHPCS_IGNORE_FILE,
T_PHPCS_SET,
];
/** @var array<int, (int|string)> */
public static $inlineCommentTokenCodes = [
T_COMMENT,
T_PHPCS_DISABLE,
T_PHPCS_ENABLE,
T_PHPCS_IGNORE,
T_PHPCS_IGNORE_FILE,
T_PHPCS_SET,
];
/** @var array<int, (int|string)> */
public static $earlyExitTokenCodes = [
T_RETURN,
T_CONTINUE,
T_BREAK,
T_THROW,
T_EXIT,
];
/** @var array<int, (int|string)> */
public static $functionTokenCodes = [
T_FUNCTION,
T_CLOSURE,
T_FN,
];
/** @var array<int, (int|string)> */
public static $propertyModifiersTokenCodes = [
T_VAR,
T_PUBLIC,
T_PROTECTED,
T_PRIVATE,
T_READONLY,
T_STATIC,
];
/**
* @param int|string|array<int|string, int|string> $types
*/
public static function findNext(File $phpcsFile, $types, int $startPointer, ?int $endPointer = null): ?int
{
/** @var int|false $token */
$token = $phpcsFile->findNext($types, $startPointer, $endPointer, false);
return $token === false ? null : $token;
}
/**
* @param int|string|array<int|string, int|string> $types
* @return list<int>
*/
public static function findNextAll(File $phpcsFile, $types, int $startPointer, ?int $endPointer = null): array
{
$pointers = [];
$actualStartPointer = $startPointer;
while (true) {
$pointer = self::findNext($phpcsFile, $types, $actualStartPointer, $endPointer);
if ($pointer === null) {
break;
}
$pointers[] = $pointer;
$actualStartPointer = $pointer + 1;
}
return $pointers;
}
/**
* @param int|string|array<int|string, int|string> $types
*/
public static function findNextContent(File $phpcsFile, $types, string $content, int $startPointer, ?int $endPointer = null): ?int
{
/** @var int|false $token */
$token = $phpcsFile->findNext($types, $startPointer, $endPointer, false, $content);
return $token === false ? null : $token;
}
/**
* @param int $startPointer Search starts at this token, inclusive
* @param int|null $endPointer Search ends at this token, exclusive
*/
public static function findNextEffective(File $phpcsFile, int $startPointer, ?int $endPointer = null): ?int
{
return self::findNextExcluding($phpcsFile, self::$ineffectiveTokenCodes, $startPointer, $endPointer);
}
/**
* @param int $startPointer Search starts at this token, inclusive
* @param int|null $endPointer Search ends at this token, exclusive
*/
public static function findNextNonWhitespace(File $phpcsFile, int $startPointer, ?int $endPointer = null): ?int
{
return self::findNextExcluding($phpcsFile, T_WHITESPACE, $startPointer, $endPointer);
}
/**
* @param int|string|array<int|string, int|string> $types
* @param int $startPointer Search starts at this token, inclusive
* @param int|null $endPointer Search ends at this token, exclusive
*/
public static function findNextExcluding(File $phpcsFile, $types, int $startPointer, ?int $endPointer = null): ?int
{
/** @var int|false $token */
$token = $phpcsFile->findNext($types, $startPointer, $endPointer, true);
return $token === false ? null : $token;
}
/**
* @param int|string|array<int|string, int|string> $types
*/
public static function findNextLocal(File $phpcsFile, $types, int $startPointer, ?int $endPointer = null): ?int
{
/** @var int|false $token */
$token = $phpcsFile->findNext($types, $startPointer, $endPointer, false, null, true);
return $token === false ? null : $token;
}
/**
* @param int $startPointer Search starts at this token, inclusive
* @param int|null $endPointer Search ends at this token, exclusive
*/
public static function findNextAnyToken(File $phpcsFile, int $startPointer, ?int $endPointer = null): ?int
{
return self::findNextExcluding($phpcsFile, [], $startPointer, $endPointer);
}
/**
* @param int|string|array<int|string, int|string> $types
* @param int $startPointer Search starts at this token, inclusive
* @param int|null $endPointer Search ends at this token, exclusive
*/
public static function findPrevious(File $phpcsFile, $types, int $startPointer, ?int $endPointer = null): ?int
{
/** @var int|false $token */
$token = $phpcsFile->findPrevious($types, $startPointer, $endPointer, false);
return $token === false ? null : $token;
}
/**
* @param int|string|array<int|string, int|string> $types
*/
public static function findPreviousContent(File $phpcsFile, $types, string $content, int $startPointer, ?int $endPointer = null): ?int
{
/** @var int|false $token */
$token = $phpcsFile->findPrevious($types, $startPointer, $endPointer, false, $content);
return $token === false ? null : $token;
}
/**
* @param int $startPointer Search starts at this token, inclusive
* @param int|null $endPointer Search ends at this token, exclusive
*/
public static function findPreviousEffective(File $phpcsFile, int $startPointer, ?int $endPointer = null): ?int
{
return self::findPreviousExcluding($phpcsFile, self::$ineffectiveTokenCodes, $startPointer, $endPointer);
}
/**
* @param int $startPointer Search starts at this token, inclusive
* @param int|null $endPointer Search ends at this token, exclusive
*/
public static function findPreviousNonWhitespace(File $phpcsFile, int $startPointer, ?int $endPointer = null): ?int
{
return self::findPreviousExcluding($phpcsFile, T_WHITESPACE, $startPointer, $endPointer);
}
/**
* @param int|string|array<int|string, int|string> $types
* @param int $startPointer Search starts at this token, inclusive
* @param int|null $endPointer Search ends at this token, exclusive
*/
public static function findPreviousExcluding(File $phpcsFile, $types, int $startPointer, ?int $endPointer = null): ?int
{
/** @var int|false $token */
$token = $phpcsFile->findPrevious($types, $startPointer, $endPointer, true);
return $token === false ? null : $token;
}
/**
* @param int|string|array<int|string, int|string> $types
*/
public static function findPreviousLocal(File $phpcsFile, $types, int $startPointer, ?int $endPointer = null): ?int
{
/** @var int|false $token */
$token = $phpcsFile->findPrevious($types, $startPointer, $endPointer, false, null, true);
return $token === false ? null : $token;
}
/**
* @param int $pointer Search starts at this token, inclusive
*/
public static function findFirstTokenOnLine(File $phpcsFile, int $pointer): int
{
if ($pointer === 0) {
return $pointer;
}
$tokens = $phpcsFile->getTokens();
$line = $tokens[$pointer]['line'];
do {
$pointer--;
} while ($tokens[$pointer]['line'] === $line);
return $pointer + 1;
}
/**
* @param int $pointer Search starts at this token, inclusive
*/
public static function findLastTokenOnLine(File $phpcsFile, int $pointer): int
{
$tokens = $phpcsFile->getTokens();
$line = $tokens[$pointer]['line'];
do {
$pointer++;
} while (array_key_exists($pointer, $tokens) && $tokens[$pointer]['line'] === $line);
return $pointer - 1;
}
/**
* @param int $pointer Search starts at this token, inclusive
*/
public static function findLastTokenOnPreviousLine(File $phpcsFile, int $pointer): int
{
$tokens = $phpcsFile->getTokens();
$line = $tokens[$pointer]['line'];
do {
$pointer--;
} while ($tokens[$pointer]['line'] === $line);
return $pointer;
}
/**
* @param int $pointer Search starts at this token, inclusive
*/
public static function findFirstTokenOnNextLine(File $phpcsFile, int $pointer): ?int
{
$tokens = $phpcsFile->getTokens();
if ($pointer >= count($tokens)) {
return null;
}
$line = $tokens[$pointer]['line'];
do {
$pointer++;
if (!array_key_exists($pointer, $tokens)) {
return null;
}
} while ($tokens[$pointer]['line'] === $line);
return $pointer;
}
/**
* @param int $pointer Search starts at this token, inclusive
*/
public static function findFirstNonWhitespaceOnLine(File $phpcsFile, int $pointer): int
{
if ($pointer === 0) {
return $pointer;
}
$tokens = $phpcsFile->getTokens();
$line = $tokens[$pointer]['line'];
do {
$pointer--;
} while ($pointer >= 0 && $tokens[$pointer]['line'] === $line);
return self::findNextExcluding($phpcsFile, [T_WHITESPACE, T_DOC_COMMENT_WHITESPACE], $pointer + 1);
}
/**
* @param int $pointer Search starts at this token, inclusive
*/
public static function findFirstNonWhitespaceOnNextLine(File $phpcsFile, int $pointer): ?int
{
$newLinePointer = self::findNextContent($phpcsFile, [T_WHITESPACE, T_DOC_COMMENT_WHITESPACE], $phpcsFile->eolChar, $pointer);
if ($newLinePointer === null) {
return null;
}
$nextPointer = self::findNextExcluding($phpcsFile, [T_WHITESPACE, T_DOC_COMMENT_WHITESPACE], $newLinePointer + 1);
$tokens = $phpcsFile->getTokens();
if ($nextPointer !== null && $tokens[$pointer]['line'] === $tokens[$nextPointer]['line'] - 1) {
return $nextPointer;
}
return null;
}
/**
* @param int $pointer Search starts at this token, inclusive
*/
public static function findFirstNonWhitespaceOnPreviousLine(File $phpcsFile, int $pointer): ?int
{
$newLinePointerOnPreviousLine = self::findPreviousContent(
$phpcsFile,
[T_WHITESPACE, T_DOC_COMMENT_WHITESPACE],
$phpcsFile->eolChar,
$pointer
);
if ($newLinePointerOnPreviousLine === null) {
return null;
}
$newLinePointerBeforePreviousLine = self::findPreviousContent(
$phpcsFile,
[T_WHITESPACE, T_DOC_COMMENT_WHITESPACE],
$phpcsFile->eolChar,
$newLinePointerOnPreviousLine - 1
);
if ($newLinePointerBeforePreviousLine === null) {
return null;
}
$nextPointer = self::findNextExcluding($phpcsFile, [T_WHITESPACE, T_DOC_COMMENT_WHITESPACE], $newLinePointerBeforePreviousLine + 1);
$tokens = $phpcsFile->getTokens();
if ($nextPointer !== null && $tokens[$pointer]['line'] === $tokens[$nextPointer]['line'] + 1) {
return $nextPointer;
}
return null;
}
public static function getContent(File $phpcsFile, int $startPointer, ?int $endPointer = null): string
{
$tokens = $phpcsFile->getTokens();
$endPointer = $endPointer ?? self::getLastTokenPointer($phpcsFile);
$content = '';
for ($i = $startPointer; $i <= $endPointer; $i++) {
$content .= $tokens[$i]['content'];
}
return $content;
}
public static function getLastTokenPointer(File $phpcsFile): int
{
$tokenCount = count($phpcsFile->getTokens());
if ($tokenCount === 0) {
throw new EmptyFileException($phpcsFile->getFilename());
}
return $tokenCount - 1;
}
/**
* @return array<int, (int|string)>
*/
public static function getNameTokenCodes(): array
{
return [T_STRING, T_NS_SEPARATOR, T_NAME_FULLY_QUALIFIED, T_NAME_QUALIFIED, T_NAME_RELATIVE];
}
/**
* @return array<int, (int|string)>
*/
public static function getOnlyNameTokenCodes(): array
{
return [T_STRING, T_NAME_FULLY_QUALIFIED, T_NAME_QUALIFIED, T_NAME_RELATIVE];
}
/**
* @return array<int, (int|string)>
*/
public static function getOnlyTypeHintTokenCodes(): array
{
static $typeHintTokenCodes = null;
if ($typeHintTokenCodes === null) {
$typeHintTokenCodes = array_merge(
self::getNameTokenCodes(),
[
T_SELF,
T_PARENT,
T_ARRAY_HINT,
T_CALLABLE,
T_FALSE,
T_TRUE,
T_NULL,
]
);
}
return $typeHintTokenCodes;
}
/**
* @return array<int, (int|string)>
*/
public static function getTypeHintTokenCodes(): array
{
static $typeHintTokenCodes = null;
if ($typeHintTokenCodes === null) {
$typeHintTokenCodes = array_merge(
self::getOnlyTypeHintTokenCodes(),
[T_TYPE_UNION, T_TYPE_INTERSECTION]
);
}
return $typeHintTokenCodes;
}
}