Replace findFunctionCallArguments custom loop with PassedParameters::getParameters()

Delegates argument parsing to PHPCSUtils which handles named params
(PHP 8+), closures, attributes, and has internal caching. Updates
getVariablesInsideCompact() and processVariableAsPassByReferenceFunctionCall()
to work with the PassedParameters ['start','end'] format; argument
positions are now 1-based integers matching PHPCSUtils conventions.
Removes stale Psalm baseline entries for the deleted $closePtr code.

Author: sirbrillig

VariableAnalysis/Lib/Helpers.php

@@ -15,6 +15,7 @@
 use PHPCSUtils\Utils\FunctionDeclarations;
 use PHPCSUtils\Utils\Lists;
 use PHPCSUtils\Utils\Parentheses;
+use PHPCSUtils\Utils\PassedParameters;
 
 class Helpers
 {
@@ -336,7 +337,7 @@ public static function findFunctionCall(File $phpcsFile, $stackPtr)
 	 * @param File $phpcsFile
 	 * @param int  $stackPtr
 	 *
-	 * @return array<int, array<int>>
+	 * @return array<int|string, array<string, int|string>>
 	 */
 	public static function findFunctionCallArguments(File $phpcsFile, $stackPtr)
 	{
@@ -351,38 +352,7 @@ public static function findFunctionCallArguments(File $phpcsFile, $stackPtr)
 			}
 		}
 
-		// $stackPtr is the function name, find our brackets after it
-		$openPtr = $phpcsFile->findNext(Tokens::$emptyTokens, $stackPtr + 1, null, true, null, true);
-		if (($openPtr === false) || ($tokens[$openPtr]['code'] !== T_OPEN_PARENTHESIS)) {
-			return [];
-		}
-
-		if (!isset($tokens[$openPtr]['parenthesis_closer'])) {
-			return [];
-		}
-		$closePtr = $tokens[$openPtr]['parenthesis_closer'];
-
-		$argPtrs = [];
-		$lastPtr = $openPtr;
-		$lastArgComma = $openPtr;
-		$nextPtr = $phpcsFile->findNext([T_COMMA], $lastPtr + 1, $closePtr);
-		while (is_int($nextPtr)) {
-			if (self::findContainingOpeningBracket($phpcsFile, $nextPtr) === $openPtr) {
-				// Comma is at our level of brackets, it's an argument delimiter.
-				$range = range($lastArgComma + 1, $nextPtr - 1);
-				array_push($argPtrs, $range);
-				$lastArgComma = $nextPtr;
-			}
-			$lastPtr = $nextPtr;
-			$nextPtr = $phpcsFile->findNext([T_COMMA], $lastPtr + 1, $closePtr);
-		}
-		$range = range($lastArgComma + 1, $closePtr - 1);
-		$range = array_filter($range, function ($element) {
-			return is_int($element);
-		});
-		array_push($argPtrs, $range);
-
-		return $argPtrs;
+		return PassedParameters::getParameters($phpcsFile, $stackPtr);
 	}
 
 	/**
@@ -457,9 +427,9 @@ public static function findVariableScope(File $phpcsFile, $stackPtr, $varName =
 	/**
 	 * Return the variable names and positions of each variable targetted by a `compact()` call.
 	 *
-	 * @param File                   $phpcsFile
-	 * @param int                    $stackPtr
-	 * @param array<int, array<int>> $arguments The stack pointers of each argument; see findFunctionCallArguments
+	 * @param File                                         $phpcsFile
+	 * @param int                                          $stackPtr
+	 * @param array<int|string, array<string, int|string>> $arguments The parameters from PassedParameters::getParameters()
 	 *
 	 * @return array<VariableInfo> each variable's firstRead position and its name; other VariableInfo properties are not set!
 	 */
