Provide the ordinal value for enums constants in the type model.

PiperOrigin-RevId: 606377591

Author: rluble

transpiler/java/com/google/j2cl/transpiler/ast/AstUtils.java

@@ -1029,6 +1029,7 @@ public static FieldDescriptor getEnumOrdinalConstantFieldDescriptor(
         .setName("$ordinal_" + fieldDescriptor.getName())
         .setEnumConstant(false)
         .setCompileTimeConstant(true)
+        .setConstantValue(fieldDescriptor.getEnumOrdinalValue())
         .setSynthetic(true)
         .setTypeDescriptor(PrimitiveTypes.INT)
         .setOriginalJsInfo(JsInfo.NONE)

transpiler/java/com/google/j2cl/transpiler/ast/Field.java

@@ -16,7 +16,6 @@
 package com.google.j2cl.transpiler.ast;
 
 import static com.google.common.base.Preconditions.checkNotNull;
-import static com.google.common.base.Preconditions.checkState;
 
 import com.google.j2cl.common.SourcePosition;
 import com.google.j2cl.common.visitor.Processor;
@@ -32,20 +31,16 @@ public class Field extends Member {
   @Visitable @Nullable Expression initializer;
   // TODO(b/112150736): generalize concept of the source position for names to members.
   private final SourcePosition nameSourcePosition;
-  // Only valid for enum fields, where it is >= 0.
-  private int enumOrdinal;
-
+ 
   private Field(
       SourcePosition sourcePosition,
       FieldDescriptor fieldDescriptor,
       Expression initializer,
-      int enumOrdinal,
       SourcePosition nameSourcePosition) {
     super(sourcePosition);
     this.fieldDescriptor = checkNotNull(fieldDescriptor);
     this.initializer = initializer;
     this.nameSourcePosition = checkNotNull(nameSourcePosition);
-    this.enumOrdinal = enumOrdinal;
   }
 
   @Override
@@ -99,17 +94,6 @@ public boolean isEnumField() {
     return getDescriptor().isEnumConstant();
   }
 
-  public void setEnumOrdinal(int ordinal) {
-    checkState(isEnumField());
-    this.enumOrdinal = ordinal;
-  }
-
-  public int getEnumOrdinal() {
-    checkState(isEnumField());
-    checkState(enumOrdinal != -1);
-    return enumOrdinal;
-  }
-
   @Override
   Node acceptInternal(Processor processor) {
     return Visitor_Field.visit(processor, this);
@@ -121,15 +105,13 @@ public static class Builder {
     private Expression initializer;
     private SourcePosition sourcePosition;
     private SourcePosition nameSourcePosition = SourcePosition.NONE;
-    private int enumOrdinal = -1;
 
     public static Builder from(Field field) {
       Builder builder = new Builder();
       builder.fieldDescriptor = field.getDescriptor();
       builder.initializer = field.getInitializer();
       builder.sourcePosition = field.getSourcePosition();
       builder.nameSourcePosition = field.getNameSourcePosition();
-      builder.enumOrdinal = field.enumOrdinal;
       return builder;
     }
 
@@ -170,7 +152,6 @@ public Field build() {
           sourcePosition,
           fieldDescriptor,
           initializer,
-          enumOrdinal,
           nameSourcePosition);
     }
   }

transpiler/java/com/google/j2cl/transpiler/ast/FieldDescriptor.java

@@ -15,10 +15,12 @@
  */
 package com.google.j2cl.transpiler.ast;
 
+import static com.google.common.base.Preconditions.checkNotNull;
 import static com.google.common.base.Preconditions.checkState;
 
 import com.google.auto.value.AutoValue;
 import com.google.auto.value.extension.memoized.Memoized;
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import com.google.j2cl.common.ThreadLocalInterner;
 import java.util.Map;
 import java.util.Optional;
@@ -134,6 +136,7 @@ public boolean isCapture() {
         || getOrigin() == FieldOrigin.SYNTHETIC_OUTER_FIELD;
   }
 
+  @Override
   public boolean isJsProperty() {
     return getJsInfo().getJsMemberType() == JsMemberType.PROPERTY;
   }
@@ -175,6 +178,20 @@ public String getMangledName() {
     return computePropertyMangledName();
   }
 
+  @Memoized
+  public Literal getEnumOrdinalValue() {
+    checkState(isEnumConstant());
+    if (!isDeclaration()) {
+      return getDeclarationDescriptor().getEnumOrdinalValue();
+    }
+
+    return checkNotNull(
+        getEnclosingTypeDescriptor()
+            .getTypeDeclaration()
+            .getOrdinalValueByEnumFieldName()
+            .get(getName()));
+  }
+
   @Override
   public FieldDescriptor specializeTypeVariables(
       Map<TypeVariable, TypeDescriptor> applySpecializedTypeArgumentByTypeParameters) {
@@ -264,6 +281,7 @@ public abstract Builder setEnclosingTypeDescriptor(
 
     public abstract Builder setOrigin(FieldOrigin fieldOrigin);
 
+    @CanIgnoreReturnValue
     public Builder setDeclarationDescriptor(FieldDescriptor declarationFieldDescriptor) {
       return setDeclarationDescriptorOrNullIfSelf(declarationFieldDescriptor);
     }

transpiler/java/com/google/j2cl/transpiler/ast/TypeDeclaration.java

@@ -24,6 +24,7 @@
 import com.google.common.base.Joiner;
 import com.google.common.base.Splitter;
 import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.Iterables;
 import com.google.common.collect.Streams;
 import com.google.j2cl.common.ThreadLocalInterner;
@@ -758,6 +759,19 @@ public ImmutableList<FieldDescriptor> getDeclaredFieldDescriptors() {
     return getDeclaredFieldDescriptorsFactory().get(this);
   }
 
+  @Memoized
+  ImmutableMap<String, Literal> getOrdinalValueByEnumFieldName() {
+    ImmutableMap.Builder<String, Literal> immutableMapBuilder = ImmutableMap.builder();
+    int ordinal = 0;
+    for (FieldDescriptor fieldDescriptor : getDeclaredFieldDescriptors()) {
+      if (!fieldDescriptor.isEnumConstant()) {
+        continue;
+      }
+      immutableMapBuilder.put(fieldDescriptor.getName(), NumberLiteral.fromInt(ordinal++));
+    }
+    return immutableMapBuilder.buildOrThrow();
+  }
+
   /**
    * The list of fields declared in the type. Note: this does not include methods synthetic fields
    * (like captures) nor supertype fields.

transpiler/java/com/google/j2cl/transpiler/frontend/jdt/JdtEnvironment.java

@@ -56,6 +56,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.Comparator;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -1029,18 +1030,6 @@ private DeclaredTypeDescriptor createDeclaredType(
     }
     checkArgument(typeBinding.isClass() || typeBinding.isInterface() || typeBinding.isEnum());
 
-    Supplier<ImmutableList<MethodDescriptor>> declaredMethods =
-        () ->
-            Arrays.stream(typeBinding.getDeclaredMethods())
-                .map(this::createMethodDescriptor)
-                .collect(toImmutableList());
-
-    Supplier<ImmutableList<FieldDescriptor>> declaredFields =
-        () ->
-            Arrays.stream(typeBinding.getDeclaredFields())
-                .map(this::createFieldDescriptor)
-                .collect(toImmutableList());
-
     TypeDeclaration typeDeclaration = createDeclarationForType(typeBinding.getTypeDeclaration());
 
     DeclaredTypeDescriptor enclosingTypeDescriptor =
@@ -1065,8 +1054,10 @@ private DeclaredTypeDescriptor createDeclaredType(
                         DeclaredTypeDescriptor.class))
             .setTypeArgumentDescriptors(
                 getTypeArgumentTypeDescriptors(typeBinding, inNullMarkedScope))
-            .setDeclaredFieldDescriptorsFactory(declaredFields)
-            .setDeclaredMethodDescriptorsFactory(declaredMethods)
+            .setDeclaredFieldDescriptorsFactory(
+                () -> createFieldDescriptorsOrderedById(typeBinding.getDeclaredFields()))
+            .setDeclaredMethodDescriptorsFactory(
+                () -> createMethodDescriptors(typeBinding.getDeclaredMethods()))
             .setSingleAbstractMethodDescriptorFactory(() -> getFunctionInterfaceMethod(typeBinding))
             .build();
     putTypeDescriptorInCache(inNullMarkedScope, typeBinding, typeDescriptor);
@@ -1175,19 +1166,6 @@ public TypeDeclaration createDeclarationForType(final ITypeBinding typeBinding)
     boolean isAbstract = isAbstract(typeBinding);
     boolean isFinal = isFinal(typeBinding);
 
-    Supplier<ImmutableList<MethodDescriptor>> declaredMethods =
-        () ->
-            Arrays.stream(typeBinding.getDeclaredMethods())
-                .map(this::createMethodDescriptor)
-                .collect(toImmutableList());
-    ;
-
-    Supplier<ImmutableList<FieldDescriptor>> declaredFields =
-        () ->
-            Arrays.stream(typeBinding.getDeclaredFields())
-                .map(this::createFieldDescriptor)
-                .collect(toImmutableList());
-
     boolean isNullMarked = isNullMarked(typeBinding);
     IBinding declaringMemberBinding = getDeclaringMethodOrFieldBinding(typeBinding);
 
@@ -1242,17 +1220,12 @@ public TypeDeclaration createDeclarationForType(final ITypeBinding typeBinding)
                     .map(TypeVariable::toNonNullable)
                     .collect(toImmutableList()))
             .setVisibility(getVisibility(typeBinding))
-            .setDeclaredMethodDescriptorsFactory(declaredMethods)
-            .setDeclaredFieldDescriptorsFactory(declaredFields)
+            .setDeclaredMethodDescriptorsFactory(
+                () -> createMethodDescriptors(typeBinding.getDeclaredMethods()))
+            .setDeclaredFieldDescriptorsFactory(
+                () -> createFieldDescriptorsOrderedById(typeBinding.getDeclaredFields()))
             .setMemberTypeDeclarationsFactory(
-                () -> {
-                  if (typeBinding.getDeclaredTypes() == null) {
-                    return ImmutableList.of();
-                  }
-                  return Arrays.stream(typeBinding.getDeclaredTypes())
-                      .map(this::createDeclarationForType)
-                      .collect(ImmutableList.toImmutableList());
-                })
+                () -> createTypeDeclarations(typeBinding.getDeclaredTypes()))
             .setUnusableByJsSuppressed(
                 JsInteropAnnotationUtils.isUnusableByJsSuppressed(typeBinding))
             .setDeprecated(isDeprecated(typeBinding))
@@ -1261,6 +1234,29 @@ public TypeDeclaration createDeclarationForType(final ITypeBinding typeBinding)
     return typeDeclaration;
   }
 
+  private ImmutableList<MethodDescriptor> createMethodDescriptors(IMethodBinding[] methodBindings) {
+    return Arrays.stream(methodBindings)
+        .map(this::createMethodDescriptor)
+        .collect(toImmutableList());
+  }
+
+  private ImmutableList<FieldDescriptor> createFieldDescriptorsOrderedById(
+      IVariableBinding[] fieldBindings) {
+    return Arrays.stream(fieldBindings)
+        .sorted(Comparator.comparing(IVariableBinding::getVariableId))
+        .map(this::createFieldDescriptor)
+        .collect(toImmutableList());
+  }
+
+  private ImmutableList<TypeDeclaration> createTypeDeclarations(ITypeBinding[] typeBindings) {
+    if (typeBindings == null) {
+      return ImmutableList.of();
+    }
+    return Arrays.stream(typeBindings)
+        .map(this::createDeclarationForType)
+        .collect(ImmutableList.toImmutableList());
+  }
+
   private boolean isNullMarked(ITypeBinding typeBinding) {
     return hasNullMarkedAnnotation(typeBinding)
         || packageAnnotationsResolver.isNullMarked(typeBinding.getPackage().getName());

transpiler/java/com/google/j2cl/transpiler/passes/NormalizeEnumClasses.java

@@ -29,7 +29,6 @@
 import com.google.j2cl.transpiler.ast.MethodCall;
 import com.google.j2cl.transpiler.ast.NewInstance;
 import com.google.j2cl.transpiler.ast.Node;
-import com.google.j2cl.transpiler.ast.NumberLiteral;
 import com.google.j2cl.transpiler.ast.PrimitiveTypes;
 import com.google.j2cl.transpiler.ast.RuntimeMethods;
 import com.google.j2cl.transpiler.ast.StringLiteral;
@@ -150,23 +149,20 @@ private static void initJavaLangEnumField(
 
   /** Creates constant static fields to hold the enum ordinal constants. */
   private static void createEnumOrdinalConstants(Type type) {
-    int currentOrdinal = 0;
-    for (Field enumField : type.getEnumFields()) {
-      enumField.setEnumOrdinal(currentOrdinal);
+    // Traverse in reverse order so that the ordinal constant fields are inserted in ascending
+    // ordinal order.
+    for (Field enumField : type.getEnumFields().reverse()) {
 
-      FieldDescriptor ordinalConstantFieldDescriptor =
-          AstUtils.getEnumOrdinalConstantFieldDescriptor(enumField.getDescriptor());
+      FieldDescriptor enumFieldDescriptor = enumField.getDescriptor();
       // Create a constant field to hold the ordinal for the current enum value.
       type.addMember(
-          // These field need to be defined at the beginning because they can be referenced by enum
+          // These fields need to be defined at the beginning because they can be referenced by enum
           // constant initializers that are already part of the load time statements.
-          currentOrdinal,
-          Field.Builder.from(ordinalConstantFieldDescriptor)
+          0,
+          Field.Builder.from(AstUtils.getEnumOrdinalConstantFieldDescriptor(enumFieldDescriptor))
               .setSourcePosition(enumField.getSourcePosition())
-              .setInitializer(NumberLiteral.fromInt(enumField.getEnumOrdinal()))
+              .setInitializer(enumFieldDescriptor.getEnumOrdinalValue())
               .build());
-
-      currentOrdinal++;
     }
   }
 

transpiler/java/com/google/j2cl/transpiler/passes/NormalizeJsEnums.java

@@ -25,13 +25,13 @@
 import com.google.j2cl.transpiler.ast.Expression;
 import com.google.j2cl.transpiler.ast.Field;
 import com.google.j2cl.transpiler.ast.FieldAccess;
+import com.google.j2cl.transpiler.ast.FieldDescriptor;
 import com.google.j2cl.transpiler.ast.FieldDescriptor.FieldOrigin;
 import com.google.j2cl.transpiler.ast.Method;
 import com.google.j2cl.transpiler.ast.MethodCall;
 import com.google.j2cl.transpiler.ast.MethodDescriptor;
 import com.google.j2cl.transpiler.ast.NewInstance;
 import com.google.j2cl.transpiler.ast.Node;
-import com.google.j2cl.transpiler.ast.NumberLiteral;
 import com.google.j2cl.transpiler.ast.RuntimeMethods;
 import com.google.j2cl.transpiler.ast.Type;
 import com.google.j2cl.transpiler.ast.TypeDescriptor;
@@ -115,14 +115,15 @@ private static Expression getJsEnumConstantValue(Field field) {
     checkState(field.isEnumField());
 
     List<Expression> arguments = ((NewInstance) field.getInitializer()).getArguments();
-    if (field.getDescriptor().getEnclosingTypeDescriptor().getJsEnumInfo().hasCustomValue()) {
+    FieldDescriptor fieldDescriptor = field.getDescriptor();
+    if (fieldDescriptor.getEnclosingTypeDescriptor().getJsEnumInfo().hasCustomValue()) {
       checkState(arguments.size() == 3);
       Expression constantValue = arguments.get(2);
       checkState(constantValue.isCompileTimeConstant());
       return constantValue;
     } else {
       checkState(arguments.size() == 2);
-      return NumberLiteral.fromInt(field.getEnumOrdinal());
+      return fieldDescriptor.getEnumOrdinalValue();
     }
   }
 

transpiler/java/com/google/j2cl/transpiler/passes/NormalizeSwitchStatements.java

@@ -87,11 +87,12 @@ private static SwitchCase convertToOrdinalCase(SwitchCase switchCase) {
       return switchCase;
     }
 
-    FieldAccess enumField = (FieldAccess) switchCase.getCaseExpression();
+    FieldAccess enumFieldAccess = (FieldAccess) switchCase.getCaseExpression();
     return SwitchCase.Builder.from(switchCase)
         .setCaseExpression(
-            FieldAccess.Builder.from(enumField)
-                .setTarget(AstUtils.getEnumOrdinalConstantFieldDescriptor(enumField.getTarget()))
+            FieldAccess.Builder.from(enumFieldAccess)
+                .setTarget(
+                    AstUtils.getEnumOrdinalConstantFieldDescriptor(enumFieldAccess.getTarget()))
                 .build())
         .build();
   }

transpiler/java/com/google/j2cl/transpiler/passes/PropagateConstants.java

@@ -32,7 +32,17 @@
 import java.util.Map;
 import javax.annotation.Nullable;
 
-/** Propagates compile time constant fields. */
+/**
+ * Propagates constant fields.
+ *
+ * <p>This pass propagates fields that are either compile time constants or that are final static
+ * fields initialized to a string or class literal.
+ *
+ * <p>Some static final fields end up being initialized to string literal as a result of previous
+ * passes. E.g. System.getProperty calls get rewritten into literals and might become the
+ * initializers of a static final fields. In fact this is the approach that has the checks in
+ * InternalPreconditions removed in optimized builds at generation time.
+ */
 public class PropagateConstants extends LibraryNormalizationPass {
 
   @Override

transpiler/java/com/google/j2cl/transpiler/passes/VerifyNormalizedUnits.java

@@ -106,8 +106,6 @@ public void exitField(Field field) {
               // JsEnum only contains the enum fields.
               checkState(!getCurrentType().isJsEnum() || field.isStatic());
             }
-            // Non-native enum fields have a non negative ordinal.
-            checkState(field.isNative() || !field.isEnumField() || field.getEnumOrdinal() >= 0);
           }
 
           public void checkMember(Member member) {

transpiler/javatests/com/google/j2cl/readable/java/autovalue/output_closure/SimpleAutoValue.impl.java.js.txt

@@ -104,7 +104,7 @@ class SimpleAutoValue extends ValueType {
   $$int = goog.module.get('vmbootstrap.primitives.$int$impl');
  }
 }
-SimpleAutoValue.prototype.$excluded_fields = [reflect.objectProperty('f_field1__autovalue_SimpleAutoValue_', SimpleAutoValue), reflect.objectProperty('f_field2__autovalue_SimpleAutoValue_', SimpleAutoValue), reflect.objectProperty('f_intField__autovalue_SimpleAutoValue_', SimpleAutoValue)];
+SimpleAutoValue.prototype.$excluded_fields = [reflect.objectProperty('f_intField__autovalue_SimpleAutoValue_', SimpleAutoValue), reflect.objectProperty('f_field1__autovalue_SimpleAutoValue_', SimpleAutoValue), reflect.objectProperty('f_field2__autovalue_SimpleAutoValue_', SimpleAutoValue)];
 $Util.$setClassMetadata(SimpleAutoValue, 'autovalue.SimpleAutoValue');
 
 exports = SimpleAutoValue;