SONARPHP-490 Interface model for STATEMENTS

php-frontend/src/main/java/org/sonar/plugins/php/api/tree/Tree.java

@@ -19,13 +19,11 @@
  */
 package org.sonar.plugins.php.api.tree;
 
-import org.sonar.plugins.php.api.tree.declaration.ClassDeclarationTree;
-import com.google.common.annotations.Beta;
-import com.sonar.sslr.api.AstNodeType;
 import org.sonar.plugins.php.api.tree.declaration.ClassFieldDeclarationTree;
 import org.sonar.plugins.php.api.tree.declaration.ClassTree;
 import org.sonar.plugins.php.api.tree.declaration.FunctionDeclarationTree;
 import org.sonar.plugins.php.api.tree.declaration.MethodDeclarationTree;
+import org.sonar.plugins.php.api.tree.declaration.NamespacedNameTree;
 import org.sonar.plugins.php.api.tree.declaration.UseDeclarationTree;
 import org.sonar.plugins.php.api.tree.declaration.UseDeclarationsTree;
 import org.sonar.plugins.php.api.tree.declaration.VariableDeclarationTree;
@@ -34,7 +32,6 @@
 import org.sonar.plugins.php.api.tree.expression.ArrayInitialiserFunctionTree;
 import org.sonar.plugins.php.api.tree.expression.ArrayPairTree;
 import org.sonar.plugins.php.api.tree.expression.AssignmentExpressionTree;
-import org.sonar.plugins.php.api.tree.expression.AssignmentListTree;
 import org.sonar.plugins.php.api.tree.expression.BinaryExpressionTree;
 import org.sonar.plugins.php.api.tree.expression.CastExpressionTree;
 import org.sonar.plugins.php.api.tree.expression.CompoundVariableTree;
@@ -45,9 +42,9 @@
 import org.sonar.plugins.php.api.tree.expression.FunctionCallTree;
 import org.sonar.plugins.php.api.tree.expression.FunctionExpressionTree;
 import org.sonar.plugins.php.api.tree.expression.LexicalVariablesTree;
+import org.sonar.plugins.php.api.tree.expression.ListExpressionTree;
 import org.sonar.plugins.php.api.tree.expression.LiteralTree;
 import org.sonar.plugins.php.api.tree.expression.MemberAccessExpressionTree;
-import org.sonar.plugins.php.api.tree.declaration.NamespacedNameTree;
 import org.sonar.plugins.php.api.tree.expression.NewExpressionTree;
 import org.sonar.plugins.php.api.tree.expression.ParenthesisedExpressionTree;
 import org.sonar.plugins.php.api.tree.expression.ReferenceVariableTree;
@@ -57,15 +54,39 @@
 import org.sonar.plugins.php.api.tree.expression.VariableVariableTree;
 import org.sonar.plugins.php.api.tree.lexical.SyntaxToken;
 import org.sonar.plugins.php.api.tree.statement.BlockTree;
