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 93b8758..f556cc8 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,18 +1,17 @@ package net.sourceforge.phpdt.internal.compiler.ast; -import net.sourceforge.phpdt.internal.compiler.parser.OutlineableWithChildren; -import net.sourceforge.phpdt.internal.compiler.parser.Outlineable; +import java.util.ArrayList; +import java.util.List; + 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 java.util.Hashtable; -import java.util.Enumeration; -import java.util.ArrayList; -import java.util.List; import test.PHPParserSuperclass; @@ -23,8 +22,8 @@ import test.PHPParserSuperclass; public class MethodDeclaration extends Statement implements OutlineableWithChildren { /** The name of the method. */ - public char[] name; - public Hashtable arguments; + public String name; + public ArrayList arguments; public Statement[] statements; @@ -44,16 +43,20 @@ public class MethodDeclaration extends Statement implements OutlineableWithChild private 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); } @@ -128,15 +131,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++) { + 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$ @@ -151,60 +151,63 @@ public class MethodDeclaration extends Statement implements OutlineableWithChild return children; } + /** no outside variables. */ + public void getOutsideVariable(final List list) { + } + + public void getModifiedVariable(final List list) { + } + + public void getUsedVariable(final List list) { + } + /** - * Get the variables from outside (parameters, globals ...) - * @return the variables from outside + * Get global variables (not parameters). */ - 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 getGlobalVariable(final List list) { + if (statements != null) { + for (int i = 0; i < statements.length; i++) { + statements[i].getOutsideVariable(list); } } + } - if (statements != null) { - for (int i = 0; i < statements.length; i++) { - list.addAll(statements[i].getOutsideVariable()); + private void getParameters(final List list) { + if (arguments != null) { + for (int i = 0; i < arguments.size(); i++) { + 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 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; } @@ -212,49 +215,91 @@ public class MethodDeclaration extends Statement implements OutlineableWithChild 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() { + if (statements != null) { + for (int i = 0; i < statements.length; i++) { + statements[i].analyzeCode(); + + } } - } - /** - * This method will analyze the code. - */ - public void analyzeCode() { - final List outsideVars = getOutsideVariable(); - final List modifiedVars = getModifiedVariable(); + final List globalsVars = new ArrayList(); + getGlobalVariable(globalsVars); + final List modifiedVars = new ArrayList(); + getAssignedVariableInCode(modifiedVars); + final List parameters = new ArrayList(); + getParameters(parameters); - final List declaredVars = new ArrayList(outsideVars.size() + modifiedVars.size()); - declaredVars.addAll(outsideVars); + final List declaredVars = new ArrayList(globalsVars.size() + modifiedVars.size()); + declaredVars.addAll(globalsVars); declaredVars.addAll(modifiedVars); + declaredVars.addAll(parameters); - final List usedVars = getUsedVariable(); + final List usedVars = new ArrayList(); + getUsedVariableInCode(usedVars); + final List readOrWriteVars = new ArrayList(modifiedVars.size() + usedVars.size()); + readOrWriteVars.addAll(modifiedVars); + readOrWriteVars.addAll(usedVars); -/* dumpList(outsideVars, "outside"); - dumpList(modifiedVars, "modified"); - dumpList(usedVars, "used"); */ + //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 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); + } + } + } + } - //look for used variables that were not declared before + private 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 declaredVars the declared variable list + */ + private void findUnknownUsedVars(final List usedVars, final List declaredVars) { for (int i = 0; i < usedVars.size(); i++) { - VariableUsage variableUsage = (VariableUsage) usedVars.get(i); + final VariableUsage variableUsage = (VariableUsage) usedVars.get(i); + if (variableUsage.getName().equals("this")) continue; // this is a special variable if (!isVariableDeclaredBefore(declaredVars, variableUsage)) { try { - PHPParserSuperclass.setMarker("warning, usage of an unknown : " + 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); } } - } } }