@@ -468,36 +438,50 @@ public static function getVariablesInsideCompact(File $phpcsFile, $stackPtr, $ar
 		$tokens = $phpcsFile->getTokens();
 		$variablePositionsAndNames = [];
 
-		foreach ($arguments as $argumentPtrs) {
-			$argumentPtrs = array_values(array_filter($argumentPtrs, function ($argumentPtr) use ($tokens) {
-				return isset(Tokens::$emptyTokens[$tokens[$argumentPtr]['code']]) === false;
-			}));
-			if (empty($argumentPtrs)) {
-				continue;
+		foreach ($arguments as $param) {
+			// Find the first non-empty token in this argument's range.
+			$firstNonEmpty = null;
+			$nonEmptyCount = 0;
+			for ($i = (int)$param['start']; $i <= (int)$param['end']; $i++) {
+				if (!isset(Tokens::$emptyTokens[$tokens[$i]['code']])) {
+					if ($firstNonEmpty === null) {
+						$firstNonEmpty = $i;
+					}
+					$nonEmptyCount++;
+				}
 			}
-			if (!isset($tokens[$argumentPtrs[0]])) {
+
+			if ($firstNonEmpty === null) {
 				continue;
 			}
-			$argumentFirstToken = $tokens[$argumentPtrs[0]];
+
+			$argumentFirstToken = $tokens[$firstNonEmpty];
+
 			if ($argumentFirstToken['code'] === T_ARRAY) {
 				// It's an array argument, recurse.
-				$arrayArguments = self::findFunctionCallArguments($phpcsFile, $argumentPtrs[0]);
-				$variablePositionsAndNames = array_merge($variablePositionsAndNames, self::getVariablesInsideCompact($phpcsFile, $stackPtr, $arrayArguments));
+				$arrayArguments = PassedParameters::getParameters($phpcsFile, $firstNonEmpty);
+				$variablePositionsAndNames = array_merge(
+					$variablePositionsAndNames,
+					self::getVariablesInsideCompact($phpcsFile, $stackPtr, $arrayArguments)
+				);
 				continue;
 			}
-			if (count($argumentPtrs) > 1) {
+
+			if ($nonEmptyCount > 1) {
 				// Complex argument, we can't handle it, ignore.
 				continue;
 			}
+
 			if ($argumentFirstToken['code'] === T_CONSTANT_ENCAPSED_STRING) {
 				// Single-quoted string literal, ie compact('whatever').
 				// Substr is to strip the enclosing single-quotes.
 				$varName = substr($argumentFirstToken['content'], 1, -1);
 				$variable = new VariableInfo($varName);
-				$variable->firstRead = $argumentPtrs[0];
+				$variable->firstRead = $firstNonEmpty;
 				$variablePositionsAndNames[] = $variable;
 				continue;
 			}
+
 			if ($argumentFirstToken['code'] === T_DOUBLE_QUOTED_STRING) {
 				// Double-quoted string literal.
 				$regexp = Constants::getDoubleQuotedVarRegexp();
@@ -508,9 +492,8 @@ public static function getVariablesInsideCompact(File $phpcsFile, $stackPtr, $ar
 				// Substr is to strip the enclosing double-quotes.
 				$varName = substr($argumentFirstToken['content'], 1, -1);
 				$variable = new VariableInfo($varName);
-				$variable->firstRead = $argumentPtrs[0];
+				$variable->firstRead = $firstNonEmpty;
 				$variablePositionsAndNames[] = $variable;
-				continue;
 			}
 		}
 		return $variablePositionsAndNames;

VariableAnalysis/Sniffs/CodeAnalysis/VariableAnalysisSniff.php

@@ -1549,9 +1549,9 @@ protected function processVariableAsPassByReferenceFunctionCall(File $phpcsFile,
 
 		// We're within a function call arguments list, find which arg we are.
 		$argPos = false;
-		foreach ($argPtrs as $idx => $ptrs) {
-			if (in_array($stackPtr, $ptrs)) {
-				$argPos = $idx + 1;
+		foreach ($argPtrs as $idx => $param) {
+			if ($stackPtr >= $param['start'] && $stackPtr <= $param['end']) {
+				$argPos = $idx;
 				break;
 			}
 		}
@@ -1572,7 +1572,8 @@ protected function processVariableAsPassByReferenceFunctionCall(File $phpcsFile,
 
 		// Our argument position matches that of a pass-by-ref argument,
 		// check that we're the only part of the argument expression.
-		foreach ($argPtrs[$argPos - 1] as $ptr) {
+		$param = $argPtrs[$argPos];
+		for ($ptr = (int)$param['start']; $ptr <= (int)$param['end']; $ptr++) {
 			if ($ptr === $stackPtr) {
 				continue;
 			}

psalm-baseline.xml

@@ -15,12 +15,6 @@
     </PossiblyUnusedProperty>
   </file>
   <file src="VariableAnalysis/Lib/Helpers.php">
-    <InvalidArgument>
-      <code><![CDATA[$closePtr]]></code>
-    </InvalidArgument>
-    <InvalidOperand>
-      <code><![CDATA[$closePtr]]></code>
-    </InvalidOperand>
     <PossiblyFalseArgument>
       <code><![CDATA[$varName]]></code>
       <code><![CDATA[$varName]]></code>