Changes:
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / compiler / ast / Variable.java
index a6d027a..2a76db4 100644 (file)
 package net.sourceforge.phpdt.internal.compiler.ast;
 
-import net.sourceforge.phpdt.internal.compiler.ast.declarations.VariableUsage;
-
 import java.util.List;
-import java.util.ArrayList;
+
+import net.sourceforge.phpdt.internal.compiler.ast.declarations.VariableUsage;
 
 /**
+ * A variable.
+ * It could be a simple variable, or contains another variable.
  * @author Matthieu Casanova
  */
-public class Variable extends Expression {
+public class Variable extends AbstractVariable {
 
   /** The name of the variable. */
-  public char[] name;
+  private String name;
+
+  /** A variable inside ($$varname). */
+  private AbstractVariable variable;
 
+  /** the variable is defined like this ${expression} */
+  private Expression expression;
 
-  public Variable(final char[] name, final int sourceStart, final int sourceEnd) {
+  public static final String _GET = "_GET";
+  public static final String _POST = "_POST";
+  public static final String _REQUEST = "_REQUEST";
+  public static final String _SERVER = "_SERVER";
+  public static final String _SESSION = "_SESSION";
+  public static final String _this = "this";
+  public static final String GLOBALS = "GLOBALS";
+  public static final String _COOKIE = "_COOKIE";
+  public static final String _FILES = "_FILES";
+  public static final String _ENV = "_ENV";
+
+  /** Here is an array of all superglobals variables and the special "this". */
+  public static final String[] SPECIAL_VARS = {_GET,
+                                               _POST,
+                                               _REQUEST,
+                                               _SERVER,
+                                               _SESSION,
+                                               _this,
+                                               GLOBALS,
+                                               _COOKIE,
+                                               _FILES,
+                                               _ENV};
+
+  /**
+   * Create a new simple variable.
+   * @param name the name
+   * @param sourceStart the starting position
+   * @param sourceEnd the ending position
+   */
+  public Variable(final String name,
+                  final int sourceStart,
+                  final int sourceEnd) {
     super(sourceStart, sourceEnd);
     this.name = name;
   }
 
-    /**
+  /**
+   * Create a special variable ($$toto for example).
+   * @param variable the variable contained
+   * @param sourceStart the starting position
+   * @param sourceEnd the ending position
+   */
+  public Variable(final AbstractVariable variable,
+                  final int sourceStart,
+                  final int sourceEnd) {
+    super(sourceStart, sourceEnd);
+    this.variable = variable;
+  }
+
+  /**
+   * Create a special variable ($$toto for example).
+   * @param expression the variable contained
+   * @param sourceStart the starting position
+   * @param sourceEnd the ending position
+   */
+  public Variable(final Expression expression,
+                  final int sourceStart,
+                  final int sourceEnd) {
+    super(sourceStart, sourceEnd);
+    this.expression = expression;
+  }
+
+  /**
    * Return the expression as String.
    * @return the expression
    */
   public String toStringExpression() {
-    return "$"+new String(name);
+    return "$" + getName();
   }
 
   public String getName() {
-    return new String(name);
+    if (name != null) {
+      return name;
+    }
+    if (variable != null) {
+      return variable.toStringExpression();
+    }
+    return "{" + expression.toStringExpression() + "}";
   }
 
   /**
    * Get the variables from outside (parameters, globals ...)
-   * @return the variables from outside
    */
-  public List getOutsideVariable() {
-    return new ArrayList(1);
+  public void getOutsideVariable(final List list) {
   }
 
   /**
    * get the modified variables.
-   * @return the variables modified
    */
-  public List getModifiedVariable() {
-    final ArrayList list = new ArrayList(1);
-    list.add(new VariableUsage(getName(),sourceStart));
-    return list;
+  public void getModifiedVariable(final List list) {
   }
 
   /**
    * Get the variables used.
-   * @return the variables used
    */
-  public List getUsedVariable() {
-    return new ArrayList(1);
+  public void getUsedVariable(final List list) {
+    final String varName;
+    if (name != null) {
+      varName = name;
+    } else if (variable != null) {
+      varName = variable.getName();
+    } else {
+      varName = expression.toStringExpression();//todo : do a better thing like evaluate this ??
+    }
+    if (!arrayContains(SPECIAL_VARS, name)) {
+      list.add(new VariableUsage(varName, sourceStart));
+    }
   }
 }