Merge pull request #260 from NumberFour/GH-315

GH-315: As a developer, I want to use @StringBased enum literals as keys for Object-literals

Author: qtran

plugins/eu.numberfour.n4js.ts.model/emf-gen/eu/numberfour/n4js/ts/types/TEnumLiteral.java

@@ -55,4 +55,13 @@ public interface TEnumLiteral extends SyntaxRelatedTElement, IdentifiableElement
 	 */
 	void setValue(String value);
 
+	/**
+	 * <!-- begin-user-doc -->
+	 * <!-- end-user-doc -->
+	 * @model kind="operation" unique="false"
+	 *        annotation="http://www.eclipse.org/emf/2002/GenModel body='<%java.lang.String%> _elvis = null;\n<%java.lang.String%> _value = this.getValue();\nif (_value != null)\n{\n\t_elvis = _value;\n} else\n{\n\t<%java.lang.String%> _name = this.getName();\n\t_elvis = _name;\n}\nreturn _elvis;'"
+	 * @generated
+	 */
+	String getValueOrName();
+
 } // TEnumLiteral

plugins/eu.numberfour.n4js.ts.model/emf-gen/eu/numberfour/n4js/ts/types/TypesPackage.java

@@ -10825,14 +10825,23 @@ public interface TypesPackage extends EPackage {
 	 */
 	int TENUM_LITERAL___GET_CONTAINING_MODULE = SYNTAX_RELATED_TELEMENT_OPERATION_COUNT + 0;
 
+	/**
+	 * The operation id for the '<em>Get Value Or Name</em>' operation.
+	 * <!-- begin-user-doc -->
+	 * <!-- end-user-doc -->
+	 * @generated
+	 * @ordered
+	 */
+	int TENUM_LITERAL___GET_VALUE_OR_NAME = SYNTAX_RELATED_TELEMENT_OPERATION_COUNT + 1;
+
 	/**
 	 * The number of operations of the '<em>TEnum Literal</em>' class.
 	 * <!-- begin-user-doc -->
 	 * <!-- end-user-doc -->
 	 * @generated
 	 * @ordered
 	 */
-	int TENUM_LITERAL_OPERATION_COUNT = SYNTAX_RELATED_TELEMENT_OPERATION_COUNT + 1;
+	int TENUM_LITERAL_OPERATION_COUNT = SYNTAX_RELATED_TELEMENT_OPERATION_COUNT + 2;
 
 	/**
 	 * The meta object id for the '{@link eu.numberfour.n4js.ts.types.impl.TVariableImpl <em>TVariable</em>}' class.
@@ -13540,6 +13549,16 @@ public interface TypesPackage extends EPackage {
 	 */
 	EAttribute getTEnumLiteral_Value();
 
+	/**
+	 * Returns the meta object for the '{@link eu.numberfour.n4js.ts.types.TEnumLiteral#getValueOrName() <em>Get Value Or Name</em>}' operation.
+	 * <!-- begin-user-doc -->
+	 * <!-- end-user-doc -->
+	 * @return the meta object for the '<em>Get Value Or Name</em>' operation.
+	 * @see eu.numberfour.n4js.ts.types.TEnumLiteral#getValueOrName()
+	 * @generated
+	 */
+	EOperation getTEnumLiteral__GetValueOrName();
+
 	/**
 	 * Returns the meta object for class '{@link eu.numberfour.n4js.ts.types.SyntaxRelatedTElement <em>Syntax Related TElement</em>}'.
 	 * <!-- begin-user-doc -->
@@ -15736,6 +15755,14 @@ interface Literals {
 		 */
 		EAttribute TENUM_LITERAL__VALUE = eINSTANCE.getTEnumLiteral_Value();
 
+		/**
+		 * The meta object literal for the '<em><b>Get Value Or Name</b></em>' operation.
+		 * <!-- begin-user-doc -->
+		 * <!-- end-user-doc -->
+		 * @generated
+		 */
+		EOperation TENUM_LITERAL___GET_VALUE_OR_NAME = eINSTANCE.getTEnumLiteral__GetValueOrName();
+
 		/**
 		 * The meta object literal for the '{@link eu.numberfour.n4js.ts.types.impl.SyntaxRelatedTElementImpl <em>Syntax Related TElement</em>}' class.
 		 * <!-- begin-user-doc -->

plugins/eu.numberfour.n4js.ts.model/emf-gen/eu/numberfour/n4js/ts/types/impl/TEnumLiteralImpl.java

@@ -141,6 +141,23 @@ public void setValue(String newValue) {
 			eNotify(new ENotificationImpl(this, Notification.SET, TypesPackage.TENUM_LITERAL__VALUE, oldValue, value));
 	}
 
+	/**
+	 * <!-- begin-user-doc -->
+	 * <!-- end-user-doc -->
+	 * @generated
+	 */
+	public String getValueOrName() {
+		String _elvis = null;
+		String _value = this.getValue();
+		if (_value != null) {
+			_elvis = _value;
+		} else {
+			String _name = this.getName();
+			_elvis = _name;
+		}
+		return _elvis;
+	}
+
 	/**
 	 * <!-- begin-user-doc -->
 	 * <!-- end-user-doc -->
@@ -289,6 +306,8 @@ public int eDerivedOperationID(int baseOperationID, Class<?> baseClass) {
 	@Override
 	public Object eInvoke(int operationID, EList<?> arguments) throws InvocationTargetException {
 		switch (operationID) {
+			case TypesPackage.TENUM_LITERAL___GET_VALUE_OR_NAME:
+				return getValueOrName();
 			case TypesPackage.TENUM_LITERAL___GET_CONTAINING_MODULE:
 				return getContainingModule();
 		}

plugins/eu.numberfour.n4js.ts.model/emf-gen/eu/numberfour/n4js/ts/types/impl/TypesPackageImpl.java

@@ -2714,6 +2714,15 @@ public EAttribute getTEnumLiteral_Value() {
 		return (EAttribute)tEnumLiteralEClass.getEStructuralFeatures().get(0);
 	}
 
+	/**
+	 * <!-- begin-user-doc -->
+	 * <!-- end-user-doc -->
+	 * @generated
+	 */
+	public EOperation getTEnumLiteral__GetValueOrName() {
+		return tEnumLiteralEClass.getEOperations().get(0);
+	}
+
 	/**
 	 * <!-- begin-user-doc -->
 	 * <!-- end-user-doc -->
@@ -3187,6 +3196,7 @@ public void createPackageContents() {
 
 		tEnumLiteralEClass = createEClass(TENUM_LITERAL);
 		createEAttribute(tEnumLiteralEClass, TENUM_LITERAL__VALUE);
+		createEOperation(tEnumLiteralEClass, TENUM_LITERAL___GET_VALUE_OR_NAME);
 
 		syntaxRelatedTElementEClass = createEClass(SYNTAX_RELATED_TELEMENT);
 		createEReference(syntaxRelatedTElementEClass, SYNTAX_RELATED_TELEMENT__AST_ELEMENT);
@@ -3753,6 +3763,8 @@ public void initializePackageContents() {
 		initEClass(tEnumLiteralEClass, TEnumLiteral.class, "TEnumLiteral", !IS_ABSTRACT, !IS_INTERFACE, IS_GENERATED_INSTANCE_CLASS);
 		initEAttribute(getTEnumLiteral_Value(), theEcorePackage.getEString(), "value", null, 0, 1, TEnumLiteral.class, !IS_TRANSIENT, !IS_VOLATILE, IS_CHANGEABLE, !IS_UNSETTABLE, !IS_ID, !IS_UNIQUE, !IS_DERIVED, IS_ORDERED);
 
+		initEOperation(getTEnumLiteral__GetValueOrName(), theEcorePackage.getEString(), "getValueOrName", 0, 1, !IS_UNIQUE, IS_ORDERED);
+
 		initEClass(syntaxRelatedTElementEClass, SyntaxRelatedTElement.class, "SyntaxRelatedTElement", IS_ABSTRACT, !IS_INTERFACE, IS_GENERATED_INSTANCE_CLASS);
 		initEReference(getSyntaxRelatedTElement_AstElement(), theEcorePackage.getEObject(), null, "astElement", null, 0, 1, SyntaxRelatedTElement.class, !IS_TRANSIENT, !IS_VOLATILE, IS_CHANGEABLE, !IS_COMPOSITE, IS_RESOLVE_PROXIES, !IS_UNSETTABLE, IS_UNIQUE, !IS_DERIVED, IS_ORDERED);
 

plugins/eu.numberfour.n4js.ts.model/model/Types.xcore

@@ -1474,6 +1474,10 @@ class TEnum extends DeclaredTypeWithAccessModifier, SyntaxRelatedTElement {
  */
 class TEnumLiteral extends SyntaxRelatedTElement, IdentifiableElement {
 	String value
+	
+	op String getValueOrName() {
+		return value ?: name;
+	}
 }
 
 /*

plugins/eu.numberfour.n4js/src/eu/numberfour/n4js/resource/N4JSPreProcessor.xtend

@@ -65,6 +65,11 @@ package final class N4JSPreProcessor {
 			if (target instanceof IdentifierRef) {
 				if (target.idAsText == 'Symbol') {
 					return ComputedPropertyNameValueConverter.SYMBOL_IDENTIFIER_PREFIX + expr.propertyAsText;
+				} else {
+					// this case implements support for literals of @StringBased enums
+					// (but here we cannot ensure that 'target' is actually a @StringBased enum, because that would require
+					// resolution of proxies which we are not allowed to do)
+					return expr.propertyAsText;
 				}
 			}
 		}

plugins/eu.numberfour.n4js/src/eu/numberfour/n4js/typesystem/n4js.xsemantics

@@ -615,13 +615,13 @@ from {
 		G |- expr.target : var TypeRef targetTypeRef
 		targetTypeRef = typeSystemHelper.resolveType(G, targetTypeRef);
 
-		val accessedBuiltInSymbol = G.getAccessedBuiltInSymbol(expr.index);
+		val memberName = N4JSLanguageUtils.getMemberNameForIndexExpression(G, expr.index);
 		val elementType = targetTypeRef.declaredType?.elementType
 
-		if (accessedBuiltInSymbol!==null) {
+		if (memberName!==null && memberName.startsWith(N4JSLanguageUtils.SYMBOL_IDENTIFIER_PREFIX)) {
+			// the index (inside the []) is a symbol
 			val declType = targetTypeRef.declaredType;
 			if(declType instanceof ContainerType<?>) {
-				val memberName = '#' + accessedBuiltInSymbol.name;
 				val member = containerTypesHelper.fromContext(expr).findMember(declType,memberName,false,false); // TODO support for static access?
 				if(member!==null) {
 					G |- member : var TypeRef memberTypeRef
@@ -638,22 +638,11 @@ from {
 			else {
 				T = G.anyTypeRef
 			}
-		} else if (elementType !== null) {
-			val declaredType = targetTypeRef.declaredType
-			if (declaredType.generic && targetTypeRef.typeArgs.isEmpty) {
-				T = G.anyTypeRef // later: evaluate name if possible, we may even want to return smth like intersect(allProperties)
-			} else {
-				val G2 = G.wrap
-				typeSystemHelper.addSubstitutions(G2, targetTypeRef)
-				G2.addThisType(targetTypeRef)
-				G2 |- elementType ~> T
-			}
-		} else if (expr.index instanceof StringLiteral) {
+		} else if (memberName!==null) {
 			// indexing via constant computed-name, sub-cases: static or instance member, for the latter nominally-typed or structurally-typed receiver
 			val staticAccess = (targetTypeRef instanceof TypeTypeRef)
 			val checkVisibility = false // access modifiers checked in validation
 			val scope = memberScopingHelper.createMemberScopeFor(targetTypeRef, expr, checkVisibility, staticAccess)
-			val memberName = (expr.index as StringLiteral).value;
 			val member = memberScopingHelper.findUniqueMemberForName(scope, memberName, staticAccess)
 			if(member != null) {
 				G |- member : var TypeRef memberTypeRef
@@ -664,6 +653,16 @@ from {
 			} else {
 				T = TypeRefsFactory.eINSTANCE.createUnknownTypeRef
 			}
+		} else if (elementType !== null) {
+			val declaredType = targetTypeRef.declaredType
+			if (declaredType.generic && targetTypeRef.typeArgs.isEmpty) {
+				T = G.anyTypeRef // later: evaluate name if possible, we may even want to return smth like intersect(allProperties)
+			} else {
+				val G2 = G.wrap
+				typeSystemHelper.addSubstitutions(G2, targetTypeRef)
+				G2.addThisType(targetTypeRef)
+				G2 |- elementType ~> T
+			}
 		} else if (targetTypeRef.dynamic) {
 			T = G.anyTypeRefDynamic
 		} else {

plugins/eu.numberfour.n4js/src/eu/numberfour/n4js/utils/N4JSLanguageUtils.xtend

@@ -16,9 +16,11 @@ import eu.numberfour.n4js.conversion.IdentifierValueConverter
 import eu.numberfour.n4js.n4JS.AbstractAnnotationList
 import eu.numberfour.n4js.n4JS.AnnotableElement
 import eu.numberfour.n4js.n4JS.ExportedVariableDeclaration
+import eu.numberfour.n4js.n4JS.Expression
 import eu.numberfour.n4js.n4JS.FormalParameter
 import eu.numberfour.n4js.n4JS.FunctionDeclaration
 import eu.numberfour.n4js.n4JS.FunctionDefinition
+import eu.numberfour.n4js.n4JS.IndexedAccessExpression
 import eu.numberfour.n4js.n4JS.N4ClassDeclaration
 import eu.numberfour.n4js.n4JS.N4ClassifierDeclaration
 import eu.numberfour.n4js.n4JS.N4EnumLiteral
@@ -29,10 +31,12 @@ import eu.numberfour.n4js.n4JS.N4MemberAnnotationList
 import eu.numberfour.n4js.n4JS.N4MemberDeclaration
 import eu.numberfour.n4js.n4JS.N4MethodDeclaration
 import eu.numberfour.n4js.n4JS.NumericLiteral
+import eu.numberfour.n4js.n4JS.ParameterizedPropertyAccessExpression
 import eu.numberfour.n4js.n4JS.PropertyAssignment
 import eu.numberfour.n4js.n4JS.PropertyAssignmentAnnotationList
 import eu.numberfour.n4js.n4JS.PropertyMethodDeclaration
 import eu.numberfour.n4js.n4JS.Script
+import eu.numberfour.n4js.n4JS.StringLiteral
 import eu.numberfour.n4js.n4JS.TypeDefiningElement
 import eu.numberfour.n4js.n4JS.UnaryExpression
 import eu.numberfour.n4js.n4JS.UnaryOperator
@@ -52,6 +56,7 @@ import eu.numberfour.n4js.ts.types.MemberAccessModifier
 import eu.numberfour.n4js.ts.types.TAnnotableElement
 import eu.numberfour.n4js.ts.types.TClass
 import eu.numberfour.n4js.ts.types.TClassifier
+import eu.numberfour.n4js.ts.types.TEnumLiteral
 import eu.numberfour.n4js.ts.types.TField
 import eu.numberfour.n4js.ts.types.TFunction
 import eu.numberfour.n4js.ts.types.TMember
@@ -599,4 +604,40 @@ class N4JSLanguageUtils {
 	def static TypeRef getTypeVariableImplicitUpperBound(RuleEnvironment G) {
 		return G.anyTypeRef;
 	}
+
+	/**
+	 * Tells if the given expression is valid as an index within an {@link IndexedAccessExpression}.
+	 */
+	def static boolean isValidIndexExpression(RuleEnvironment G, Expression indexExpr) {
+		if(indexExpr instanceof NumericLiteral || indexExpr instanceof StringLiteral) {
+			return true;
+		} else if(G.getAccessedBuiltInSymbol(indexExpr)!==null) {
+			return true;
+		} else if(indexExpr instanceof ParameterizedPropertyAccessExpression) {
+			return indexExpr.property instanceof TEnumLiteral;
+		}
+		return false;
+	}
+	/**
+	 * If the given expression is a {@link #isValidIndexExpression(RuleEnvironment, Expression) valid index expression}
+	 * but is *not* numerical, then this method will return the name of the member the index access expression is
+	 * referring to. Returns <code>null</code> if the expression is invalid or numerical.
+	 */
+	def static String getMemberNameForIndexExpression(RuleEnvironment G, Expression indexExpr) {
+		val accessedBuiltInSymbol = G.getAccessedBuiltInSymbol(indexExpr);
+		if(accessedBuiltInSymbol!==null) {
+			return SYMBOL_IDENTIFIER_PREFIX + accessedBuiltInSymbol.name;
+		} else {
+			return switch(indexExpr) {
+				StringLiteral:
+					indexExpr.value
+				ParameterizedPropertyAccessExpression: {
+					val prop = indexExpr.property;
+					if(prop instanceof TEnumLiteral) {
+						prop.valueOrName
+					}
+				}
+			};
+		}
+	}
 }