Improve abs() return type

phpstan · Jul 27, 2024 · a079c45 · a079c45
1 parent 465af9e
commit a079c45
Show file tree

Hide file tree

Showing 41 changed files with 465 additions and 4 deletions.
diff --git a/conf/config.neon b/conf/config.neon
@@ -1108,6 +1108,11 @@ services:
 	-
 		class: PHPStan\Type\BitwiseFlagHelper
 
+	-
+		class: PHPStan\Type\Php\AbsFunctionDynamicReturnTypeExtension
+		tags:
+			- phpstan.broker.dynamicFunctionReturnTypeExtension
+
 	-
 		class: PHPStan\Type\Php\ArgumentBasedFunctionReturnTypeExtension
 		tags:

diff --git a/src/Type/Accessory/AccessoryArrayListType.php b/src/Type/Accessory/AccessoryArrayListType.php
@@ -408,6 +408,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toInteger(): Type
 	{
 		return TypeCombinator::union(

diff --git a/src/Type/Accessory/AccessoryLiteralStringType.php b/src/Type/Accessory/AccessoryLiteralStringType.php
@@ -171,6 +171,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toInteger(): Type
 	{
 		return new IntegerType();

diff --git a/src/Type/Accessory/AccessoryNonEmptyStringType.php b/src/Type/Accessory/AccessoryNonEmptyStringType.php
@@ -177,6 +177,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toInteger(): Type
 	{
 		return new IntegerType();

diff --git a/src/Type/Accessory/AccessoryNonFalsyStringType.php b/src/Type/Accessory/AccessoryNonFalsyStringType.php
@@ -173,6 +173,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toInteger(): Type
 	{
 		return new IntegerType();

diff --git a/src/Type/Accessory/AccessoryNumericStringType.php b/src/Type/Accessory/AccessoryNumericStringType.php
@@ -179,6 +179,11 @@ public function toNumber(): Type
 		]);
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return $this->toNumber()->toAbsoluteNumber();
+	}
+
 	public function toInteger(): Type
 	{
 		return new IntegerType();

diff --git a/src/Type/Accessory/HasOffsetType.php b/src/Type/Accessory/HasOffsetType.php
@@ -328,6 +328,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toInteger(): Type
 	{
 		return new ErrorType();

diff --git a/src/Type/Accessory/HasOffsetValueType.php b/src/Type/Accessory/HasOffsetValueType.php
@@ -374,6 +374,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toInteger(): Type
 	{
 		return new ErrorType();

diff --git a/src/Type/Accessory/NonEmptyArrayType.php b/src/Type/Accessory/NonEmptyArrayType.php
@@ -389,6 +389,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toInteger(): Type
 	{
 		return new ConstantIntegerType(1);

diff --git a/src/Type/Accessory/OversizedArrayType.php b/src/Type/Accessory/OversizedArrayType.php
@@ -385,6 +385,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toInteger(): Type
 	{
 		return new ConstantIntegerType(1);

diff --git a/src/Type/ArrayType.php b/src/Type/ArrayType.php
@@ -588,6 +588,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toString(): Type
 	{
 		return new ErrorType();

diff --git a/src/Type/BooleanType.php b/src/Type/BooleanType.php
@@ -56,6 +56,11 @@ public function toNumber(): Type
 		return $this->toInteger();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return $this->toNumber()->toAbsoluteNumber();
+	}
+
 	public function toString(): Type
 	{
 		return TypeCombinator::union(

diff --git a/src/Type/CallableType.php b/src/Type/CallableType.php
@@ -299,6 +299,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toString(): Type
 	{
 		return new ErrorType();

diff --git a/src/Type/ClosureType.php b/src/Type/ClosureType.php
@@ -422,6 +422,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toInteger(): Type
 	{
 		return new ErrorType();

diff --git a/src/Type/Constant/ConstantBooleanType.php b/src/Type/Constant/ConstantBooleanType.php
@@ -82,6 +82,11 @@ public function toNumber(): Type
 		return new ConstantIntegerType((int) $this->value);
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return $this->toNumber()->toAbsoluteNumber();
+	}
+
 	public function toString(): Type
 	{
 		return new ConstantStringType((string) $this->value);

diff --git a/src/Type/Constant/ConstantFloatType.php b/src/Type/Constant/ConstantFloatType.php
@@ -12,6 +12,7 @@
 use PHPStan\Type\Traits\ConstantScalarTypeTrait;
 use PHPStan\Type\Type;
 use PHPStan\Type\VerbosityLevel;
+use function abs;
 use function ini_get;
 use function ini_set;
 use function is_finite;
@@ -76,6 +77,11 @@ public function toInteger(): Type
 		return new ConstantIntegerType((int) $this->value);
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new self(abs($this->value));
+	}
+
 	public function toArrayKey(): Type
 	{
 		return new ConstantIntegerType((int) $this->value);

diff --git a/src/Type/Constant/ConstantIntegerType.php b/src/Type/Constant/ConstantIntegerType.php
@@ -15,6 +15,7 @@
 use PHPStan\Type\Traits\ConstantScalarTypeTrait;
 use PHPStan\Type\Type;
 use PHPStan\Type\VerbosityLevel;
+use function abs;
 use function sprintf;
 
 /** @api */
@@ -76,6 +77,11 @@ public function toFloat(): Type
 		return new ConstantFloatType($this->value);
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new self(abs($this->value));
+	}
+
 	public function toString(): Type
 	{
 		return new ConstantStringType((string) $this->value);

diff --git a/src/Type/Constant/ConstantStringType.php b/src/Type/Constant/ConstantStringType.php
@@ -292,6 +292,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return $this->toNumber()->toAbsoluteNumber();
+	}
+
 	public function toInteger(): Type
 	{
 		return new ConstantIntegerType((int) $this->value);

diff --git a/src/Type/FloatType.php b/src/Type/FloatType.php
@@ -110,6 +110,11 @@ public function toNumber(): Type
 		return $this;
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return $this;
+	}
+
 	public function toFloat(): Type
 	{
 		return $this;

diff --git a/src/Type/IntegerRangeType.php b/src/Type/IntegerRangeType.php
@@ -447,6 +447,21 @@ public function toBoolean(): BooleanType
 		return new ConstantBooleanType(false);
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		if ($this->min !== null && $this->min >= 0) {
+			return $this;
+		}
+
+		if ($this->max === null || $this->max >= 0) {
+			$inversedMin = $this->min !== null ? $this->min * -1 : null;
+
+			return self::fromInterval(0, $inversedMin !== null && $this->max !== null ? max($inversedMin, $this->max) : null);
+		}
+
+		return self::fromInterval($this->max * -1, $this->min !== null ? $this->min * -1 : null);
+	}
+
 	public function toString(): Type
 	{
 		$isZero = (new ConstantIntegerType(0))->isSuperTypeOf($this);

diff --git a/src/Type/IntegerType.php b/src/Type/IntegerType.php
@@ -62,6 +62,11 @@ public function toNumber(): Type
 		return $this;
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return IntegerRangeType::createAllGreaterThanOrEqualTo(0);
+	}
+
 	public function toFloat(): Type
 	{
 		return new FloatType();

diff --git a/src/Type/IntersectionType.php b/src/Type/IntersectionType.php
@@ -914,6 +914,13 @@ public function toNumber(): Type
 		return $type;
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		$type = $this->intersectTypes(static fn (Type $type): Type => $type->toAbsoluteNumber());
+
+		return $type;
+	}
+
 	public function toString(): Type
 	{
 		$type = $this->intersectTypes(static fn (Type $type): Type => $type->toString());

diff --git a/src/Type/IterableType.php b/src/Type/IterableType.php
@@ -217,6 +217,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toString(): Type
 	{
 		return new ErrorType();

diff --git a/src/Type/MixedType.php b/src/Type/MixedType.php
@@ -468,6 +468,11 @@ public function toNumber(): Type
 		]);
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return $this->toNumber()->toAbsoluteNumber();
+	}
+
 	public function toInteger(): Type
 	{
 		return new IntegerType();

diff --git a/src/Type/NeverType.php b/src/Type/NeverType.php
@@ -351,6 +351,11 @@ public function toNumber(): Type
 		return $this;
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return $this;
+	}
+
 	public function toString(): Type
 	{
 		return $this;

diff --git a/src/Type/NonexistentParentClassType.php b/src/Type/NonexistentParentClassType.php
@@ -127,6 +127,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return new ErrorType();
+	}
+
 	public function toString(): Type
 	{
 		return new ErrorType();

diff --git a/src/Type/NullType.php b/src/Type/NullType.php
@@ -144,6 +144,11 @@ public function toNumber(): Type
 		return new ConstantIntegerType(0);
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return $this->toNumber()->toAbsoluteNumber();
+	}
+
 	public function toString(): Type
 	{
 		return new ConstantStringType('');

diff --git a/src/Type/ObjectType.php b/src/Type/ObjectType.php
@@ -563,6 +563,11 @@ public function toNumber(): Type
 		return new ErrorType();
 	}
 
+	public function toAbsoluteNumber(): Type
+	{
+		return $this->toNumber()->toAbsoluteNumber();
+	}
+
 	public function toInteger(): Type
 	{
 		if ($this->isInstanceOf('SimpleXMLElement')->yes()) {