X-Git-Url: http://secure.phpeclipse.com diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/compiler/ast/MethodDeclaration.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/compiler/ast/MethodDeclaration.java index 48fdda2..f1220ab 100644 --- a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/compiler/ast/MethodDeclaration.java +++ b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/compiler/ast/MethodDeclaration.java @@ -1,51 +1,50 @@ 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 String 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 String name, - final Hashtable arguments, + final ArrayList arguments, final boolean reference, final int sourceStart, final int sourceEnd, @@ -63,6 +62,7 @@ public class MethodDeclaration extends Statement implements OutlineableWithChild /** * Return method into String, with a number of tabs + * * @param tab the number of tabs * @return the String containing the method */ @@ -73,16 +73,17 @@ public class MethodDeclaration extends Statement implements OutlineableWithChild 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++) { @@ -98,6 +99,7 @@ public class MethodDeclaration extends Statement implements OutlineableWithChild /** * Get the image of a class. + * * @return the image that represents a php class */ public ImageDescriptor getImage() { @@ -132,15 +134,12 @@ public class MethodDeclaration extends Statement implements OutlineableWithChild 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$ @@ -155,78 +154,74 @@ public class MethodDeclaration extends Statement implements OutlineableWithChild return children; } - /** no outside variables. */ - public List getOutsideVariable() { - return new ArrayList(1); - } + /** + * Get the variables from outside (parameters, globals ...) + * + * @param list the list where we will put variables + */ + public void getOutsideVariable(final List list) {} - public List getModifiedVariable() { - return new ArrayList(1); - } + /** + * get the modified variables. + * + * @param list the list where we will put variables + */ + public void getModifiedVariable(final List list) {} - public List getUsedVariable() { - return new ArrayList(1); - } + /** + * 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). - * @return the variables from outside */ - public List getGlobalVariable() { - final ArrayList list = new ArrayList(); - + 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); } } - return list; } - private List getParameters(final List list) { + private void getParameters(final List list) { if (arguments != null) { - final Enumeration vars = arguments.elements(); - while (vars.hasMoreElements()) { - final VariableDeclaration variable = (VariableDeclaration) vars.nextElement(); + 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 */ - private List getAssignedVariableInCode() { - 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 */ - private List getUsedVariableInCode() { - 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; } @@ -234,7 +229,9 @@ public class MethodDeclaration extends Statement implements OutlineableWithChild return false; } - /** This method will analyze the code. */ + /** + * This method will analyze the code. + */ public void analyzeCode() { if (statements != null) { for (int i = 0; i < statements.length; i++) { @@ -243,40 +240,46 @@ public class MethodDeclaration extends Statement implements OutlineableWithChild } } - final List globalsVars = getGlobalVariable(); - final List modifiedVars = getAssignedVariableInCode(); - final List parameters = getParameters(new ArrayList()); + final List globalsVars = new ArrayList(); + getGlobalVariable(globalsVars); + final List modifiedVars = new ArrayList(); + getAssignedVariableInCode(modifiedVars); + final List parameters = new ArrayList(arguments.size()); + getParameters(parameters); final List declaredVars = new ArrayList(globalsVars.size() + modifiedVars.size()); declaredVars.addAll(globalsVars); declaredVars.addAll(modifiedVars); declaredVars.addAll(parameters); - final List usedVars = getUsedVariableInCode(); - final List readOrWriteVars = new ArrayList(modifiedVars.size()+usedVars.size()); + 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); + findUnusedParameters(readOrWriteVars, parameters); findUnknownUsedVars(usedVars, declaredVars); } /** * This method will add a warning on all unused parameters. - * @param vars the used variable list + * + * @param vars the used variable list * @param parameters the declared variable list */ - private void findUnusedParameters(final List vars, final List parameters) { + private static void findUnusedParameters(final List vars, final List parameters) { for (int i = 0; i < parameters.size(); i++) { - VariableUsage param = ((VariableUsage)parameters.get(i)); - if (!isVariableInList(param.getName(),vars)) { + 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, - ""); + 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); } @@ -284,7 +287,14 @@ public class MethodDeclaration extends Statement implements OutlineableWithChild } } - private boolean isVariableInList(final String name, final List list) { + /** + * 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; @@ -295,20 +305,24 @@ public class MethodDeclaration extends Statement implements OutlineableWithChild /** * 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 (variableUsage.getName().equals("this")) continue; // this is a special variable - 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 { - PHPParserSuperclass.setMarker("warning, usage of a variable that seems to be unassigned yet : " + 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); }