package net.sourceforge.phpdt.internal.compiler.ast;
-import net.sourceforge.phpdt.internal.compiler.parser.OutlineableWithChildren;
-import net.sourceforge.phpdt.internal.compiler.parser.Outlineable;
import net.sourceforge.phpdt.internal.compiler.ast.declarations.VariableUsage;
+import net.sourceforge.phpdt.internal.compiler.parser.Outlineable;
+import net.sourceforge.phpdt.internal.compiler.parser.OutlineableWithChildren;
import net.sourceforge.phpdt.internal.ui.PHPUiImages;
import net.sourceforge.phpeclipse.PHPeclipsePlugin;
+import org.eclipse.core.runtime.CoreException;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.text.Position;
-import org.eclipse.core.runtime.CoreException;
+import test.PHPParserSuperclass;
-import java.util.Hashtable;
-import java.util.Enumeration;
import java.util.ArrayList;
+import java.util.HashSet;
import java.util.List;
-import test.PHPParserSuperclass;
-
/**
* A Method declaration.
+ *
* @author Matthieu Casanova
*/
-public class MethodDeclaration extends Statement implements OutlineableWithChildren {
+public final class MethodDeclaration extends Statement implements OutlineableWithChildren {
/** The name of the method. */
- public char[] name;
- public Hashtable arguments;
+ public final String name;
+ private final ArrayList arguments;
public Statement[] statements;
- public int bodyStart;
- public int bodyEnd = -1;
+ private final int bodyStart;
+ private int bodyEnd = -1;
/** Tell if the method is a class constructor. */
public boolean isConstructor;
/** The parent object. */
private Object parent;
/** The outlineable children (those will be in the node array too. */
- private ArrayList children = new ArrayList();
+ private final ArrayList children = new ArrayList();
/** Tell if the method returns a reference. */
- public boolean reference;
+ private final boolean reference;
- private Position position;
+ private final Position position;
public MethodDeclaration(final Object parent,
- final char[] name,
- final Hashtable arguments,
+ final String name,
+ final ArrayList arguments,
final boolean reference,
final int sourceStart,
- final int sourceEnd) {
+ final int sourceEnd,
+ final int bodyStart,
+ final int bodyEnd) {
super(sourceStart, sourceEnd);
this.name = name;
this.arguments = arguments;
this.parent = parent;
this.reference = reference;
+ this.bodyStart = bodyStart;
+ this.bodyEnd = bodyEnd;
position = new Position(sourceStart, sourceEnd);
}
/**
* Return method into String, with a number of tabs
+ *
* @param tab the number of tabs
* @return the String containing the method
*/
return buff.toString();
}
- public String toStringHeader() {
+ private String toStringHeader() {
return "function " + toString();
}
/**
* Return the statements of the method into Strings
+ *
* @param tab the number of tabs
* @return the String containing the statements
*/
- public String toStringStatements(final int tab) {
+ private String toStringStatements(final int tab) {
final StringBuffer buff = new StringBuffer(" {"); //$NON-NLS-1$
if (statements != null) {
for (int i = 0; i < statements.length; i++) {
/**
* Get the image of a class.
+ *
* @return the image that represents a php class
*/
public ImageDescriptor getImage() {
buff.append(name).append("(");//$NON-NLS-1$
if (arguments != null) {
- final Enumeration values = arguments.elements();
- int i = 0;
- while (values.hasMoreElements()) {
- final VariableDeclaration o = (VariableDeclaration) values.nextElement();
+ for (int i = 0; i < arguments.size(); i++) {
+ final VariableDeclaration o = (VariableDeclaration) arguments.get(i);
buff.append(o.toStringExpression());
if (i != (arguments.size() - 1)) {
buff.append(", "); //$NON-NLS-1$
}
- i++;
}
}
buff.append(")"); //$NON-NLS-1$
/**
* Get the variables from outside (parameters, globals ...)
- * @return the variables from outside
+ *
+ * @param list the list where we will put variables
*/
- public List getOutsideVariable() {
- final ArrayList list = new ArrayList();
- if (arguments != null) {
- final Enumeration vars = arguments.keys();
- while (vars.hasMoreElements()) {
- list.add(new VariableUsage((String) vars.nextElement(), sourceStart));
- }
- }
+ public void getOutsideVariable(final List list) {}
+ /**
+ * get the modified variables.
+ *
+ * @param list the list where we will put variables
+ */
+ public void getModifiedVariable(final List list) {}
+
+ /**
+ * This method will analyze the code.
+ *
+ * @param list the list where we will put variables
+ */
+ public void getUsedVariable(final List list) {}
+
+ /**
+ * Get global variables (not parameters).
+ */
+ private void getGlobalVariable(final List list) {
if (statements != null) {
for (int i = 0; i < statements.length; i++) {
- list.addAll(statements[i].getOutsideVariable());
+ statements[i].getOutsideVariable(list);
+ }
+ }
+ }
+
+ private void getParameters(final List list) {
+ if (arguments != null) {
+ for (int i = 0; i < arguments.size(); i++) {
+ final VariableDeclaration variable = (VariableDeclaration) arguments.get(i);
+ list.add(new VariableUsage(variable.name(), variable.sourceStart));
}
}
- return list;
}
/**
* get the modified variables.
- * @return the variables from we change value
*/
- public List getModifiedVariable() {
- final ArrayList list = new ArrayList();
+ private void getAssignedVariableInCode(final List list) {
if (statements != null) {
for (int i = 0; i < statements.length; i++) {
- list.addAll(statements[i].getModifiedVariable());
+ statements[i].getModifiedVariable(list);
}
}
- return list;
}
/**
* Get the variables used.
- * @return the variables used
*/
- public List getUsedVariable() {
- final ArrayList list = new ArrayList();
+ private void getUsedVariableInCode(final List list) {
if (statements != null) {
for (int i = 0; i < statements.length; i++) {
- list.addAll(statements[i].getUsedVariable());
+ statements[i].getUsedVariable(list);
}
}
- return list;
}
- private boolean isVariableDeclaredBefore(List list, VariableUsage var) {
+ private static boolean isVariableDeclaredBefore(final List list, final VariableUsage var) {
final String name = var.getName();
final int pos = var.getStartOffset();
for (int i = 0; i < list.size(); i++) {
- VariableUsage variableUsage = (VariableUsage) list.get(i);
+ final VariableUsage variableUsage = (VariableUsage) list.get(i);
if (variableUsage.getName().equals(name) && variableUsage.getStartOffset() < pos) {
return true;
}
return false;
}
- private void dumpList(List list, String name) {
- StringBuffer buff = new StringBuffer(name).append("\n");
- for (int i = 0; i < list.size(); i++) {
- buff.append(list.get(i).toString()).append("\n");
- }
- if (PHPeclipsePlugin.DEBUG) {
- PHPeclipsePlugin.log(1, buff.toString());
- }
- }
-
/**
* This method will analyze the code.
*/
public void analyzeCode() {
- final List outsideVars = getOutsideVariable();
- final List modifiedVars = getModifiedVariable();
+ if (statements != null) {
+ for (int i = 0; i < statements.length; i++) {
+ statements[i].analyzeCode();
- final List declaredVars = new ArrayList(outsideVars.size() + modifiedVars.size());
- declaredVars.addAll(outsideVars);
- declaredVars.addAll(modifiedVars);
+ }
+ }
- final List usedVars = getUsedVariable();
+ final List globalsVars = new ArrayList();
+ getGlobalVariable(globalsVars);
+ final List modifiedVars = new ArrayList();
+ getAssignedVariableInCode(modifiedVars);
+ final List parameters = new ArrayList(arguments.size());
+ getParameters(parameters);
-/* dumpList(outsideVars, "outside");
- dumpList(modifiedVars, "modified");
- dumpList(usedVars, "used"); */
+ final List declaredVars = new ArrayList(globalsVars.size() + modifiedVars.size());
+ declaredVars.addAll(globalsVars);
+ declaredVars.addAll(modifiedVars);
+ declaredVars.addAll(parameters);
+ final List usedVars = new ArrayList();
+ getUsedVariableInCode(usedVars);
+ final List readOrWriteVars = new ArrayList(modifiedVars.size() + usedVars.size());
+ readOrWriteVars.addAll(modifiedVars);
+ readOrWriteVars.addAll(usedVars);
//look for used variables that were not declared before
+ findUnusedParameters(readOrWriteVars, parameters);
findUnknownUsedVars(usedVars, declaredVars);
}
/**
+ * This method will add a warning on all unused parameters.
+ *
+ * @param vars the used variable list
+ * @param parameters the declared variable list
+ */
+ private static void findUnusedParameters(final List vars, final List parameters) {
+ for (int i = 0; i < parameters.size(); i++) {
+ final VariableUsage param = (VariableUsage) parameters.get(i);
+ if (!isVariableInList(param.getName(), vars)) {
+ try {
+ PHPParserSuperclass.setMarker(
+ "warning, the parameter " + param.getName() + " seems to be never used in your method",
+ param.getStartOffset(),
+ param.getStartOffset() + param.getName().length(),
+ PHPParserSuperclass.WARNING,
+ "");
+ } catch (CoreException e) {
+ PHPeclipsePlugin.log(e);
+ }
+ }
+ }
+ }
+
+ /**
+ * Tell if the list of VariableUsage contains a variable named by the name given.
+ *
+ * @param name the variable name
+ * @param list the list of VariableUsage
+ * @return true if the variable is in the list false otherwise
+ */
+ private static boolean isVariableInList(final String name, final List list) {
+ for (int i = 0; i < list.size(); i++) {
+ if (((VariableUsage) list.get(i)).getName().equals(name)) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
* This method will add a warning on all used variables in a method that aren't declared before.
- * @param usedVars the used variable list
+ *
+ * @param usedVars the used variable list
* @param declaredVars the declared variable list
*/
- private void findUnknownUsedVars(final List usedVars, final List declaredVars) {
+ private static void findUnknownUsedVars(final List usedVars, final List declaredVars) {
+ final HashSet list = new HashSet(usedVars.size());
for (int i = 0; i < usedVars.size(); i++) {
- VariableUsage variableUsage = (VariableUsage) usedVars.get(i);
- if (!isVariableDeclaredBefore(declaredVars, variableUsage)) {
+ final VariableUsage variableUsage = (VariableUsage) usedVars.get(i);
+ if ("this".equals(variableUsage.getName())) continue; // this is a special variable
+ if (!list.contains(variableUsage.getName()) && !isVariableDeclaredBefore(declaredVars, variableUsage)) {
+ list.add(variableUsage.getName());
try {
- PHPeclipsePlugin.log(1,variableUsage.getName()+" "+variableUsage.getStartOffset());
- PHPParserSuperclass.setMarker("warning, usage of an unknown variable : " + variableUsage.getName(),
- variableUsage.getStartOffset(),
- variableUsage.getStartOffset() + variableUsage.getName().length(),
- PHPParserSuperclass.WARNING,
- "");
+ PHPParserSuperclass.setMarker(
+ "warning, usage of a variable that seems to be unassigned yet : " + variableUsage.getName(),
+ variableUsage.getStartOffset(),
+ variableUsage.getStartOffset() + variableUsage.getName().length(),
+ PHPParserSuperclass.WARNING,
+ "");
} catch (CoreException e) {
PHPeclipsePlugin.log(e);
}
git://git.phpeclipse.com / phpeclipse.git / blobdiff