MixedType.php

<?php declare(strict_types = 1);

namespace PHPStan\Type;

use ArrayAccess;
use PHPStan\Reflection\ClassMemberAccessAnswerer;
use PHPStan\Reflection\ConstantReflection;
use PHPStan\Reflection\Dummy\DummyConstantReflection;
use PHPStan\Reflection\Dummy\DummyMethodReflection;
use PHPStan\Reflection\Dummy\DummyPropertyReflection;
use PHPStan\Reflection\ExtendedMethodReflection;
use PHPStan\Reflection\ParametersAcceptor;
use PHPStan\Reflection\PropertyReflection;
use PHPStan\Reflection\TrivialParametersAcceptor;
use PHPStan\Reflection\Type\CallbackUnresolvedMethodPrototypeReflection;
use PHPStan\Reflection\Type\CallbackUnresolvedPropertyPrototypeReflection;
use PHPStan\Reflection\Type\UnresolvedMethodPrototypeReflection;
use PHPStan\Reflection\Type\UnresolvedPropertyPrototypeReflection;
use PHPStan\TrinaryLogic;
use PHPStan\Type\Accessory\AccessoryArrayListType;
use PHPStan\Type\Accessory\AccessoryLiteralStringType;
use PHPStan\Type\Accessory\AccessoryNonEmptyStringType;
use PHPStan\Type\Accessory\AccessoryNonFalsyStringType;
use PHPStan\Type\Accessory\AccessoryNumericStringType;
use PHPStan\Type\Accessory\OversizedArrayType;
use PHPStan\Type\Constant\ConstantArrayType;
use PHPStan\Type\Constant\ConstantBooleanType;
use PHPStan\Type\Generic\TemplateMixedType;
use PHPStan\Type\Generic\TemplateType;
use PHPStan\Type\Traits\NonGeneralizableTypeTrait;
use PHPStan\Type\Traits\NonGenericTypeTrait;
use PHPStan\Type\Traits\UndecidedComparisonCompoundTypeTrait;
use function sprintf;

/** @api */
class MixedType implements CompoundType, SubtractableType
{

	use NonGenericTypeTrait;
	use UndecidedComparisonCompoundTypeTrait;
	use NonGeneralizableTypeTrait;

	private ?Type $subtractedType;

	/** @api */
	public function __construct(
		private bool $isExplicitMixed = false,
		?Type $subtractedType = null,
	)
	{
		if ($subtractedType instanceof NeverType) {
			$subtractedType = null;
		}

		$this->subtractedType = $subtractedType;
	}

	/**
	 * @return string[]
	 */
	public function getReferencedClasses(): array
	{
		return [];
	}

	public function getArrays(): array
	{
		return [];
	}

	public function getConstantArrays(): array
	{
		return [];
	}

	public function getConstantStrings(): array
	{
		return [];
	}

	public function accepts(Type $type, bool $strictTypes): TrinaryLogic
	{
		return TrinaryLogic::createYes();
	}

	public function isSuperTypeOfMixed(MixedType $type): TrinaryLogic
	{
		if ($this->subtractedType === null) {
			if ($this->isExplicitMixed) {
				if ($type->isExplicitMixed) {
					return TrinaryLogic::createYes();
				}
				return TrinaryLogic::createMaybe();
			}

			return TrinaryLogic::createYes();
		}

		if ($type->subtractedType === null) {
			return TrinaryLogic::createMaybe();
		}

		$isSuperType = $type->subtractedType->isSuperTypeOf($this->subtractedType);
		if ($isSuperType->yes()) {
			if ($this->isExplicitMixed) {
				if ($type->isExplicitMixed) {
					return TrinaryLogic::createYes();
				}
				return TrinaryLogic::createMaybe();
			}

			return TrinaryLogic::createYes();
		}

		return TrinaryLogic::createMaybe();
	}

	public function isSuperTypeOf(Type $type): TrinaryLogic
	{
		if ($this->subtractedType === null || $type instanceof NeverType) {
			return TrinaryLogic::createYes();
		}

		if ($type instanceof self) {
			if ($type->subtractedType === null) {
				return TrinaryLogic::createMaybe();
			}
			$isSuperType = $type->subtractedType->isSuperTypeOf($this->subtractedType);
			if ($isSuperType->yes()) {
				return TrinaryLogic::createYes();
			}

			return TrinaryLogic::createMaybe();
		}

		return $this->subtractedType->isSuperTypeOf($type)->negate();
	}

	public function setOffsetValueType(?Type $offsetType, Type $valueType, bool $unionValues = true): Type
	{
		return new self($this->isExplicitMixed);
	}

