Added some function documentation (explode, rege, eregi,...)
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / compiler / ast / GlobalStatement.java
1 package net.sourceforge.phpdt.internal.compiler.ast;
2
3 import net.sourceforge.phpdt.internal.compiler.parser.Outlineable;
4 import net.sourceforge.phpdt.internal.ui.PHPUiImages;
5 import net.sourceforge.phpeclipse.PHPeclipsePlugin;
6 import org.eclipse.jface.resource.ImageDescriptor;
7 import org.eclipse.jface.text.Position;
8 import org.eclipse.core.runtime.CoreException;
9
10 import java.util.List;
11 import java.util.ArrayList;
12 import java.util.Arrays;
13
14 import test.PHPParserSuperclass;
15
16 /**
17  * A GlobalStatement statement in php.
18  * @author Matthieu Casanova
19  */
20 public class GlobalStatement extends Statement implements Outlineable {
21
22   /** An array of the variables called by this global statement. */
23   public AbstractVariable[] variables;
24
25   private Object parent;
26
27   private Position position;
28
29   public GlobalStatement(final Object parent,
30                          final AbstractVariable[] variables,
31                          final int sourceStart,
32                          final int sourceEnd) {
33     super(sourceStart, sourceEnd);
34     this.variables = variables;
35     this.parent = parent;
36     position = new Position(sourceStart, sourceEnd);
37   }
38
39   public String toString() {
40     final StringBuffer buff = new StringBuffer("global ");//$NON-NLS-1$
41     for (int i = 0; i < variables.length; i++) {
42       if (i != 0) {
43         buff.append(", ");//$NON-NLS-1$
44       }
45       buff.append(variables[i].toStringExpression());
46     }
47     return buff.toString();
48   }
49
50   public String toString(final int tab) {
51     return tabString(tab) + toString();
52   }
53
54   /**
55    * This will return the image for the outline of the object.
56    * @return an image
57    */
58   public ImageDescriptor getImage() {
59     return PHPUiImages.DESC_INC;
60   }
61
62   public Object getParent() {
63     return parent;
64   }
65
66   public Position getPosition() {
67     return position;
68   }
69
70   /**
71    * Get the variables from outside (parameters, globals ...)
72    */
73   public void getOutsideVariable(final List list) {
74     for (int i = 0; i < variables.length; i++) {
75       variables[i].getUsedVariable(list);
76     }
77   }
78
79   /**
80    * get the modified variables.
81    */
82   public void getModifiedVariable(final List list) {
83   }
84
85   /**
86    * Get the variables used.
87    */
88   public void getUsedVariable(final List list) {
89   }
90
91   /**
92    * We will analyse the code.
93    * if we have in globals a special variable it will be reported as a warning.
94    * @see Variable#SPECIAL_VARS
95    */
96   public void analyzeCode() {
97     for (int i = 0; i < variables.length; i++) {
98       if (arrayContains(Variable.SPECIAL_VARS, variables[i].getName())) {
99         try {
100           PHPParserSuperclass.setMarker("warning, you shouldn't request " + variables[i].getName() + " as global",
101                                         variables[i].sourceStart,
102                                         variables[i].sourceEnd,
103                                         PHPParserSuperclass.WARNING,
104                                         "");
105         } catch (CoreException e) {
106           PHPeclipsePlugin.log(e);
107         }
108       }
109     }
110   }
111 }