+import org.sonar.plugins.php.api.tree.statement.BreakStatementTree;
+import org.sonar.plugins.php.api.tree.statement.CaseClauseTree;
+import org.sonar.plugins.php.api.tree.statement.CatchBlockTree;
+import org.sonar.plugins.php.api.tree.statement.ContinueStatementTree;
+import org.sonar.plugins.php.api.tree.statement.DeclareStatementTree;
+import org.sonar.plugins.php.api.tree.statement.DefaultClauseTree;
+import org.sonar.plugins.php.api.tree.statement.DoWhileStatementTree;
+import org.sonar.plugins.php.api.tree.statement.EchoStatementTree;
+import org.sonar.plugins.php.api.tree.statement.ElseClauseTree;
+import org.sonar.plugins.php.api.tree.statement.ElseifClauseTree;
+import org.sonar.plugins.php.api.tree.statement.ExpressionStatementTree;
+import org.sonar.plugins.php.api.tree.statement.ForEachStatementTree;
+import org.sonar.plugins.php.api.tree.statement.ForStatementTree;
+import org.sonar.plugins.php.api.tree.statement.GlobalStatementTree;
+import org.sonar.plugins.php.api.tree.statement.GotoStatementTree;
+import org.sonar.plugins.php.api.tree.statement.IfStatementTree;
+import org.sonar.plugins.php.api.tree.statement.LabelTree;
+import org.sonar.plugins.php.api.tree.statement.ReturnStatementTree;
+import org.sonar.plugins.php.api.tree.statement.SwitchStatementTree;
+import org.sonar.plugins.php.api.tree.statement.ThrowStatementTree;
+import org.sonar.plugins.php.api.tree.statement.TraitAdaptationStatementTree;
+import org.sonar.plugins.php.api.tree.statement.TraitAliasTree;
+import org.sonar.plugins.php.api.tree.statement.TraitMethodReferenceTree;
+import org.sonar.plugins.php.api.tree.statement.TraitPrecedenceTree;
 import org.sonar.plugins.php.api.tree.statement.TraitUseStatementTree;
-import org.sonar.plugins.php.api.tree.statement.UseStatementTree;
+import org.sonar.plugins.php.api.tree.statement.TryStatementTree;
+import org.sonar.plugins.php.api.tree.statement.WhileStatementTree;
+import org.sonar.plugins.php.api.tree.statement.YieldStatementTree;
 import org.sonar.sslr.grammar.GrammarRuleKey;
 
 import com.google.common.annotations.Beta;
 import com.sonar.sslr.api.AstNodeType;
 
-import org.sonar.sslr.grammar.GrammarRuleKey;
-
 /**
  * Common interface for all nodes in an abstract syntax tree.
  */