	public function unsetOffset(Type $offsetType): Type
	{
		if ($this->subtractedType !== null) {
			return new self($this->isExplicitMixed, TypeCombinator::remove($this->subtractedType, new ConstantArrayType([], [])));
		}
		return $this;
	}

	public function getKeysArray(): Type
	{
		if ($this->isArray()->no()) {
			return new ErrorType();
		}

		return AccessoryArrayListType::intersectWith(new ArrayType(new IntegerType(), new UnionType([new IntegerType(), new StringType()])));
	}

	public function getValuesArray(): Type
	{
		if ($this->isArray()->no()) {
			return new ErrorType();
		}

		return AccessoryArrayListType::intersectWith(new ArrayType(new IntegerType(), new MixedType($this->isExplicitMixed)));
	}

	public function fillKeysArray(Type $valueType): Type
	{
		if ($this->isArray()->no()) {
			return new ErrorType();
		}

		return new ArrayType($this->getIterableValueType(), $valueType);
	}

	public function flipArray(): Type
	{
		if ($this->isArray()->no()) {
			return new ErrorType();
		}

		return new ArrayType(new MixedType($this->isExplicitMixed), new MixedType($this->isExplicitMixed));
	}

	public function intersectKeyArray(Type $otherArraysType): Type
	{
		if ($this->isArray()->no()) {
			return new ErrorType();
		}

		return new ArrayType(new MixedType($this->isExplicitMixed), new MixedType($this->isExplicitMixed));
	}

	public function popArray(): Type
	{
		if ($this->isArray()->no()) {
			return new ErrorType();
		}

		return new ArrayType(new MixedType($this->isExplicitMixed), new MixedType($this->isExplicitMixed));
	}

	public function searchArray(Type $needleType): Type
	{
		if ($this->isArray()->no()) {
			return new ErrorType();
		}

		return TypeCombinator::union(new IntegerType(), new StringType(), new ConstantBooleanType(false));
	}

	public function shiftArray(): Type
	{
		if ($this->isArray()->no()) {
			return new ErrorType();
		}

		return new ArrayType(new MixedType($this->isExplicitMixed), new MixedType($this->isExplicitMixed));
	}

	public function shuffleArray(): Type
	{
		if ($this->isArray()->no()) {
			return new ErrorType();
		}

		return AccessoryArrayListType::intersectWith(new ArrayType(new IntegerType(), new MixedType($this->isExplicitMixed)));
	}

