+++ /dev/null
-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.ui.PHPUiImages;
-import net.sourceforge.phpeclipse.PHPeclipsePlugin;
-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;
-
-/**
- * A Method declaration.
- * @author Matthieu Casanova
- */
-public class MethodDeclaration extends Statement implements OutlineableWithChildren {
-
- /** The name of the method. */
- public String 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;
-
- /** The parent object. */
- private Object parent;
- /** The outlineable children (those will be in the node array too. */
- private ArrayList children = new ArrayList();
-
- /** Tell if the method returns a reference. */
- public boolean reference;
-
- private Position position;
-
- public MethodDeclaration(final Object parent,
- final String name,
- final Hashtable arguments,
- final boolean reference,
- final int sourceStart,
- 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
- */
- public String toString(final int tab) {
- final StringBuffer buff = new StringBuffer(tabString(tab));
- buff.append(toStringHeader());
- buff.append(toStringStatements(tab + 1));
- return buff.toString();
- }
-
- public 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) {
- final 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 void setParent(final Object parent) {
- this.parent = parent;
- }
-
- public Object getParent() {
- return parent;
- }
-
- public boolean add(final Outlineable o) {
- return children.add(o);
- }
-
- public Outlineable get(final int index) {
- return (Outlineable) children.get(index);
- }
-
- public int size() {
- return children.size();
- }
-
- public String toString() {
- final StringBuffer buff = new StringBuffer();
- if (reference) {
- buff.append("&");//$NON-NLS-1$
- }
- 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();
- buff.append(o.toStringExpression());
- if (i != (arguments.size() - 1)) {
- buff.append(", "); //$NON-NLS-1$
- }
- i++;
- }
- }
- buff.append(")"); //$NON-NLS-1$
- return buff.toString();
- }
-
- public Position getPosition() {
- return position;
- }
-
- public List getList() {
- return children;
- }
-
- /**
- * Get global variables (not parameters)
- * @return the variables from outside
- */
- public List getOutsideVariable() {
- final ArrayList list = new ArrayList();
-
- if (statements != null) {
- for (int i = 0; i < statements.length; i++) {
- list.addAll(statements[i].getOutsideVariable());
- }
- }
- return list;
- }
-
- private List getParameters(final List list) {
- if (arguments != null) {
- final Enumeration vars = arguments.keys();
- while (vars.hasMoreElements()) {
- list.add(new VariableUsage((String) vars.nextElement(), sourceStart));
- }
- }
- return list;
- }
-
- /**
- * get the modified variables.
- * @return the variables from we change value
- */
- public List getModifiedVariable() {
- final ArrayList list = new ArrayList();
- if (statements != null) {
- for (int i = 0; i < statements.length; i++) {
- list.addAll(statements[i].getModifiedVariable());
- }
- }
- return list;
- }
-
- /**
- * Get the variables used.
- * @return the variables used
- */
- public List getUsedVariable() {
- final ArrayList list = new ArrayList();
- if (statements != null) {
- for (int i = 0; i < statements.length; i++) {
- list.addAll(statements[i].getUsedVariable());
- }
- }
- return list;
- }
-
- private boolean isVariableDeclaredBefore(List list, 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);
- 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 globalsVars = getOutsideVariable();
- final List modifiedVars = getModifiedVariable();
- final List parameters = getParameters(new ArrayList());
-
- final List declaredVars = new ArrayList(globalsVars.size() + modifiedVars.size());
- declaredVars.addAll(globalsVars);
- declaredVars.addAll(modifiedVars);
- declaredVars.addAll(parameters);
-
- final List usedVars = getUsedVariable();
- final List readOrWriteVars = new ArrayList(modifiedVars.size()+usedVars.size());
- readOrWriteVars.addAll(modifiedVars);
- readOrWriteVars.addAll(usedVars);
-/* dumpList(globalsVars, "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++) {
- 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);
- if (variableUsage.getName().equals("this")) continue; // this is a special variable
- if (!isVariableDeclaredBefore(declaredVars, variableUsage)) {
- 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,
- "");
- } catch (CoreException e) {
- PHPeclipsePlugin.log(e);
- }
- }
- }
- }
-}
git://git.phpeclipse.com / phpeclipse.git / blobdiff