Added some function documentation (explode, rege, eregi,...)
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / compiler / ast / WhileStatement.java
1 package net.sourceforge.phpdt.internal.compiler.ast;
2
3 import java.util.List;
4 import java.util.ArrayList;
5
6 /**
7  * A While statement.
8  * @author Matthieu Casanova
9  */
10 public class WhileStatement extends Statement {
11
12   /** The condition expression. */
13   public Expression condition;
14   /** The action of the while. (it could be a block) */
15   public Statement action;
16
17   /**
18    * Create a While statement.
19    * @param condition the condition
20    * @param action the action
21    * @param sourceStart the starting offset
22    * @param sourceEnd the ending offset
23    */
24   public WhileStatement(final Expression condition,
25                         final Statement action,
26                         final int sourceStart,
27                         final int sourceEnd) {
28     super(sourceStart, sourceEnd);
29     this.condition = condition;
30     this.action = action;
31   }
32
33   /**
34    * Return the object into String.
35    * @param tab how many tabs (not used here
36    * @return a String
37    */
38   public String toString(final int tab) {
39     final String s = tabString(tab);
40     final StringBuffer buff = new StringBuffer(s).append("while ("); //$NON-NLS-1$
41     buff.append(condition.toStringExpression()).append(")");    //$NON-NLS-1$
42     if (action == null) {
43       buff.append(" {} ;"); //$NON-NLS-1$
44     } else {
45       buff.append("\n").append(action.toString(tab + 1)); //$NON-NLS-1$
46     }
47     return buff.toString();
48   }
49
50   /**
51    * Get the variables from outside (parameters, globals ...)
52    */
53   public void getOutsideVariable(final List list) {
54     condition.getOutsideVariable(list); // todo: check if unuseful
55     if (action != null) {
56       action.getOutsideVariable(list);
57     }
58   }
59
60   /**
61    * get the modified variables.
62    */
63   public void getModifiedVariable(final List list) {
64     condition.getModifiedVariable(list);
65     if (action != null) {
66       action.getModifiedVariable(list);
67     }
68   }
69
70   /**
71    * Get the variables used.
72    */
73   public void getUsedVariable(final List list) {
74     condition.getUsedVariable(list);
75     if (action != null) {
76       action.getUsedVariable(list);
77     }
78   }
79 }