The methods to get variables do not instantiate ArrayList each time, only one is...
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / compiler / ast / MethodDeclaration.java
index 663735a..6934c07 100644 (file)
@@ -23,7 +23,7 @@ import test.PHPParserSuperclass;
 public class MethodDeclaration extends Statement implements OutlineableWithChildren {
 
   /** The name of the method. */
-  public char[] name;
+  public String name;
   public Hashtable arguments;
 
 
@@ -44,16 +44,20 @@ public class MethodDeclaration extends Statement implements OutlineableWithChild
   private Position position;
 
   public MethodDeclaration(final Object parent,
-                           final char[] name,
+                           final String name,
                            final Hashtable 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);
   }
 
@@ -151,60 +155,64 @@ 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) {
+      final Enumeration vars = arguments.elements();
+      while (vars.hasMoreElements()) {
+        final VariableDeclaration variable = (VariableDeclaration) vars.nextElement();
+        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,54 +220,87 @@ 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.
-   */
+  /** 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();
+    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 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);
+        }
+      }
+    }
+  }
+
+  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 {
-          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);
         }