Implement PrimitiveOrNull types.

lib/compiler/implementation/ssa/types.dart

 // Copyright (c) 2012, 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 file.
 
 abstract class HType {
   const HType();
 
   /**
    * Returns a [HType] that represents all types that have [type] as a
    * supertype, or the type [type].

[floitsch, 2012/05/10 10:29:43]

Returns an [HType] that represents [type] and all types that have [type] as
supertype.

[ngeoffray, 2012/05/11 10:17:54]

Done.

    */
   factory HType.fromBoundedType(Type type,
                                 Compiler compiler,
                                 [bool canBeNull = false]) {
     Element element = type.element;
     if (element.kind === ElementKind.TYPE_VARIABLE) {
-      compiler.unimplemented("type variables");
+      // TODO(ngeoffray): Replace object type type [type].

[floitsch, 2012/05/10 10:29:43]

type type [type] ?

[ngeoffray, 2012/05/11 10:17:54]

Done.

+      return new HBoundedPotentialPrimitiveType(
+          compiler.objectClass.computeType(compiler), canBeNull);
     }
 
-    if (!canBeNull) {
-      if (element === compiler.intClass) {
-        return HType.INTEGER;
-      } else if (element === compiler.numClass) {
-        return HType.NUMBER;
-      } else if (element === compiler.doubleClass) {
-        return HType.DOUBLE;
-      } else if (element === compiler.stringClass) {
-        return HType.STRING;
-      } else if (element === compiler.boolClass) {
-        return HType.BOOLEAN;
-      }
-    }
-    if (element === compiler.listClass
+    if (element === compiler.intClass) {
+      return canBeNull ? HType.INTEGER_OR_NULL : HType.INTEGER;
+    } else if (element === compiler.numClass) {
+      return canBeNull ? HType.NUMBER_OR_NULL : HType.NUMBER;
+    } else if (element === compiler.doubleClass) {
+      return canBeNull ? HType.DOUBLE_OR_NULL : HType.DOUBLE;
+    } else if (element === compiler.stringClass) {
+      return canBeNull ? HType.STRING_OR_NULL : HType.STRING;
+    } else if (element === compiler.boolClass) {
+      return canBeNull ? HType.BOOLEAN_OR_NULL : HType.BOOLEAN;
+    } else if (element === compiler.listClass
         || Elements.isListSupertype(element, compiler)) {
       return new HBoundedPotentialPrimitiveArray(type, canBeNull);
     } else if (Elements.isStringSupertype(element, compiler)) {
       return new HBoundedPotentialPrimitiveString(type, canBeNull);
-    } else if (element === compiler.intClass
-               || element === compiler.boolClass
-               || element === compiler.numClass
-               || element === compiler.doubleClass
-               || element === compiler.stringClass) {
-      // TODO(ngeoffray): Create primitive nullable types.
-      return null;
     } else {
       return new HBoundedType(type, canBeNull);
     }
   }
 
   static final HType CONFLICTING = const HAnalysisType("conflicting");
   static final HType UNKNOWN = const HAnalysisType("unknown");
   static final HType BOOLEAN = const HBooleanType();
   static final HType NUMBER = const HNumberType();
   static final HType INTEGER = const HIntegerType();
   static final HType DOUBLE = const HDoubleType();
   static final HType INDEXABLE_PRIMITIVE = const HIndexablePrimitiveType();
   static final HType STRING = const HStringType();
   static final HType READABLE_ARRAY = const HReadableArrayType();
   static final HType MUTABLE_ARRAY = const HMutableArrayType();
   static final HType EXTENDABLE_ARRAY = const HExtendableArrayType();
 
+  static final HType BOOLEAN_OR_NULL = const HBooleanOrNullType();

[Lasse Reichstein Nielsen, 2012/05/10 10:15:20]

DO you think it will eventually be worth it to have general sum types?

[ngeoffray, 2012/05/11 10:17:54]

Yes. As discussed, I preferred special casing these types because we already
special case their non-null equivalent. And lots of our optimizations assume
something like isInteger to not be null.

But for general types, I believe we will have a more generalized abstraction for
sum types.

+  static final HType NUMBER_OR_NULL = const HNumberOrNullType();
+  static final HType INTEGER_OR_NULL = const HIntegerOrNullType();
+  static final HType DOUBLE_OR_NULL = const HDoubleOrNullType();
+  static final HType STRING_OR_NULL = const HStringOrNullType();
+
   bool isConflicting() => this === CONFLICTING;
   bool isUnknown() => this === UNKNOWN;
   bool isBoolean() => false;
   bool isNumber() => false;
   bool isInteger() => false;
   bool isDouble() => false;
   bool isString() => false;
+  bool isBooleanOrNull() => false;
+  bool isNumberOrNull() => false;
+  bool isIntegerOrNull() => false;
+  bool isDoubleOrNull() => false;
+  bool isStringOrNull() => false;
   bool isIndexablePrimitive() => false;
   bool isReadableArray() => false;
   bool isMutableArray() => false;
   bool isExtendableArray() => false;
   bool isPrimitive() => false;
   bool isExact() => false;
 
   bool canBePrimitive() => false;
   bool canBeNull() => false;
 
@@ skipping 53 matching lines @@
   HType union(HType other) => combine(other);
   HType intersection(HType other) => combine(other);
 }
 
 abstract class HPrimitiveType extends HType {
   const HPrimitiveType();
   bool isPrimitive() => true;
   bool canBePrimitive() => true;
 }
 
+abstract class HPrimitiveOrNullType extends HType {
+  const HPrimitiveOrNullType();
+  bool canBePrimitive() => true;
+  bool canBeNull() => true;
+}
+
+class HBooleanOrNullType extends HPrimitiveOrNullType {
+  const HBooleanOrNullType();
+  String toString() => "boolean or null";
+  bool isBooleanOrNull() => true;
+
+  Type computeType(Compiler compiler) {
+    return compiler.boolClass.computeType(compiler);
+  }
+
+  HType union(HType other) {
+    if (other.isUnknown()) return HType.BOOLEAN_OR_NULL;
+    if (other.isBooleanOrNull()) return HType.BOOLEAN_OR_NULL;
+    if (other.isBoolean()) return HType.BOOLEAN_OR_NULL;
+    return HType.CONFLICTING;
+  }
+
+  HType intersection(HType other) {
+    if (other.isUnknown()) return HType.BOOLEAN_OR_NULL;
+    if (other.isBooleanOrNull()) return HType.BOOLEAN_OR_NULL;
+    if (other.isBoolean()) return HType.BOOLEAN;
+    return HType.CONFLICTING;
+  }
+}
+
 class HBooleanType extends HPrimitiveType {
   const HBooleanType();
   bool isBoolean() => true;
   String toString() => "boolean";
 
   Type computeType(Compiler compiler) {
     return compiler.boolClass.computeType(compiler);
   }
 
-  HType combine(HType other) {
-    if (other.isBoolean() || other.isUnknown()) return HType.BOOLEAN;
+  HType union(HType other) {
+    if (other.isUnknown()) return HType.BOOLEAN;
+    if (other.isBoolean()) return HType.BOOLEAN;
+    if (other.isBooleanOrNull()) return HType.BOOLEAN_OR_NULL;
     return HType.CONFLICTING;
   }
 
-  // Since the boolean type is a one-element set the union and intersection are
-  // the same.
-  HType union(HType other) => combine(other);
-  HType intersection(HType other) => combine(other);
+  HType intersection(HType other) {
+    if (other.isUnknown()) return HType.BOOLEAN;
+    if (other.isBooleanOrNull()) return HType.BOOLEAN;
+    if (other.isBoolean()) return HType.BOOLEAN;
+    return HType.CONFLICTING;
+  }
+}
+
+class HNumberOrNullType extends HPrimitiveOrNullType {
+  const HNumberOrNullType();
+  bool isNumberOrNull() => true;
+  String toString() => "number or null";
+
+  Type computeType(Compiler compiler) {
+    return compiler.numClass.computeType(compiler);
+  }
+
+  HType union(HType other) {
+    if (other.isUnknown()) return HType.NUMBER_OR_NULL;
+    if (other.isNumberOrNull()) return HType.NUMBER_OR_NULL;
+    if (other.isNumber()) return HType.NUMBER_OR_NULL;
+    return HType.CONFLICTING;
+  }
+
+  HType intersection(HType other) {
+    if (other.isUnknown()) return HType.NUMBER_OR_NULL;
+    if (other.isNumberOrNull()) return HType.NUMBER_OR_NULL;

[floitsch, 2012/05/10 10:29:43]

not correct for integers or doubles.

[ngeoffray, 2012/05/11 10:17:54]

Done.

+    if (other.isNumber()) return HType.NUMBER;
+    return HType.CONFLICTING;
+  }
 }
 
 class HNumberType extends HPrimitiveType {
   const HNumberType();
   bool isNumber() => true;
   String toString() => "number";
 
   Type computeType(Compiler compiler) {
     return compiler.numClass.computeType(compiler);
   }
 
   HType union(HType other) {
-    if (other.isNumber() || other.isUnknown()) return HType.NUMBER;
+    if (other.isNumber()) return HType.NUMBER;
+    if (other.isUnknown()) return HType.NUMBER;
+    if (other.isNumberOrNull()) return HType.NUMBER_OR_NULL;
     return HType.CONFLICTING;
   }
 
   HType intersection(HType other) {
     if (other.isUnknown()) return HType.NUMBER;
     if (other.isNumber()) return other;
+    if (other.isIntegerOrNull()) return HType.INTEGER;
+    if (other.isDoubleOrNull()) return HType.DOUBLE;
+    if (other.isNumberOrNull()) return HType.NUMBER;
+    return HType.CONFLICTING;
+  }
+}
+
+class HIntegerOrNullType extends HNumberOrNullType {
+  const HIntegerOrNullType();
+  bool isIntegerOrNull() => true;
+  String toString() => "integer or null";
+
+  Type computeType(Compiler compiler) {
+    return compiler.intClass.computeType(compiler);
+  }
+
+  HType union(HType other) {
+    if (other.isUnknown()) return HType.INTEGER_OR_NULL;
+    if (other.isIntegerOrNull()) return HType.INTEGER_OR_NULL;
+    if (other.isInteger()) return HType.INTEGER_OR_NULL;
+    if (other.isNumber()) return HType.NUMBER_OR_NULL;
+    if (other.isNumberOrNull()) return HType.NUMBER_OR_NULL;
+    return HType.CONFLICTING;
+  }
+
+  HType intersection(HType other) {
+    if (other.isUnknown()) return HType.INTEGER_OR_NULL;
+    if (other.isIntegerOrNull()) return HType.INTEGER_OR_NULL;
+    if (other.isInteger()) return HType.INTEGER;
+    if (other.isDouble()) return HType.CONFLICTING;
+    if (other.isDoubleOrNull()) return HType.CONFLICTING;
+    if (other.isNumber()) return HType.INTEGER;
+    if (other.isNumberOrNull()) return HType.INTEGER_OR_NULL;
     return HType.CONFLICTING;
   }
 }
 
 class HIntegerType extends HNumberType {
   const HIntegerType();
   bool isInteger() => true;
   String toString() => "integer";
 
   Type computeType(Compiler compiler) {
     return compiler.intClass.computeType(compiler);
   }
 
   HType union(HType other) {
-    if (other.isInteger() || other.isUnknown()) return HType.INTEGER;
+    if (other.isUnknown()) return HType.INTEGER;
+    if (other.isInteger()) return HType.INTEGER;
+    if (other.isIntegerOrNull()) return HType.INTEGER_OR_NULL;
     if (other.isNumber()) return HType.NUMBER;
+    if (other.isNumberOrNull()) return HType.NUMBER_OR_NULL;
     return HType.CONFLICTING;
   }
 
   HType intersection(HType other) {
     if (other.isUnknown()) return HType.INTEGER;
+    if (other.isIntegerOrNull()) return HType.INTEGER;
+    if (other.isInteger()) return HType.INTEGER;
     if (other.isDouble()) return HType.CONFLICTING;
-    if (other.isNumber()) return this;
+    if (other.isDoubleOrNull()) return HType.CONFLICTING;
+    if (other.isNumber()) return HType.INTEGER;
+    if (other.isNumberOrNull()) return HType.INTEGER;
+    return HType.CONFLICTING;
+  }
+}
+
+class HDoubleOrNullType extends HNumberOrNullType {
+  const HDoubleOrNullType();
+  bool isDoubleOrNull() => true;
+  String toString() => "double or null";
+
+  Type computeType(Compiler compiler) {
+    return compiler.doubleClass.computeType(compiler);
+  }
+
+  HType union(HType other) {
+    if (other.isUnknown()) return HType.DOUBLE_OR_NULL;
+    if (other.isDoubleOrNull()) return HType.DOUBLE_OR_NULL;
+    if (other.isDouble()) return HType.DOUBLE_OR_NULL;
+    if (other.isNumber()) return HType.NUMBER_OR_NULL;
+    if (other.isNumberOrNull()) return HType.NUMBER_OR_NULL;
+    return HType.CONFLICTING;
+  }
+
+  HType intersection(HType other) {
+    if (other.isUnknown()) return HType.DOUBLE_OR_NULL;
+    if (other.isIntegerOrNull()) return HType.CONFLICTING;
+    if (other.isInteger()) return HType.CONFLICTING;
+    if (other.isDouble()) return HType.DOUBLE;
+    if (other.isDoubleOrNull()) return HType.DOUBLE_OR_NULL;
+    if (other.isNumber()) return HType.DOUBLE;
+    if (other.isNumberOrNull()) return HType.DOUBLE_OR_NULL;
     return HType.CONFLICTING;
   }
 }
 
 class HDoubleType extends HNumberType {
   const HDoubleType();
   bool isDouble() => true;
   String toString() => "double";
 
   Type computeType(Compiler compiler) {
     return compiler.doubleClass.computeType(compiler);
   }
 
   HType union(HType other) {
-    if (other.isDouble() || other.isUnknown()) return HType.DOUBLE;
+    if (other.isUnknown()) return HType.DOUBLE;
+    if (other.isDouble()) return HType.DOUBLE;
+    if (other.isDoubleOrNull()) return HType.DOUBLE_OR_NULL;
     if (other.isNumber()) return HType.NUMBER;
+    if (other.isNumberOrNull()) return HType.NUMBER_OR_NULL;
     return HType.CONFLICTING;
   }
 
   HType intersection(HType other) {
     if (other.isUnknown()) return HType.DOUBLE;
+    if (other.isIntegerOrNull()) return HType.CONFLICTING;
     if (other.isInteger()) return HType.CONFLICTING;
-    if (other.isNumber()) return this;
+    if (other.isDouble()) return HType.DOUBLE;
+    if (other.isDoubleOrNull()) return HType.DOUBLE;
+    if (other.isNumber()) return HType.DOUBLE;
+    if (other.isNumberOrNull()) return HType.DOUBLE;
     return HType.CONFLICTING;
   }
 }
 
 class HIndexablePrimitiveType extends HPrimitiveType {
   const HIndexablePrimitiveType();
   bool isIndexablePrimitive() => true;
   String toString() => "indexable";
 
   Type computeType(Compiler compiler) {
     // TODO(ngeoffray): Represent union types.
     return null;
   }
 
   HType union(HType other) {
     if (other.isIndexablePrimitive() || other.isUnknown()) {
       return HType.INDEXABLE_PRIMITIVE;
     }
     return HType.CONFLICTING;
   }
 
   HType intersection(HType other) {
     if (other.isUnknown()) return HType.INDEXABLE_PRIMITIVE;
     if (other.isIndexablePrimitive()) return other;
     return HType.CONFLICTING;
   }
 }
 
+class HStringOrNullType extends HPrimitiveOrNullType {
+  const HStringOrNullType();
+  bool isStringOrNull() => true;
+  String toString() => "String or null";
+
+  Type computeType(Compiler compiler) {
+    return compiler.stringClass.computeType(compiler);
+  }
+
+  HType union(HType other) {
+    if (other.isUnknown()) return HType.STRING_OR_NULL;
+    if (other.isString()) return HType.STRING_OR_NULL;
+    if (other.isStringOrNull()) return HType.STRING_OR_NULL;
+    return HType.CONFLICTING;

[floitsch, 2012/05/10 10:29:43]

Add comment why indexable + null-string is conflicting.

[ngeoffray, 2012/05/11 10:17:54]

Done.

+  }
+
+  HType intersection(HType other) {
+    if (other.isUnknown()) return HType.STRING_OR_NULL;
+    if (other.isString()) return HType.STRING;
+    if (other.isStringOrNull()) return HType.STRING_OR_NULL;
+    if (other.isArray()) return HType.CONFLICTING;
+    if (other.isIndexablePrimitive()) return HType.STRING;
+    return HType.CONFLICTING;
+  }
+}
+
 class HStringType extends HIndexablePrimitiveType {
   const HStringType();
   bool isString() => true;
   String toString() => "String";
 
   Type computeType(Compiler compiler) {
     return compiler.stringClass.computeType(compiler);
   }
 
   HType union(HType other) {
-    if (other.isString() || other.isUnknown()) return HType.STRING;
+    if (other.isUnknown()) return HType.STRING;
+    if (other.isString()) return HType.STRING;
+    if (other.isStringOrNull()) return HType.STRING_OR_NULL;
     if (other.isIndexablePrimitive()) return HType.INDEXABLE_PRIMITIVE;
     return HType.CONFLICTING;
   }
 
   HType intersection(HType other) {
-    if (other.isString() || other.isUnknown()) return HType.STRING;
+    if (other.isUnknown()) return HType.STRING;
+    if (other.isString()) return HType.STRING;
     if (other.isArray()) return HType.CONFLICTING;
     if (other.isIndexablePrimitive()) return HType.STRING;
+    if (other.isStringOrNull()) return HType.STRING;
     return HType.CONFLICTING;
   }
 }
 
 class HReadableArrayType extends HIndexablePrimitiveType {
   const HReadableArrayType();
   bool isReadableArray() => true;
   String toString() => "readable array";
 
   Type computeType(Compiler compiler) {
@@ skipping 102 matching lines @@
   HType combine(HType other) {
     if (other.isExact()) {
       HExactType concrete = other;
       if (this.type === concrete.type) return this;
     }
     if (other.isUnknown()) return this;
     return HType.CONFLICTING;
   }
 }
 
-class HBoundedPotentialPrimitiveArray extends HBoundedType {
+class HBoundedPotentialPrimitiveType extends HBoundedType {
+  const HBoundedPotentialPrimitiveType(Type type, bool canBeNull)
+      : super(type, canBeNull);
+  bool canBePrimitive() => true;
+}
+
+class HBoundedPotentialPrimitiveArray extends HBoundedPotentialPrimitiveType {
   const HBoundedPotentialPrimitiveArray(Type type, bool canBeNull)
       : super(type, canBeNull);
-  bool canBePrimitive() => true;
 
   HType combine(HType other) {
     if (other.isReadableArray()) return other;
     if (other.isIndexablePrimitive()) return HType.READABLE_ARRAY;

[floitsch, 2012/05/10 10:29:43]

no. If other isString and combine is used for intersection, then we must return
HType.CONFLICTING.
We can't use combine for both union and intersection here.

[ngeoffray, 2012/05/11 10:17:54]

Done.

     return super.combine(other);
   }
 }
 
-class HBoundedPotentialPrimitiveString extends HBoundedType {
+class HBoundedPotentialPrimitiveString extends HBoundedPotentialPrimitiveType {
   const HBoundedPotentialPrimitiveString(Type type, bool canBeNull)
       : super(type, canBeNull);
-  bool canBePrimitive() => true;
 
   HType combine(HType other) {
     if (other.isString()) return other;
     if (other.isIndexablePrimitive()) return HType.STRING;

[floitsch, 2012/05/10 10:29:43]

ditto.

[ngeoffray, 2012/05/11 10:17:54]

Done.

     return super.combine(other);
   }
 }