pkg/kernel/lib/src/non_null.dart

// Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE.md file.

import '../ast.dart';

/// Returns the type defines as `NonNull(type)` in the nnbd specification.
DartType computeNonNull(DartType type) {
  return type.accept(const _NonNullVisitor()) ?? type;
}

/// Visitor that computes the `NonNull` function defined in the nnbd
/// specification.
///
/// The visitor returns `null` if `NonNull(T) = T`.
class _NonNullVisitor implements DartTypeVisitor<DartType?> {
  const _NonNullVisitor();

  @override
  DartType? defaultDartType(DartType node) {
    throw new UnsupportedError(
        "Unexpected DartType ${node} (${node.runtimeType})");
  }

  @override
  DartType? visitBottomType(BottomType node) => null;

  @override
  DartType? visitDynamicType(DynamicType node) => null;

  @override
  DartType? visitFunctionType(FunctionType node) {
    if (node.declaredNullability == Nullability.nonNullable) {
      return null;
    }
    return node.withDeclaredNullability(Nullability.nonNullable);
  }

  @override
  DartType? visitFutureOrType(FutureOrType node) {
    DartType? typeArgument = node.typeArgument.accept(this);
    if (node.declaredNullability == Nullability.nonNullable &&
        typeArgument == null) {
      return null;
    }
    return new FutureOrType(
        typeArgument ?? node.typeArgument, Nullability.nonNullable);
  }

  @override
  DartType? visitInterfaceType(InterfaceType node) {
    if (node.declaredNullability == Nullability.nonNullable) {
      return null;
    }
    return node.withDeclaredNullability(Nullability.nonNullable);
  }

  @override
  DartType? visitInvalidType(InvalidType node) => null;

  @override
  DartType? visitNeverType(NeverType node) {
    if (node.declaredNullability == Nullability.nonNullable) {
      return null;
    }
    return const NeverType.nonNullable();
  }

  @override
  DartType? visitNullType(NullType node) {
    return const NeverType.nonNullable();
  }

  @override
  DartType? visitTypeParameterType(TypeParameterType node) {
    if (node.nullability == Nullability.nonNullable) {
      return null;
    }
    if (node.promotedBound != null) {
      if (node.promotedBound!.nullability == Nullability.nonNullable) {
        // The promoted bound is already non-nullable so we set the declared
        // nullability to non-nullable.
        return node.withDeclaredNullability(Nullability.nonNullable);
      }
      DartType? promotedBound = node.promotedBound!.accept(this);
      if (promotedBound == null) {
        // The promoted bound could not be made non-nullable so we set the
        // declared nullability to undetermined.
        if (node.declaredNullability == Nullability.undetermined) {
          return null;
        }
        return new TypeParameterType.intersection(
            node.parameter, Nullability.undetermined, node.promotedBound!);
      } else if (promotedBound.nullability == Nullability.nonNullable) {
        // The bound could be made non-nullable so we use it as the promoted
        // bound.
        return new TypeParameterType.intersection(
            node.parameter, Nullability.nonNullable, promotedBound);
      } else {
        // The bound could not be made non-nullable so we use it as the promoted
        // bound with undetermined nullability.
        return new TypeParameterType.intersection(
            node.parameter, Nullability.undetermined, promotedBound);
      }
    } else {
      if (node.bound.nullability == Nullability.nonNullable) {
        // The bound is already non-nullable so we set the declared nullability
        // to non-nullable.
        return node.withDeclaredNullability(Nullability.nonNullable);
      }
      DartType? bound = node.bound.accept(this);
      if (bound == null) {
        // The bound could not be made non-nullable so we set the declared
        // nullability to undetermined.
        if (node.declaredNullability == Nullability.undetermined) {
          return null;
        }
        return node.withDeclaredNullability(Nullability.undetermined);
      } else {
        // The nullability is fully determined by the bound so we pass the
        // default nullability for the declared nullability.
        return new TypeParameterType.intersection(
            node.parameter,
            TypeParameterType.computeNullabilityFromBound(node.parameter),
            bound);
      }
    }
  }

  @override
  DartType? visitTypedefType(TypedefType node) {
    if (node.declaredNullability == Nullability.nonNullable) {
      return null;
    }
    return node.withDeclaredNullability(Nullability.nonNullable);
  }

  @override
  DartType? visitVoidType(VoidType node) => null;
}