1) Moved net.sourceforge.phpeclipse.ui\src\net\sourceforge\phpdt back to net.sourcefo...
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / compiler / ast / MethodDeclaration.java
index 93097f0..d41b0e8 100644 (file)
+/*******************************************************************************
+ * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials 
+ * are made available under the terms of the Common Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/cpl-v10.html
+ * 
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
 package net.sourceforge.phpdt.internal.compiler.ast;
 
-import net.sourceforge.phpdt.internal.compiler.ast.Block;
-import net.sourceforge.phpdt.internal.compiler.ast.ArgumentDeclaration;
-import net.sourceforge.phpdt.internal.compiler.parser.OutlineableWithChildren;
-import net.sourceforge.phpdt.internal.compiler.parser.Outlineable;
-import net.sourceforge.phpdt.internal.ui.PHPUiImages;
-import org.eclipse.jface.resource.ImageDescriptor;
-
-import java.util.Hashtable;
-import java.util.Enumeration;
-import java.util.ArrayList;
-
-/**
- * A Method declaration.
- * @author Matthieu Casanova
- */
-public class MethodDeclaration extends Statement implements OutlineableWithChildren {
-
-  /** The name of the method. */
-  public char[] name;
-  public Hashtable arguments;
-
-
-  public Statement[] statements;
-  public int bodyStart;
-  public int bodyEnd = -1;
-  /** Tell if the method is a class constructor. */
-  public boolean isConstructor;
-  private Object parent;
-  /** The outlineable children (those will be in the node array too. */
-  private ArrayList children = new ArrayList();
-
-  public boolean reference;
-
-  public MethodDeclaration(Object parent,
-                           char[] name,
-                           Hashtable arguments,
-                           boolean reference,
-                           int sourceStart,
-                           int sourceEnd) {
-    super(sourceStart, sourceEnd);
-    this.name = name;
-    this.arguments = arguments;
-    this.parent = parent;
-    this.reference = reference;
-  }
-
-  /**
-   * Return method into String, with a number of tabs
-   * @param tab the number of tabs
-   * @return the String containing the method
-   */
-  public String toString(int tab) {
-    StringBuffer buff = new StringBuffer(tabString(tab));
-    buff.append("function ");//$NON-NLS-1$
-    if (reference) {
-      buff.append('&');//$NON-NLS-1$
-    }
-    buff.append(name).append("(");//$NON-NLS-1$
-
-    if (arguments != null) {
-      Enumeration values = arguments.elements();
-      int i = 0;
-      while (values.hasMoreElements()) {
-        ArgumentDeclaration o = (ArgumentDeclaration) values.nextElement();
-        buff.append(o.toString(0));
-        if (i != (arguments.size() - 1)) {
-          buff.append(", "); //$NON-NLS-1$
-        }
-        i++;
-      }
-    }
-    buff.append(")"); //$NON-NLS-1$
-
-   buff.append(toStringStatements(tab + 1));
-    return buff.toString();
-  }
-
-  /**
-   * Return the statements of the method into Strings
-   * @param tab the number of tabs
-   * @return the String containing the statements
-   */
-  public String toStringStatements(int tab) {
-    StringBuffer buff = new StringBuffer(" {"); //$NON-NLS-1$
-    if (statements != null) {
-      for (int i = 0; i < statements.length; i++) {
-        buff.append("\n").append(statements[i].toString(tab)); //$NON-NLS-1$
-        if (!(statements[i] instanceof Block)) {
-          buff.append(";"); //$NON-NLS-1$
-        }
-      }
-    }
-    buff.append("\n").append(tabString(tab == 0 ? 0 : tab - 1)).append("}"); //$NON-NLS-2$ //$NON-NLS-1$
-    return buff.toString();
-  }
-
-  /**
-   * Get the image of a class.
-   * @return the image that represents a php class
-   */
-  public ImageDescriptor getImage() {
-    return PHPUiImages.DESC_FUN;
-  }
-
-  public Object getParent() {
-    return parent;
-  }
-
-  public boolean add(Outlineable o) {
-    return children.add(o);
-  }
-
-  public Outlineable get(int index) {
-    return (Outlineable) children.get(index);
-  }
-
-  public int size() {
-    return children.size();
-  }
+import net.sourceforge.phpdt.core.compiler.CharOperation;
+import net.sourceforge.phpdt.internal.compiler.ASTVisitor;
+import net.sourceforge.phpdt.internal.compiler.CompilationResult;
+import net.sourceforge.phpdt.internal.compiler.flow.ExceptionHandlingFlowContext;
+import net.sourceforge.phpdt.internal.compiler.flow.FlowInfo;
+import net.sourceforge.phpdt.internal.compiler.flow.InitializationFlowContext;
+import net.sourceforge.phpdt.internal.compiler.lookup.ClassScope;
+import net.sourceforge.phpdt.internal.compiler.lookup.TypeBinding;
+import net.sourceforge.phpdt.internal.compiler.parser.UnitParser;
+import net.sourceforge.phpdt.internal.compiler.problem.AbortMethod;
+
+public class MethodDeclaration extends AbstractMethodDeclaration {
+
+       public TypeReference returnType;
+
+       public static final int FUNCTION_DEFINITION = 1;
+
+       public static final int METHOD_DEFINITION = 2;
+
+       public int type;
+
+       /**
+        * MethodDeclaration constructor comment.
+        */
+       public MethodDeclaration(CompilationResult compilationResult) {
+               super(compilationResult);
+       }
+
+       public void analyseCode(ClassScope classScope,
+                       InitializationFlowContext initializationContext, FlowInfo flowInfo) {
+
+               // starting of the code analysis for methods
+               if (ignoreFurtherInvestigation)
+                       return;
+               try {
+                       if (binding == null)
+                               return;
+
+                       if (this.binding.isPrivate() && !this.binding.isPrivateUsed()) {
+                               if (!classScope.referenceCompilationUnit().compilationResult
+                                               .hasSyntaxError()) {
+                                       scope.problemReporter().unusedPrivateMethod(this);
+                               }
+                       }
+
+                       // may be in a non necessary <clinit> for innerclass with static
+                       // final constant fields
+                       if (binding.isAbstract()) // || binding.isNative())
+                               return;
+
+                       ExceptionHandlingFlowContext methodContext = new ExceptionHandlingFlowContext(
+                                       initializationContext, this, binding.thrownExceptions,
+                                       scope, FlowInfo.DEAD_END);
+
+                       // propagate to statements
+                       if (statements != null) {
+                               boolean didAlreadyComplain = false;
+                               for (int i = 0, count = statements.length; i < count; i++) {
+                                       Statement stat;
+                                       if (!flowInfo.complainIfUnreachable((stat = statements[i]),
+                                                       scope, didAlreadyComplain)) {
+                                               flowInfo = stat.analyseCode(scope, methodContext,
+                                                               flowInfo);
+                                       } else {
+                                               didAlreadyComplain = true;
+                                       }
+                               }
+                       }
+                       // check for missing returning path
+                       TypeBinding returnType = binding.returnType;
+                       if ((returnType == VoidBinding) || isAbstract()) {
+                               this.needFreeReturn = flowInfo.isReachable();
+                       } else {
+                               if (flowInfo != FlowInfo.DEAD_END) {
+                                       scope.problemReporter().shouldReturn(returnType, this);
+                               }
+                       }
+               } catch (AbortMethod e) {
+                       this.ignoreFurtherInvestigation = true;
+               }
+       }
+
+       public void parseStatements(UnitParser parser,
+                       CompilationUnitDeclaration unit) {
+
+               // fill up the method body with statement
+               if (ignoreFurtherInvestigation)
+                       return;
+               parser.parse(this, unit);
+       }
+
+       public void resolveStatements() {
+
+               // ========= abort on fatal error =============
+               if (this.returnType != null && this.binding != null) {
+                       this.returnType.resolvedType = this.binding.returnType;
+                       // record the return type binding
+               }
+               // look if the name of the method is correct
+               if (binding != null && isTypeUseDeprecated(binding.returnType, scope))
+                       scope.problemReporter().deprecatedType(binding.returnType,
+                                       returnType);
+
+               if (scope != null) {
+                       if (CharOperation.equals(scope.enclosingSourceType().sourceName,
+                                       selector))
+                               scope.problemReporter().methodWithConstructorName(this);
+
+                       // by grammatical construction, interface methods are always
+                       // abstract
+                       if (!scope.enclosingSourceType().isInterface()) {
+
+                               // if a method has an semicolon body and is not declared as
+                               // abstract==>error
+                               // native methods may have a semicolon body
+                               // if ((modifiers & AccSemicolonBody) != 0) {
+                               // if ((modifiers & AccNative) == 0)
+                               // if ((modifiers & AccAbstract) == 0)
+                               // scope.problemReporter().methodNeedingAbstractModifier(this);
+                               // } else {
+                               // // the method HAS a body --> abstract native modifiers are
+                               // forbiden
+                               // if (((modifiers & AccNative) != 0) || ((modifiers &
+                               // AccAbstract) != 0))
+                               // scope.problemReporter().methodNeedingNoBody(this);
+                               // }
+                       }
+               }
+               super.resolveStatements();
+       }
+
+       public String returnTypeToString(int tab) {
+
+               if (returnType == null)
+                       return ""; //$NON-NLS-1$
+               return returnType.toString(tab) + " "; //$NON-NLS-1$
+       }
+
+       public void traverse(ASTVisitor visitor, ClassScope classScope) {
+
+               if (visitor.visit(this, classScope)) {
+                       if (returnType != null)
+                               returnType.traverse(visitor, scope);
+                       if (arguments != null) {
+                               int argumentLength = arguments.length;
+                               for (int i = 0; i < argumentLength; i++)
+                                       arguments[i].traverse(visitor, scope);
+                       }
+                       if (thrownExceptions != null) {
+                               int thrownExceptionsLength = thrownExceptions.length;
+                               for (int i = 0; i < thrownExceptionsLength; i++)
+                                       thrownExceptions[i].traverse(visitor, scope);
+                       }
+                       if (statements != null) {
+                               int statementsLength = statements.length;
+                               for (int i = 0; i < statementsLength; i++)
+                                       statements[i].traverse(visitor, scope);
+                       }
+               }
+               visitor.endVisit(this, classScope);
+       }
 }