	public function isCallable(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			if ($this->subtractedType->isSuperTypeOf(new CallableType())->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	/**
	 * @return ParametersAcceptor[]
	 */
	public function getCallableParametersAcceptors(ClassMemberAccessAnswerer $scope): array
	{
		return [new TrivialParametersAcceptor()];
	}

	public function equals(Type $type): bool
	{
		if (!$type instanceof self) {
			return false;
		}

		if ($this->subtractedType === null) {
			if ($type->subtractedType === null) {
				return true;
			}

			return false;
		}

		if ($type->subtractedType === null) {
			return false;
		}

		return $this->subtractedType->equals($type->subtractedType);
	}

	public function isSubTypeOf(Type $otherType): TrinaryLogic
	{
		if ($otherType instanceof self && !$otherType instanceof TemplateMixedType) {
			return TrinaryLogic::createYes();
		}

		if ($this->subtractedType !== null) {
			$isSuperType = $this->subtractedType->isSuperTypeOf($otherType);
			if ($isSuperType->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	public function isAcceptedBy(Type $acceptingType, bool $strictTypes): TrinaryLogic
	{
		$isSuperType = $this->isSuperTypeOf($acceptingType);
		if ($isSuperType->no()) {
			return $isSuperType;
		}
		return TrinaryLogic::createYes();
	}

	public function canAccessProperties(): TrinaryLogic
	{
		return TrinaryLogic::createYes();
	}

	public function hasProperty(string $propertyName): TrinaryLogic
	{
		return TrinaryLogic::createYes();
	}

	public function getProperty(string $propertyName, ClassMemberAccessAnswerer $scope): PropertyReflection
	{
		return $this->getUnresolvedPropertyPrototype($propertyName, $scope)->getTransformedProperty();
	}

	public function getUnresolvedPropertyPrototype(string $propertyName, ClassMemberAccessAnswerer $scope): UnresolvedPropertyPrototypeReflection
	{
		$property = new DummyPropertyReflection();
		return new CallbackUnresolvedPropertyPrototypeReflection(
			$property,
			$property->getDeclaringClass(),
			false,
			static fn (Type $type): Type => $type,
		);
	}

	public function canCallMethods(): TrinaryLogic
	{
		return TrinaryLogic::createYes();
	}

	public function hasMethod(string $methodName): TrinaryLogic
	{
		return TrinaryLogic::createYes();
	}

	public function getMethod(string $methodName, ClassMemberAccessAnswerer $scope): ExtendedMethodReflection
	{
		return $this->getUnresolvedMethodPrototype($methodName, $scope)->getTransformedMethod();
	}

	public function getUnresolvedMethodPrototype(string $methodName, ClassMemberAccessAnswerer $scope): UnresolvedMethodPrototypeReflection
	{
		$method = new DummyMethodReflection($methodName);
		return new CallbackUnresolvedMethodPrototypeReflection(
			$method,
			$method->getDeclaringClass(),
			false,
			static fn (Type $type): Type => $type,
		);
	}

	public function canAccessConstants(): TrinaryLogic
	{
		return TrinaryLogic::createYes();
	}

	public function hasConstant(string $constantName): TrinaryLogic
	{
		return TrinaryLogic::createYes();
	}

	public function getConstant(string $constantName): ConstantReflection
	{
		return new DummyConstantReflection($constantName);
	}

	public function isCloneable(): TrinaryLogic
	{
		return TrinaryLogic::createYes();
	}

	public function describe(VerbosityLevel $level): string
	{
		return $level->handle(
			static fn (): string => 'mixed',
			static fn (): string => 'mixed',
			function () use ($level): string {
				$description = 'mixed';
				if ($this->subtractedType !== null) {
					$description .= sprintf('~%s', $this->subtractedType->describe($level));
				}

				return $description;
			},
			function () use ($level): string {
				$description = 'mixed';
				if ($this->subtractedType !== null) {
					$description .= sprintf('~%s', $this->subtractedType->describe($level));
				}

				if ($this->isExplicitMixed) {
					$description .= '=explicit';
				} else {
					$description .= '=implicit';
				}

				return $description;
			},
		);
	}

	public function toBoolean(): BooleanType
	{
		if ($this->subtractedType !== null && StaticTypeFactory::falsey()->equals($this->subtractedType)) {
			return new ConstantBooleanType(true);
		}

		return new BooleanType();
	}

	public function toNumber(): Type
	{
		return new UnionType([
			$this->toInteger(),
			$this->toFloat(),
		]);
	}

	public function toInteger(): Type
	{
		return new IntegerType();
	}

	public function toFloat(): Type
	{
		return new FloatType();
	}

	public function toString(): Type
	{
		return new StringType();
	}

	public function toArray(): Type
	{
		$mixed = new self($this->isExplicitMixed);

		return new ArrayType($mixed, $mixed);
	}

	public function toArrayKey(): Type
	{
		return new UnionType([new IntegerType(), new StringType()]);
	}

	public function isIterable(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			if ($this->subtractedType->isSuperTypeOf(new IterableType(new MixedType(), new MixedType()))->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	public function isIterableAtLeastOnce(): TrinaryLogic
	{
		return $this->isIterable();
	}

	public function getArraySize(): Type
	{
		if ($this->isIterable()->no()) {
			return new ErrorType();
		}

		return IntegerRangeType::fromInterval(0, null);
	}

	public function getIterableKeyType(): Type
	{
		return new self($this->isExplicitMixed);
	}

	public function getFirstIterableKeyType(): Type
	{
		return new self($this->isExplicitMixed);
	}

	public function getLastIterableKeyType(): Type
	{
		return new self($this->isExplicitMixed);
	}

	public function getIterableValueType(): Type
	{
		return new self($this->isExplicitMixed);
	}

	public function getFirstIterableValueType(): Type
	{
		return new self($this->isExplicitMixed);
	}

	public function getLastIterableValueType(): Type
	{
		return new self($this->isExplicitMixed);
	}

	public function isOffsetAccessible(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			$offsetAccessibles = new UnionType([
				new StringType(),
				new ArrayType(new MixedType(), new MixedType()),
				new ObjectType(ArrayAccess::class),
			]);

			if ($this->subtractedType->isSuperTypeOf($offsetAccessibles)->yes()) {
				return TrinaryLogic::createNo();
			}
		}
		return TrinaryLogic::createMaybe();
	}

	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
	{
		if ($this->isOffsetAccessible()->no()) {
			return TrinaryLogic::createNo();
		}

		return TrinaryLogic::createMaybe();
	}

	public function getOffsetValueType(Type $offsetType): Type
	{
		return new self($this->isExplicitMixed);
	}

	public function isExplicitMixed(): bool
	{
		return $this->isExplicitMixed;
	}

	public function subtract(Type $type): Type
	{
		if ($type instanceof self && !$type instanceof TemplateType) {
			return new NeverType();
		}
		if ($this->subtractedType !== null) {
			$type = TypeCombinator::union($this->subtractedType, $type);
		}

		return new self($this->isExplicitMixed, $type);
	}

	public function getTypeWithoutSubtractedType(): Type
	{
		return new self($this->isExplicitMixed);
	}

	public function changeSubtractedType(?Type $subtractedType): Type
	{
		return new self($this->isExplicitMixed, $subtractedType);
	}

	public function getSubtractedType(): ?Type
	{
		return $this->subtractedType;
	}

	public function traverse(callable $cb): Type
	{
		return $this;
	}

	public function isArray(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			if ($this->subtractedType->isSuperTypeOf(new ArrayType(new MixedType(), new MixedType()))->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	public function isConstantArray(): TrinaryLogic
	{
		return $this->isArray();
	}

	public function isOversizedArray(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			$oversizedArray = TypeCombinator::intersect(
				new ArrayType(new MixedType(), new MixedType()),
				new OversizedArrayType(),
			);

			if ($this->subtractedType->isSuperTypeOf($oversizedArray)->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	public function isList(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			$list = TypeCombinator::intersect(
				new ArrayType(new IntegerType(), new MixedType()),
				new AccessoryArrayListType(),
			);

			if ($this->subtractedType->isSuperTypeOf($list)->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	public function isNull(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			if ($this->subtractedType->isSuperTypeOf(new NullType())->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	public function isTrue(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			if ($this->subtractedType->isSuperTypeOf(new ConstantBooleanType(true))->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	public function isFalse(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			if ($this->subtractedType->isSuperTypeOf(new ConstantBooleanType(false))->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	public function isBoolean(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			if ($this->subtractedType->isSuperTypeOf(new BooleanType())->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	public function isFloat(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			if ($this->subtractedType->isSuperTypeOf(new FloatType())->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	public function isInteger(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			if ($this->subtractedType->isSuperTypeOf(new IntegerType())->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	public function isString(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			if ($this->subtractedType->isSuperTypeOf(new StringType())->yes()) {
				return TrinaryLogic::createNo();
			}
		}
		return TrinaryLogic::createMaybe();
	}

	public function isNumericString(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			$numericString = TypeCombinator::intersect(
				new StringType(),
				new AccessoryNumericStringType(),
			);

			if ($this->subtractedType->isSuperTypeOf($numericString)->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	public function isNonEmptyString(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			$nonEmptyString = TypeCombinator::intersect(
				new StringType(),
				new AccessoryNonEmptyStringType(),
			);

			if ($this->subtractedType->isSuperTypeOf($nonEmptyString)->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	public function isNonFalsyString(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			$nonFalsyString = TypeCombinator::intersect(
				new StringType(),
				new AccessoryNonFalsyStringType(),
			);

			if ($this->subtractedType->isSuperTypeOf($nonFalsyString)->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	public function isLiteralString(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			$literalString = TypeCombinator::intersect(
				new StringType(),
				new AccessoryLiteralStringType(),
			);

			if ($this->subtractedType->isSuperTypeOf($literalString)->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	public function isClassStringType(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			if ($this->subtractedType->isSuperTypeOf(new StringType())->yes()) {
				return TrinaryLogic::createNo();
			}
			if ($this->subtractedType->isSuperTypeOf(new ClassStringType())->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	public function isVoid(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			if ($this->subtractedType->isSuperTypeOf(new VoidType())->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	public function isScalar(): TrinaryLogic
	{
		if ($this->subtractedType !== null) {
			if ($this->subtractedType->isSuperTypeOf(new UnionType([new BooleanType(), new FloatType(), new IntegerType(), new StringType()]))->yes()) {
				return TrinaryLogic::createNo();
			}
		}

		return TrinaryLogic::createMaybe();
	}

	public function tryRemove(Type $typeToRemove): ?Type
	{
		if ($this->isSuperTypeOf($typeToRemove)->yes()) {
			return $this->subtract($typeToRemove);
		}

		return null;
	}

	/**
	 * @param mixed[] $properties
	 */
	public static function __set_state(array $properties): Type
	{
		return new self(
			$properties['isExplicitMixed'],
			$properties['subtractedType'] ?? null,
		);
	}

}