@@ -86,9 +107,9 @@ public enum Kind implements AstNodeType, GrammarRuleKey {
      */
     INTERFACE_DECLARATION(ClassTree.class),
 
-     /**
-     * {@link ClassTree}
-     */
+    /**
+    * {@link ClassTree}
+    */
     TRAIT_DECLARATION(ClassTree.class),
 
     /**
@@ -126,16 +147,6 @@ public enum Kind implements AstNodeType, GrammarRuleKey {
      */
     USE_DECLARATION(UseDeclarationTree.class),
 
-    /**
-     * {@link TraitUseStatementTree}
-     */
-    TRAIT_USE_STATEMENT(TraitUseStatementTree.class),
-
-    /**
-     * {@link BlockTree}
-     */
-    BLOCK(BlockTree.class),
-
     /**
      * {@link ParenthesisedExpressionTree}
      */
@@ -234,9 +245,9 @@ public enum Kind implements AstNodeType, GrammarRuleKey {
     EXIT_EXPRESSION(ExitTree.class),
 
     /**
-     * {@link AssignmentListTree}
+     * {@link ListExpressionTree}
      */
-    ASSIGNMENT_LIST(AssignmentListTree.class),
+    LIST_EXPRESSION(ListExpressionTree.class),
 
     /**
      * {@link NewExpressionTree}
@@ -571,11 +582,205 @@ public enum Kind implements AstNodeType, GrammarRuleKey {
      */
     MAGIC_CONSTANT(LiteralTree.class),
 
+    /**
+     * {@link TraitUseStatementTree}
+     */
+    TRAIT_USE_STATEMENT(TraitUseStatementTree.class),
+
+    /**
+     * {@link BlockTree}
+     */
+    BLOCK(BlockTree.class),
+
+    /**
+     * {@link LabelTree}
+     */
+    LABEL(LabelTree.class),
+
+    /**
+     * {@link IfStatementTree}
+     */
+    IF_STATEMENT(IfStatementTree.class),
+
+    /**
+     * {@link IfStatementTree}
+     */
+    ALTRNATIVE_IF_STATEMENT(IfStatementTree.class),
+
+    /**
+     * {@link ElseifClauseTree}
+     */
+    ELSEIF_CLAUSE(ElseifClauseTree.class),
+
+    /**
+     * {@link ElseifClauseTree}
+     */
+    ALTERNATIVE_ELSEIF_CLAUSE(ElseifClauseTree.class),
+
+    /**
+     * {@link ElseClauseTree}
+     */
+    ELSE_CLAUSE(ElseClauseTree.class),
+
+    /**
+     * {@link ElseClauseTree}
+     */
+    ALTERNATIVE_ELSE_CLAUSE(ElseClauseTree.class),
+
+    /**
+     * {@link WhileStatementTree}
+     */
+    WHILE_STATEMENT(WhileStatementTree.class),
+
+    /**
+     * {@link WhileStatementTree}
+     */
+    ALTERNATIVE_WHILE_STATEMENT(WhileStatementTree.class),
+
+    /**
+     * {@link DoWhileStatementTree}
+     */
+    DO_WHILE_STATEMENT(DoWhileStatementTree.class),
+
+    /**
+     * {@link ForStatementTree}
+     */
+    FOR_STATEMENT(ForStatementTree.class),
+
+    /**
+     * {@link ForStatementTree}
+     */
+    ALTERNATIVE_FOR_STATEMENT(ForStatementTree.class),
+
+    /**
+     * {@link SwitchStatementTree}
+     */
+    SWITCH_STATEMENT(SwitchStatementTree.class),
+
+    /**
+     * {@link SwitchStatementTree}
+     */
+    ALTERNATIVE_SWITCH_STATEMENT(SwitchStatementTree.class),
+
+    /**
+     * {@link CaseClauseTree}
+     */
+    CASE_CLAUSE(CaseClauseTree.class),
+
+    /**
+     * {@link DefaultClauseTree}
+     */
+    DEFAULT_CLAUSE(DefaultClauseTree.class),
+
+    /**
+     * {@link BreakStatementTree}
+     */
+    BREAK_STATEMENT(BreakStatementTree.class),
+
+    /**
+     * {@link ContinueStatementTree}
+     */
+    CONTINUE_STATEMENT(ContinueStatementTree.class),
+
+    /**
+     * {@link ReturnStatementTree}
+     */
+    RETURN_STATEMENT(ReturnStatementTree.class),
+
+    /**
+     * {@link ExpressionStatementTree}
+     */
+    EXPRESSION_STATEMENT(ExpressionStatementTree.class),
+
+    /**
+     * {@link ForEachStatementTree}
+     */
+    FOREACH_STATEMENT(ForEachStatementTree.class),
+
+    /**
+     * {@link ForEachStatementTree}
+     */
+    ALTERNATIVE_FOREACH_STATEMENT(ForEachStatementTree.class),
+
+    /**
+     * {@link DeclareStatementTree}
+     */
+    DECLARE_STATEMENT(DeclareStatementTree.class),
+
+    /**
+     * {@link DeclareStatementTree}
+     */
+    ALTERNATIVE_DECLARE_STATEMENT(DeclareStatementTree.class),
+
+    /**
+     * {@link TryStatementTree}
+     */
+    TRY_STATEMENT(TryStatementTree.class),
+
+    /**
+     * {@link CatchBlockTree}
+     */
+    CATCH_BLOCK(CatchBlockTree.class),
+
+    /**
+     * {@link ThrowStatementTree}
+     */
+    THROW_STATEMENT(ThrowStatementTree.class),
+
+    /**
+     * {@link GotoStatementTree}
+     */
+    GOTO_STATEMENT(GotoStatementTree.class),
+
+    /**
+     * {@link YieldStatementTree}
+     */
+    YIELD_STATEMENT(YieldStatementTree.class),
+
+    /**
+     * {@link GlobalStatementTree}
+     */
+    GLOBAL_STATEMENT(GlobalStatementTree.class),
+
+    /**
+     * {@link EchoStatementTree}
+     */
+    ECHO_STATEMENT(EchoStatementTree.class),
+
+    /**
+     * {@link EchoStatementTree}
+     */
+    UNSET_VARIABLE_STATEMENT(EchoStatementTree.class),
+
+    /**
+     * {@link TraitAdaptationStatementTree}
+     */
+    TRAIT_ADAPTATION_STATEMENT(TraitAdaptationStatementTree.class),
+
+    /**
+     * {@link TraitPrecedenceTree}
+     */
+    TRAIT_PRECEDENCE(TraitPrecedenceTree.class),
+
+    /**
+     * {@link TraitMethodReferenceTree}
+     */
+    TRAIT_METHOD_REFERENCE(TraitMethodReferenceTree.class),
+
+    /**
+     * {@link TraitAliasTree}
+     */
+    TRAIT_ALIAS(TraitAliasTree.class),
+
     /**
      * {@link SyntaxToken}
      */
-    TOKEN(SyntaxToken.class);
+    INLINE_HTML(SyntaxToken.class),
 
+    /**
+     * {@link SyntaxToken}
+     */
+    TOKEN(SyntaxToken.class);
 
     final Class<? extends Tree> associatedInterface;
 

php-frontend/src/main/java/org/sonar/plugins/php/api/tree/declaration/ClassFieldDeclarationTree.java

@@ -52,7 +52,6 @@ public interface ClassFieldDeclarationTree extends ClassMemberTree {
 
   SeparatedList<VariableDeclarationTree> declarations();
 
-  @Nullable
-  SyntaxToken semicolonToken();
+  SyntaxToken eosToken();
 
 }

php-frontend/src/main/java/org/sonar/plugins/php/api/tree/declaration/UseDeclarationsTree.java

@@ -39,5 +39,5 @@ public interface UseDeclarationsTree extends DeclarationTree {
   List<UseDeclarationTree> declarations();
 
   @Nullable
-  SyntaxToken semicolonToken();
+  SyntaxToken eosToken();
 }

php-frontend/src/main/java/org/sonar/plugins/php/api/tree/expression/CastExpressionTree.java

@@ -18,11 +18,11 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
  */
 package org.sonar.plugins.php.api.tree.expression;
+
 import org.sonar.php.api.PHPKeyword;
+import org.sonar.plugins.php.api.tree.lexical.SyntaxToken;
 
 import com.google.common.annotations.Beta;
-import org.sonar.plugins.php.api.tree.declaration.DeclarationTree;
-import org.sonar.plugins.php.api.tree.lexical.SyntaxToken;
 
 @Beta
 public interface CastExpressionTree extends ExpressionTree {

php-frontend/src/main/java/org/sonar/plugins/php/api/tree/expression/AssignmentListTree.java → php-frontend/src/main/java/org/sonar/plugins/php/api/tree/expression/ListExpressionTree.java

@@ -23,8 +23,10 @@
 import org.sonar.php.tree.impl.SeparatedList;
 import org.sonar.plugins.php.api.tree.lexical.SyntaxToken;
 
+import javax.annotation.Nullable;
+
 @Beta
-public interface AssignmentListTree extends ExpressionTree {
+public interface ListExpressionTree extends ExpressionTree {
 
   SyntaxToken listToken();
 
@@ -34,7 +36,4 @@ public interface AssignmentListTree extends ExpressionTree {
 
   SyntaxToken closeParenthesisToken();
 
-  SyntaxToken equalToken();
-
-  ExpressionTree initialisation();
 }

php-frontend/src/main/java/org/sonar/plugins/php/api/tree/statement/BlockTree.java

@@ -27,9 +27,9 @@
 @Beta
 public interface BlockTree extends StatementTree {
 
-  SyntaxToken openCurlyBrace();
+  SyntaxToken openCurlyBraceToken();
 
   List<StatementTree> statements();
 
-  SyntaxToken closeCurlyBrace();
+  SyntaxToken closeCurlyBraceToken();
 }