/plugins/PHPParser/tags/v1_2_0_alpha_3/src/net/sourceforge/phpdt/internal/compiler/ast/MethodDeclaration.java
# · Java · 305 lines · 194 code · 40 blank · 71 comment · 28 complexity · 1a8f26307a41ea4fc13fcbeb83faa508 MD5 · raw file
- package net.sourceforge.phpdt.internal.compiler.ast;
- 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 java.util.ArrayList;
- import java.util.HashSet;
- import java.util.List;
- import gatchan.phpparser.parser.PHPParseMessageEvent;
- import gatchan.phpparser.parser.PHPParser;
- /**
- * A Method declaration.
- *
- * @author Matthieu Casanova
- */
- public final class MethodDeclaration extends Statement implements OutlineableWithChildren {
- private MethodHeader methodHeader;
- public Statement[] statements;
- private int bodyStart;
- private int bodyEnd = -1;
- /** Tell if the method is a class constructor. */
- public boolean isConstructor;
- /** The parent object. */
- private transient Object parent;
- /** The outlineable children (those will be in the node array too. */
- private final ArrayList children = new ArrayList();
- public MethodDeclaration(Object parent, MethodHeader methodHeader) {
- super(methodHeader.getSourceStart(),
- 0,
- methodHeader.getBeginLine(),
- 0,
- methodHeader.getBeginColumn(),
- 0);
- this.parent = parent;
- this.methodHeader = methodHeader;
- }
- /**
- * 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(200);
- buff.append(methodHeader.toString(tab));
- 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
- */
- 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++) {
- 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();
- }
- 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() {
- return methodHeader.toString();
- }
- public List getList() {
- return children;
- }
- /**
- * Get the variables from outside (parameters, globals ...)
- *
- * @param list the list where we will put variables
- */
- public void getOutsideVariable(final List list) {
- }
- /**
- * get the modified variables.
- *
- * @param list the list where we will put variables
- */
- public void getModifiedVariable(final List list) {
- }
- /**
- * 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). */
- private void getGlobalVariable(final List list) {
- if (statements != null) {
- for (int i = 0; i < statements.length; i++) {
- statements[i].getOutsideVariable(list);
- }
- }
- }
- /** get the modified variables. */
- private void getAssignedVariableInCode(final List list) {
- if (statements != null) {
- for (int i = 0; i < statements.length; i++) {
- statements[i].getModifiedVariable(list);
- }
- }
- }
- /** Get the variables used. */
- private void getUsedVariableInCode(final List list) {
- if (statements != null) {
- for (int i = 0; i < statements.length; i++) {
- statements[i].getUsedVariable(list);
- }
- }
- }
- private static boolean isVariableDeclaredBefore(final List list, final VariableUsage var) {
- final String name = var.getName();
- final int pos = var.getSourceStart();
- for (int i = 0; i < list.size(); i++) {
- final VariableUsage variableUsage = (VariableUsage) list.get(i);
- if (variableUsage.getName().equals(name) && variableUsage.getSourceStart() < pos) {
- return true;
- }
- }
- return false;
- }
- /** This method will analyze the code. */
- public void analyzeCode(PHPParser parser) {
- if (statements != null) {
- for (int i = 0; i < statements.length; i++) {
- statements[i].analyzeCode(parser);
- }
- }
- final List globalsVars = new ArrayList();
- getGlobalVariable(globalsVars);
- final List modifiedVars = new ArrayList();
- getAssignedVariableInCode(modifiedVars);
- final List parameters = new ArrayList(methodHeader.getArgumentsCount());
- methodHeader.getParameters(parameters);
- 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(parser, readOrWriteVars, parameters);
- findUnknownUsedVars(parser, 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 static void findUnusedParameters(PHPParser parser, 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)) {
- parser.fireParseMessage(new PHPParseMessageEvent(PHPParser.WARNING,
- PHPParseMessageEvent.MESSAGE_UNUSED_PARAMETERS,
- parser.getPath(),
- "warning, the parameter " + param.getName() + " seems to be never used in your method",
- param.getSourceStart(),
- param.getSourceEnd(),
- param.getBeginLine(),
- param.getEndLine(),
- param.getBeginColumn(),
- param.getEndColumn()));
- /* fireParseMessage(new PHPParseMessageEvent(PHPParser.WARNING,
- parser.getPath(),
- "You should use '<?php' instead of '<?' it will avoid some problems with XML",
- param.getSourceStart(),
- param.getSourceStart() + param.getName().length(),
- token.beginLine,
- token.endLine,
- token.beginColumn,
- token.endColumn));*/
- }
- }
- }
- /**
- * 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;
- }
- }
- 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 static void findUnknownUsedVars(PHPParser parser, final List usedVars, final List declaredVars) {
- final HashSet list = new HashSet(usedVars.size());
- for (int i = 0; i < usedVars.size(); i++) {
- 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());
- parser.fireParseMessage(new PHPParseMessageEvent(PHPParser.WARNING,
- PHPParseMessageEvent.MESSAGE_VARIABLE_MAY_BE_UNASSIGNED,
- parser.getPath(),
- "warning, usage of a variable that seems to be unassigned yet : " + variableUsage.getName(),
- variableUsage.getSourceStart(),
- variableUsage.getSourceEnd(),
- variableUsage.getBeginLine(),
- variableUsage.getEndLine(),
- variableUsage.getBeginColumn(),
- variableUsage.getEndColumn()));
- }
- }
- }
- public String getName() {
- return methodHeader.getName();
- }
- public int getBodyEnd() {
- return bodyEnd;
- }
- public int getBodyStart() {
- return bodyStart;
- }
- public void setBodyStart(int bodyStart) {
- this.bodyStart = bodyStart;
- }
- public void setBodyEnd(int bodyEnd) {
- this.sourceEnd = bodyEnd;
- this.bodyEnd = bodyEnd;
- }
- public MethodHeader getMethodHeader() {
- return methodHeader;
- }
- }