/*******************************************************************************
* Copyright (c) 2009 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
* Zend Technologies
*******************************************************************************/
package org.eclipse.php.astview.views;
import java.util.ArrayList;
import org.eclipse.php.core.ast.nodes.IBinding;
import org.eclipse.php.core.ast.nodes.IMethodBinding;
import org.eclipse.php.core.ast.nodes.ITypeBinding;
import org.eclipse.php.core.ast.nodes.IVariableBinding;
import org.eclipse.swt.graphics.Image;
/**
*
*/
public class Binding extends ASTAttribute {
private final IBinding fBinding;
private final String fLabel;
private final Object fParent;
private final boolean fIsRelevant;
public Binding(Object parent, String label, IBinding binding, boolean isRelevant) {
fParent= parent;
fBinding= binding;
fLabel= label;
fIsRelevant= isRelevant;
}
public Object getParent() {
return fParent;
}
public IBinding getBinding() {
return fBinding;
}
public boolean hasBindingProperties() {
return fBinding != null;
}
public boolean isRelevant() {
return fIsRelevant;
}
private static boolean isType(int typeKinds, int kind) {
return (typeKinds & kind) != 0;
}
public Object[] getChildren() {
if (fBinding != null) {
ArrayList res= new ArrayList();
res.add(new BindingProperty(this, "NAME", fBinding.getName(), true)); //$NON-NLS-1$
res.add(new BindingProperty(this, "KEY", fBinding.getKey(), true)); //$NON-NLS-1$
//FIXME: res.add(new BindingProperty(this, "IS RECOVERED", fBinding.isRecovered(), true)); //$NON-NLS-1$
switch (fBinding.getKind()) {
case IBinding.VARIABLE:
IVariableBinding variableBinding= (IVariableBinding) fBinding;
res.add(new BindingProperty(this, "IS FIELD", variableBinding.isField(), true)); //$NON-NLS-1$
//FIXME: res.add(new BindingProperty(this, "IS ENUM CONSTANT", variableBinding.isEnumConstant(), true)); //$NON-NLS-1$
res.add(new BindingProperty(this, "IS PARAMETER", variableBinding.isParameter(), true)); //$NON-NLS-1$
res.add(new BindingProperty(this, "VARIABLE ID", variableBinding.getVariableId(), true)); //$NON-NLS-1$
//FIXME: res.add(new BindingProperty(this, "MODIFIERS", Flags.toString(fBinding.getModifiers()), true)); //$NON-NLS-1$
res.add(new Binding(this, "TYPE", variableBinding.getType(), true)); //$NON-NLS-1$
res.add(new Binding(this, "DECLARING CLASS", variableBinding.getDeclaringClass(), true)); //$NON-NLS-1$
//FIXME: res.add(new Binding(this, "DECLARING METHOD", variableBinding.getDeclaringMethod(), true)); //$NON-NLS-1$
//FIXME: res.add(new Binding(this, "VARIABLE DECLARATION", variableBinding.getVariableDeclaration(), true)); //$NON-NLS-1$
//FIXME :res.add(new BindingProperty(this, "IS SYNTHETIC", fBinding.isSynthetic(), true)); //$NON-NLS-1$
Object constVal= variableBinding.getConstantValue();
res.add(new BindingProperty(this, "CONSTANT VALUE", constVal == null ? "null" : constVal.toString(), true)); //$NON-NLS-1$ //$NON-NLS-2$
break;
//FIXME:
case IBinding.PACKAGE:
/*IPackageBinding packageBinding= (IPackageBinding) fBinding;
res.add(new BindingProperty(this, "IS UNNAMED", packageBinding.isUnnamed(), true)); //$NON-NLS-1$
res.add(new BindingProperty(this, "IS SYNTHETIC", fBinding.isSynthetic(), true)); //$NON-NLS-1$
res.add(new BindingProperty(this, "IS DEPRECATED", fBinding.isDeprecated(), true)); //$NON-NLS-1$
*/ break;
case IBinding.TYPE:
ITypeBinding typeBinding= (ITypeBinding) fBinding;
//FIXME: res.add(new BindingProperty(this, "QUALIFIED NAME", typeBinding.getQualifiedName(), true)); //$NON-NLS-1$
int typeKind= getTypeKind(typeBinding);
boolean isRefType= true ; //FIXME: isType(typeKind, REF_TYPE);
// final boolean isNonPrimitive= ! isType(typeKind, PRIMITIVE_TYPE);
StringBuffer kinds= new StringBuffer("KIND:"); //$NON-NLS-1$
if (typeBinding.isArray()) kinds.append(" isArray"); //$NON-NLS-1$
//FIXME: if (typeBinding.isCapture()) kinds.append(" isCapture"); //$NON-NLS-1$
if (typeBinding.isNullType()) kinds.append(" isNullType"); //$NON-NLS-1$
if (typeBinding.isPrimitive()) kinds.append(" isPrimitive"); //$NON-NLS-1$
//FIXME: if (typeBinding.isTypeVariable()) kinds.append(" isTypeVariable"); //$NON-NLS-1$
//FIXME: if (typeBinding.isWildcardType()) kinds.append(" isWildcardType"); //$NON-NLS-1$
// ref types
//FIXME: if (typeBinding.isAnnotation()) kinds.append(" isAnnotation"); //$NON-NLS-1$
if (typeBinding.isClass()) kinds.append(" isClass"); //$NON-NLS-1$
if (typeBinding.isInterface()) kinds.append(" isInterface"); //$NON-NLS-1$
//FIXME: if (typeBinding.isEnum()) kinds.append(" isEnum"); //$NON-NLS-1$
res.add(new BindingProperty(this, kinds, true)); //$NON-NLS-1$
res.add(new Binding(this, "ELEMENT TYPE", typeBinding.getElementType(), isType(typeKind, ARRAY_TYPE))); //$NON-NLS-1$
res.add(new Binding(this, "COMPONENT TYPE", typeBinding.getComponentType(), isType(typeKind, ARRAY_TYPE))); //$NON-NLS-1$
res.add(new BindingProperty(this, "DIMENSIONS", typeBinding.getDimensions(), isType(typeKind, ARRAY_TYPE))); //$NON-NLS-1$
final String createArrayTypeLabel= "CREATE ARRAY TYPE (+1)";
try {
ITypeBinding arrayType= typeBinding.createArrayType(1);
res.add(new Binding(this, createArrayTypeLabel, arrayType, true));
} catch (RuntimeException e) {
String msg= e.getClass().getName() + ": " + e.getLocalizedMessage();
boolean isRelevant= true ;//FIXME: ! typeBinding.getName().equals(PrimitiveType.VOID.toString()) && ! typeBinding.isRecovered();
if (isRelevant) {
res.add(new Error(this, createArrayTypeLabel + ": " + msg, e));
} else {
res.add(new BindingProperty(this, createArrayTypeLabel, msg, false));
}
}
//FIXME : res.add(new BindingProperty(this, "TYPE BOUNDS", typeBinding.getTypeBounds(), isType(typeKind, VARIABLE_TYPE | CAPTURE_TYPE))); //$NON-NLS-1$
//StringBuffer origin= new StringBuffer("ORIGIN:"); //$NON-NLS-1$
//FIXME
/*if (typeBinding.isTopLevel()) origin.append(" isTopLevel"); //$NON-NLS-1$
if (typeBinding.isNested()) origin.append(" isNested"); //$NON-NLS-1$
if (typeBinding.isLocal()) origin.append(" isLocal"); //$NON-NLS-1$
if (typeBinding.isMember()) origin.append(" isMember"); //$NON-NLS-1$
if (typeBinding.isAnonymous()) origin.append(" isAnonymous"); //$NON-NLS-1$
*/ //res.add(new BindingProperty(this, origin, isRefType));
//FIXME : res.add(new BindingProperty(this, "IS FROM SOURCE", typeBinding.isFromSource(), isType(typeKind, REF_TYPE | VARIABLE_TYPE | CAPTURE_TYPE))); //$NON-NLS-1$
/* res.add(new Binding(this, "PACKAGE", typeBinding.getPackage(), isRefType)); //$NON-NLS-1$
res.add(new Binding(this, "DECLARING CLASS", typeBinding.getDeclaringClass(), isType(typeKind, REF_TYPE | VARIABLE_TYPE | CAPTURE_TYPE))); //$NON-NLS-1$
res.add(new Binding(this, "DECLARING METHOD", typeBinding.getDeclaringMethod(), isType(typeKind, REF_TYPE | VARIABLE_TYPE | CAPTURE_TYPE))); //$NON-NLS-1$
res.add(new BindingProperty(this, "MODIFIERS", Flags.toString(fBinding.getModifiers()), isRefType)); //$NON-NLS-1$
*/ res.add(new BindingProperty(this, "BINARY NAME", typeBinding.getBinaryName(), true)); //$NON-NLS-1$
/*res.add(new Binding(this, "TYPE DECLARATION", typeBinding.getTypeDeclaration(), isNonPrimitive)); //$NON-NLS-1$
res.add(new Binding(this, "ERASURE", typeBinding.getErasure(), isNonPrimitive)); //$NON-NLS-1$
res.add(new BindingProperty(this, "TYPE PARAMETERS", typeBinding.getTypeParameters(), isType(typeKind, GENERIC))); //$NON-NLS-1$
res.add(new BindingProperty(this, "TYPE ARGUMENTS", typeBinding.getTypeArguments(), isType(typeKind, PARAMETRIZED))); //$NON-NLS-1$
res.add(new Binding(this, "BOUND", typeBinding.getBound(), isType(typeKind, WILDCARD_TYPE))); //$NON-NLS-1$
res.add(new BindingProperty(this, "IS UPPERBOUND", typeBinding.isUpperbound(), isType(typeKind, WILDCARD_TYPE))); //$NON-NLS-1$
res.add(new Binding(this, "WILDCARD", typeBinding.getWildcard(), isType(typeKind, CAPTURE_TYPE))); //$NON-NLS-1$
*/
res.add(new Binding(this, "SUPERCLASS", typeBinding.getSuperclass(), isRefType)); //$NON-NLS-1$
res.add(new BindingProperty(this, "INTERFACES", typeBinding.getInterfaces(), isRefType)); //$NON-NLS-1$
//FIXME :res.add(new BindingProperty(this, "DECLARED TYPES", typeBinding.getDeclaredTypes(), isRefType)); //$NON-NLS-1$
res.add(new BindingProperty(this, "DECLARED FIELDS", typeBinding.getDeclaredFields(), isRefType)); //$NON-NLS-1$
res.add(new BindingProperty(this, "DECLARED METHODS", typeBinding.getDeclaredMethods(), isRefType)); //$NON-NLS-1$
//FIXME :res.add(new BindingProperty(this, "IS SYNTHETIC", fBinding.isSynthetic(), isNonPrimitive)); //$NON-NLS-1$
//FIXME :res.add(new BindingProperty(this, "IS DEPRECATED", fBinding.isDeprecated(), isRefType)); //$NON-NLS-1$
break;
case IBinding.METHOD:
IMethodBinding methodBinding= (IMethodBinding) fBinding;
res.add(new BindingProperty(this, "IS CONSTRUCTOR", methodBinding.isConstructor(), true)); //$NON-NLS-1$
//FIXME :res.add(new BindingProperty(this, "IS DEFAULT CONSTRUCTOR", methodBinding.isDefaultConstructor(), true)); //$NON-NLS-1$
res.add(new Binding(this, "DECLARING CLASS", methodBinding.getDeclaringClass(), true)); //$NON-NLS-1$
//FIXME :res.add(new Binding(this, "RETURN TYPE", methodBinding.getReturnType(), true)); //$NON-NLS-1$
//FIXME :res.add(new BindingProperty(this, "MODIFIERS", Flags.toString(fBinding.getModifiers()), true)); //$NON-NLS-1$
//FIXME :res.add(new BindingProperty(this, "PARAMETER TYPES", methodBinding.getParameterTypes(), true)); //$NON-NLS-1$
res.add(new BindingProperty(this, "IS VARARGS", methodBinding.isVarargs(), true)); //$NON-NLS-1$
res.add(new BindingProperty(this, "EXCEPTION TYPES", methodBinding.getExceptionTypes(), true)); //$NON-NLS-1$
//StringBuffer genericsM= new StringBuffer("GENERICS:"); //$NON-NLS-1$
//FIXME :if (methodBinding.isRawMethod()) genericsM.append(" isRawMethod"); //$NON-NLS-1$
//FIXME :if (methodBinding.isGenericMethod()) genericsM.append(" isGenericMethod"); //$NON-NLS-1$
//FIXME :if (methodBinding.isParameterizedMethod()) genericsM.append(" isParameterizedMethod"); //$NON-NLS-1$
//res.add(new BindingProperty(this, genericsM, true));
//FIXME :res.add(new Binding(this, "METHOD DECLARATION", methodBinding.getMethodDeclaration(), true)); //$NON-NLS-1$
//FIXME :res.add(new BindingProperty(this, "TYPE PARAMETERS", methodBinding.getTypeParameters(), true)); //$NON-NLS-1$
//FIXME :res.add(new BindingProperty(this, "TYPE ARGUMENTS", methodBinding.getTypeArguments(), true)); //$NON-NLS-1$
//FIXME :res.add(new BindingProperty(this, "IS SYNTHETIC", fBinding.isSynthetic(), true)); //$NON-NLS-1$
//FIXME :res.add(new BindingProperty(this, "IS DEPRECATED", fBinding.isDeprecated(), true)); //$NON-NLS-1$
//FIXME :res.add(new BindingProperty(this, "IS ANNOTATION MEMBER", methodBinding.isAnnotationMember(), true)); //$NON-NLS-1$
//FIXME :res.add(Binding.createValueAttribute(this, "DEFAULT VALUE", methodBinding.getDefaultValue()));
//FIXMEint parameterCount= methodBinding.getParameterTypes().length;
//FIXMEGeneralAttribute[] parametersAnnotations= new GeneralAttribute[parameterCount];
/*for (int i= 0; i < parameterCount; i++) {
parametersAnnotations[i]= new GeneralAttribute(this, "Parameter " + String.valueOf(i), methodBinding.getParameterAnnotations(i));
}*/
//FIXMEres.add(new GeneralAttribute(this, "PARAMETER ANNOTATIONS", parametersAnnotations));
break;
/* case IBinding.ANNOTATION:
IAnnotationBinding annotationBinding= (IAnnotationBinding) fBinding;
res.add(new Binding(this, "ANNOTATION TYPE", annotationBinding.getAnnotationType(), true));
res.add(new BindingProperty(this, "DECLARED MEMBER VALUE PAIRS", annotationBinding.getDeclaredMemberValuePairs(), true));
res.add(new BindingProperty(this, "ALL MEMBER VALUE PAIRS", annotationBinding.getAllMemberValuePairs(), true));
break;
*/
/* case IBinding.MEMBER_VALUE_PAIR:
IMemberValuePairBinding memberValuePairBinding= (IMemberValuePairBinding) fBinding;
res.add(new Binding(this, "METHOD BINDING", memberValuePairBinding.getMethodBinding(), true));
res.add(new BindingProperty(this, "IS DEFAULT", memberValuePairBinding.isDefault(), true));
res.add(Binding.createValueAttribute(this, "VALUE", memberValuePairBinding.getValue()));
break;*/
}
/*try {
IAnnotationBinding[] annotations= fBinding.getAnnotations();
res.add(new BindingProperty(this, "ANNOTATIONS", annotations, true)); //$NON-NLS-1$
} catch (RuntimeException e) {
String label= "Error in IBinding#getAnnotations() for \"" + fBinding.getKey() + "\"";
res.add(new Error(this, label, e));
ASTViewPlugin.log("Exception thrown in IBinding#getAnnotations() for \"" + fBinding.getKey() + "\"", e);
}*/
/*try {
IJavaElement javaElement= fBinding.getPhpElement();
res.add(new PhpElement(this, javaElement));
} catch (RuntimeException e) {
String label= ">java element: " + e.getClass().getName() + " for \"" + fBinding.getKey() + "\""; //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$
res.add(new Error(this, label, e));
ASTViewPlugin.log("Exception thrown in IBinding#getJavaElement() for \"" + fBinding.getKey() + "\"", e);
}*/
return res.toArray();
}
return EMPTY;
}
private final static int ARRAY_TYPE= 1 << 0;
private final static int NULL_TYPE= 1 << 1;
private final static int CLASS_TYPE= 1 << 2;
private final static int INTERFACE_TYPE= 1 << 3;
private final static int AMBIGOUS_TYPE= 1 << 4;
private final static int PRIMITIVE_TYPE= 1 << 5;
private final static int SYNTHETIC_TYPE= 1 << 6;
private final static int GENERIC= 1 << 8;
private final static int UNKNOWN_TYPE= 1 << 9;
private int getTypeKind(ITypeBinding typeBinding) {
if (typeBinding.isArray()) return ARRAY_TYPE;
//if (typeBinding.isCapture()) return CAPTURE_TYPE;
if (typeBinding.isNullType()) return NULL_TYPE;
if (typeBinding.isPrimitive()) return PRIMITIVE_TYPE;
//if (typeBinding.isTypeVariable()) return VARIABLE_TYPE;
//if (typeBinding.isWildcardType()) return WILDCARD_TYPE;
//NIRC
if (typeBinding.isAmbiguous()) return AMBIGOUS_TYPE;
if (typeBinding.isClass()) return CLASS_TYPE;
if (typeBinding.isInterface()) return INTERFACE_TYPE;
// if (typeBinding.isSynthetic()) return SYNTHETIC_TYPE;
if (typeBinding.isUnknown()) return UNKNOWN_TYPE;
//if (typeBinding.isGenericType()) return REF_TYPE | GENERIC;
//if (typeBinding.isParameterizedType() || typeBinding.isRawType()) return REF_TYPE | PARAMETRIZED;
return UNKNOWN_TYPE;
}
public String getLabel() {
StringBuffer buf= new StringBuffer(fLabel);
buf.append(": "); //$NON-NLS-1$
if (fBinding != null) {
switch (fBinding.getKind()) {
case IBinding.VARIABLE:
IVariableBinding variableBinding= (IVariableBinding) fBinding;
if (!variableBinding.isField()) {
buf.append(variableBinding.getName());
} else if (variableBinding.getDeclaringClass() == null) {
buf.append("array type"); //$NON-NLS-1$
} else {
buf.append(variableBinding.getDeclaringClass().getName());
buf.append('.');
buf.append(variableBinding.getName());
}
break;
/*case IBinding.PACKAGE:
IPackageBinding packageBinding= (IPackageBinding) fBinding;
buf.append(packageBinding.getName());
break;*/
case IBinding.TYPE:
ITypeBinding typeBinding= (ITypeBinding) fBinding;
buf.append(typeBinding.getName());// .getQualifiedName());
break;
case IBinding.METHOD:
IMethodBinding methodBinding= (IMethodBinding) fBinding;
buf.append(methodBinding.getDeclaringClass().getName());
buf.append('.');
buf.append(methodBinding.getName());
buf.append('(');
/*//FIXME String[] parameters = methodBinding.getParametersNames();
for(int i=0 ; i<parameters.length ; i++ ){
buf.append(parameters[i]+", ");
}*/
buf.delete(buf.length()-2, buf.length()-1);
buf.append(')');
break;
/*case IBinding.ANNOTATION:
break;
case IBinding.MEMBER_VALUE_PAIR:
buf.append(fBinding.toString());
break;*/
}
} else {
buf.append("null"); //$NON-NLS-1$
}
return buf.toString();
}
public Image getImage() {
return null;
}
public String toString() {
return getLabel();
}
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null || !obj.getClass().equals(getClass())) {
return false;
}
Binding other= (Binding) obj;
if (fParent == null) {
if (other.fParent != null)
return false;
} else if (! fParent.equals(other.fParent)) {
return false;
}
if (fBinding == null) {
if (other.fBinding != null)
return false;
} else if (! fBinding.equals(other.fBinding)) {
return false;
}
return true;
}
public int hashCode() {
int result= fParent != null ? fParent.hashCode() : 0;
result+= (fBinding != null && fBinding.getKey() != null ? fBinding.getKey().hashCode() : 0);
return result;
}
public static String getBindingLabel(IBinding binding) {
String label;
if (binding == null) {
label= ">binding"; //$NON-NLS-1$
} else {
switch (binding.getKind()) {
case IBinding.VARIABLE:
label= "> variable binding"; //$NON-NLS-1$
break;
case IBinding.TYPE:
label= "> type binding"; //$NON-NLS-1$
break;
case IBinding.METHOD:
label= "> method binding"; //$NON-NLS-1$
break;
case IBinding.PACKAGE:
label= "> package binding"; //$NON-NLS-1$
break;
case IBinding.ANNOTATION:
label= "> annotation binding"; //$NON-NLS-1$
break;
case IBinding.MEMBER_VALUE_PAIR:
label= "> member value pair binding"; //$NON-NLS-1$
break;
default:
label= "> unknown binding"; //$NON-NLS-1$
}
}
return label;
}
/**
* Creates an {@link ASTAttribute} for a value from
* {@link IMemberValuePairBinding#getValue()} or from
* {@link IMethodBinding#getDefaultValue()}.
*/
public static ASTAttribute createValueAttribute(ASTAttribute parent, String name, Object value) {
ASTAttribute res;
if (value instanceof IBinding) {
IBinding binding= (IBinding) value;
res= new Binding(parent, name + ": " + getBindingLabel(binding), binding, true);
} else if (value instanceof String) {
res= new GeneralAttribute(parent, name, "\"" + (String) value + "\"");
} else if (value instanceof Object[]) {
res= new GeneralAttribute(parent, name, (Object[]) value);
} else if (value instanceof ASTAttribute) {
res= (ASTAttribute) value;
} else {
res= new GeneralAttribute(parent, name, value);
}
return res;
}
}