org.jsweet.transpiler.TypeChecker Maven / Gradle / Ivy
Show all versions of jsweet-transpiler Show documentation
/*
* JSweet transpiler - http://www.jsweet.org
* Copyright (C) 2015 CINCHEO SAS
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
package org.jsweet.transpiler;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.Name;
import javax.lang.model.element.TypeElement;
import javax.lang.model.element.VariableElement;
import javax.lang.model.type.DeclaredType;
import javax.lang.model.type.TypeMirror;
import org.jsweet.JSweetConfig;
import org.jsweet.transpiler.util.AbstractTreePrinter;
import org.jsweet.transpiler.util.Util;
import com.sun.source.tree.ArrayTypeTree;
import com.sun.source.tree.AssignmentTree;
import com.sun.source.tree.CompilationUnitTree;
import com.sun.source.tree.MemberSelectTree;
import com.sun.source.tree.MethodInvocationTree;
import com.sun.source.tree.Tree;
import com.sun.source.tree.VariableTree;
/**
* This helper class performs extra type checking for the JSweet transpiler
* (additionally to Java default type checking).
*
*
* It checks that JSweet authorized APIs are used, and that auxiliary types such
* as unions are valid.
*
* @author Renaud Pawlak
* @author Louis Grignon
*/
public class TypeChecker {
public static boolean jdkAllowed = true;
static final Set AUTHORIZED_ACCESSED_TYPES = new HashSet();
static final Set AUTHORIZED_DECLARED_TYPES = new HashSet();
/**
* Java types that represent numbers (qualified names).
*/
public static final Set NUMBER_TYPES = new HashSet();
/**
* Java types that represent numbers (simple names).
*/
public static final Set NUMBER_TYPE_NAMES = new HashSet();
/**
* Methods that can be invoked on java.lang.Object from JSweet.
*/
public static final Set AUTHORIZED_OBJECT_METHODS = new HashSet();
/**
* Methods that can be invoked on java.lang.String from JSweet.
*/
public static final Set AUTHORIZED_STRING_METHODS = new HashSet();
/**
* Methods that cannot be invoked on java.util.function classes
* from JSweet.
*/
public static final Set FORBIDDEN_JDK_FUNCTIONAL_METHODS = new HashSet();
static {
AUTHORIZED_DECLARED_TYPES.add(String.class.getName());
AUTHORIZED_DECLARED_TYPES.add(Object.class.getName());
AUTHORIZED_DECLARED_TYPES.add(Class.class.getName());
AUTHORIZED_DECLARED_TYPES.add(Boolean.class.getName());
AUTHORIZED_DECLARED_TYPES.add(Void.class.getName());
NUMBER_TYPES.add(Integer.class.getName());
NUMBER_TYPES.add(Double.class.getName());
NUMBER_TYPES.add(Number.class.getName());
NUMBER_TYPES.add(Float.class.getName());
NUMBER_TYPES.add(Byte.class.getName());
NUMBER_TYPES.add(Short.class.getName());
NUMBER_TYPE_NAMES.add(Integer.class.getSimpleName());
NUMBER_TYPE_NAMES.add(Double.class.getSimpleName());
NUMBER_TYPE_NAMES.add(Number.class.getSimpleName());
NUMBER_TYPE_NAMES.add(Float.class.getSimpleName());
NUMBER_TYPE_NAMES.add(Byte.class.getSimpleName());
NUMBER_TYPE_NAMES.add(Short.class.getSimpleName());
AUTHORIZED_DECLARED_TYPES.add(Runnable.class.getName());
AUTHORIZED_OBJECT_METHODS.add("toString");
AUTHORIZED_STRING_METHODS.add("charAt(int)");
AUTHORIZED_STRING_METHODS.add("concat(java.lang.String)");
AUTHORIZED_STRING_METHODS.add("indexOf(java.lang.String)");
AUTHORIZED_STRING_METHODS.add("lastIndexOf(java.lang.String)");
AUTHORIZED_STRING_METHODS.add("lastIndexOf(java.lang.String,int)");
AUTHORIZED_STRING_METHODS.add("substring(int)");
AUTHORIZED_STRING_METHODS.add("substring(int,int)");
AUTHORIZED_STRING_METHODS.add("replace(java.lang.CharSequence,java.lang.CharSequence)");
AUTHORIZED_STRING_METHODS.add("split(java.lang.String)");
AUTHORIZED_STRING_METHODS.add("trim()");
AUTHORIZED_STRING_METHODS.add("toLowerCase()");
AUTHORIZED_STRING_METHODS.add("toUpperCase()");
AUTHORIZED_STRING_METHODS.add("length()");
FORBIDDEN_JDK_FUNCTIONAL_METHODS.add("and");
FORBIDDEN_JDK_FUNCTIONAL_METHODS.add("negate");
FORBIDDEN_JDK_FUNCTIONAL_METHODS.add("or");
FORBIDDEN_JDK_FUNCTIONAL_METHODS.add("andThen");
}
private final AbstractTreePrinter translator;
private final JSweetContext context;
/**
* Creates a new type checker object.
*/
public TypeChecker(AbstractTreePrinter translator) {
this.translator = translator;
this.context = translator.getContext();
}
/**
* Checks that the given invocation conforms to JSweet contraints.
*/
public boolean checkApply(MethodInvocationTree invocation, ExecutableElement methSym) {
if (!JSweetConfig.isJDKReplacementMode() && !jdkAllowed) {
TypeElement parentType = util().getParentElement(methSym, TypeElement.class);
if (parentType != null && parentType.getQualifiedName().toString().startsWith("java.")) {
if (invocation.getMethodSelect() instanceof MemberSelectTree && "super"
.equals(((MemberSelectTree) invocation.getMethodSelect()).getExpression().toString())) {
translator.report(invocation, JSweetProblem.JDK_METHOD, methSym);
return false;
}
if (translator.getContext().strictMode
|| AUTHORIZED_OBJECT_METHODS.contains(methSym.getSimpleName().toString())) {
return true;
}
if (parentType.getQualifiedName().toString().equals(String.class.getName())
&& AUTHORIZED_STRING_METHODS.contains(methSym.toString())) {
return true;
}
translator.report(invocation, JSweetProblem.JDK_METHOD, methSym);
return false;
}
}
return true;
}
/**
* Checks that the given type is JSweet compatible.
*/
public boolean checkType(Tree declaringElement, Name declaringElementName, Tree typeExpression,
CompilationUnitTree compilationUnit) {
if (!JSweetConfig.isJDKReplacementMode()) {
if (typeExpression instanceof ArrayTypeTree) {
return checkType(declaringElement, declaringElementName, ((ArrayTypeTree) typeExpression).getType(),
compilationUnit);
}
TypeMirror type = Util.getType(typeExpression);
if (type != null) {
String typeName = type.toString();
if (!jdkAllowed && !translator.getContext().strictMode && typeName.startsWith("java.")) {
if (!(AUTHORIZED_DECLARED_TYPES.contains(typeName) || NUMBER_TYPES.contains(typeName)
|| typeName.startsWith("java.util.function"))) {
translator.report(declaringElement, declaringElementName, JSweetProblem.JDK_TYPE, typeName);
return false;
}
}
}
}
return true;
}
/**
* Checks that the given field access conforms to JSweet contraints.
*
* @param compilationUnit
*/
public boolean checkSelect(MemberSelectTree select, CompilationUnitTree compilationUnit) {
if (!JSweetConfig.isJDKReplacementMode()) {
TypeMirror selectedType = Util.getType(select.getExpression());
if (selectedType instanceof DeclaredType) {
String type = context.types.asElement(selectedType).toString();
if (type.startsWith("java.")) {
if (!jdkAllowed
&& !(AUTHORIZED_ACCESSED_TYPES.contains(type) || type.startsWith("java.util.function"))) {
translator.report(select, JSweetProblem.JDK_TYPE, type);
return false;
}
}
}
}
return true;
}
private boolean checkUnionTypeAssignment(Tree parent, TypeMirror assigned, MethodInvocationTree union,
CompilationUnitTree compilationUnit) {
TypeElement firstArgTypeElement = Util.getTypeElement(union.getArguments().get(0));
if (firstArgTypeElement != null
&& util().getQualifiedName(firstArgTypeElement).startsWith(JSweetConfig.UNION_CLASS_NAME)) {
VariableElement unionVariableElement = Util.getElement(union.getArguments().get(0));
List typeArguments = ((DeclaredType) unionVariableElement.asType()).getTypeArguments();
// union type -> simple type
if (!util().containsAssignableType(typeArguments, assigned)) {
translator.report(parent, JSweetProblem.UNION_TYPE_MISMATCH);
return false;
}
} else {
// simple type -> union type
String typeName = util().getQualifiedName(firstArgTypeElement);
if (typeName != null && (JSweetConfig.LANG_PACKAGE_ALT + ".Function").equals(typeName)
|| (JSweetConfig.LANG_PACKAGE + ".Function").equals(typeName)) {
// HACK: type checking is ignored here!
// TODO: test better (see Backbone test)
// comparator = union(function((Todo todo) -> {
// return (Integer) todo.get("order");
// }));
return true;
}
if (assigned instanceof DeclaredType
&& !util().containsAssignableType(((DeclaredType) assigned).getTypeArguments(),
Util.getType(union.getArguments().get(0)))) {
translator.report(parent, JSweetProblem.UNION_TYPE_MISMATCH);
return false;
}
}
return true;
}
/**
* Checks that the given union type assignment conforms to JSweet contraints.
*/
public boolean checkUnionTypeAssignment(Tree parent, CompilationUnitTree compilationUnit,
MethodInvocationTree union) {
if (parent instanceof VariableTree) {
VariableTree decl = (VariableTree) parent;
if (decl.getInitializer() == union) {
TypeMirror varType = Util.getType(decl);
return checkUnionTypeAssignment(parent, varType, union, compilationUnit);
}
} else if (parent instanceof AssignmentTree) {
AssignmentTree assign = (AssignmentTree) parent;
if (assign.getExpression() == union) {
TypeMirror varType = Util.getType(assign.getVariable());
return checkUnionTypeAssignment(parent, varType, union, compilationUnit);
}
} else if (parent instanceof MethodInvocationTree) {
MethodInvocationTree invocation = (MethodInvocationTree) parent;
for (Tree arg : invocation.getArguments()) {
if (arg == union) {
TypeMirror varType = Util.getType(arg);
return checkUnionTypeAssignment(parent, varType, union, compilationUnit);
}
}
}
return true;
}
protected Util util() {
return context.util;
}
}