Introduce explicit Finally node

Author: nikic

CHANGELOG.md

@@ -34,8 +34,12 @@ Additionally the following changes were made:
 * The `type` subnode on `Class`, `ClassMethod` and `Property` has been renamed to `flags`. The
   `type` subnode has retained for backwards compatibility and is populated to the same value as
   `flags`. However, writes to `type` will not update `flags`.
+* The `TryCatch::$finallyStmts` subnode has been replaced with a `$finally` subnode that holds an
+  explicit `Finally` node. This allows for more accurate attribute assignment.
 * The `Trait` constructor now has the same form as the `Class` and `Interface` constructors: It
   takes an array of subnodes. Unlike classes/interfaces, traits can only have a `stmts` subnode.
+* The `NodeDumper` now prints class/method/property/constant modifiers, as well as the include and
+  use type in a textual representation, instead of only showing the number.
 
 ### Removed
 

grammar/php5.y

@@ -206,7 +206,7 @@ catch:
 
 optional_finally:
       /* empty */                                           { $$ = null; }
-    | T_FINALLY '{' inner_statement_list '}'                { $$ = $3; }
+    | T_FINALLY '{' inner_statement_list '}'                { $$ = Stmt\Finally_[$3]; }
 ;
 
 variables_list:

grammar/php7.y

@@ -207,7 +207,7 @@ catch:
 
 optional_finally:
       /* empty */                                           { $$ = null; }
-    | T_FINALLY '{' inner_statement_list '}'                { $$ = $3; }
+    | T_FINALLY '{' inner_statement_list '}'                { $$ = Stmt\Finally_[$3]; }
 ;
 
 variables_list:

lib/PhpParser/Node/Stmt/Finally_.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace PhpParser\Node\Stmt;
+
+use PhpParser\Node;
+
+class Finally_ extends Node\Stmt
+{
+    /** @var Node[] Statements */
+    public $stmts;
+
+    /**
+     * Constructs a finally node.
+     *
+     * @param Node[] $stmts      Statements
+     * @param array  $attributes Additional attributes
+     */
+    public function __construct(array $stmts = array(), array $attributes = array()) {
+        parent::__construct($attributes);
+        $this->stmts = $stmts;
+    }
+
+    public function getSubNodeNames() {
+        return array('stmts');
+    }
+}

lib/PhpParser/Node/Stmt/TryCatch.php

@@ -11,29 +11,29 @@ class TryCatch extends Node\Stmt
     public $stmts;
     /** @var Catch_[] Catches */
     public $catches;
-    /** @var null|Node[] Finally statements */
-    public $finallyStmts;
+    /** @var null|Finally_ Optional finally node */
+    public $finally;
 
     /**
      * Constructs a try catch node.
      *
-     * @param Node[]      $stmts        Statements
-     * @param Catch_[]    $catches      Catches
-     * @param null|Node[] $finallyStmts Finally statements (null means no finally clause)
-     * @param array|null  $attributes   Additional attributes
+     * @param Node[]        $stmts      Statements
+     * @param Catch_[]      $catches    Catches
+     * @param null|Finally_ $finally    Optionaly finally node
+     * @param array|null    $attributes Additional attributes
      */
-    public function __construct(array $stmts, array $catches, array $finallyStmts = null, array $attributes = array()) {
-        if (empty($catches) && null === $finallyStmts) {
+    public function __construct(array $stmts, array $catches, Finally_ $finally = null, array $attributes = array()) {
+        if (empty($catches) && null === $finally) {
             throw new Error('Cannot use try without catch or finally');
         }
 
         parent::__construct($attributes);
         $this->stmts = $stmts;
         $this->catches = $catches;
-        $this->finallyStmts = $finallyStmts;
+        $this->finally = $finally;
     }
 
     public function getSubNodeNames() {
-        return array('stmts', 'catches', 'finallyStmts');
+        return array('stmts', 'catches', 'finally');
     }
 }

lib/PhpParser/Parser/Php5.php

@@ -1561,7 +1561,7 @@ protected function reduceRule161() {
     }
 
     protected function reduceRule162() {
-         $this->semValue = $this->semStack[$this->stackPos-(4-3)];
+         $this->semValue = new Stmt\Finally_($this->semStack[$this->stackPos-(4-3)], $this->startAttributeStack[$this->stackPos-(4-1)] + $this->endAttributes);
     }
 
     protected function reduceRule163() {

lib/PhpParser/Parser/Php7.php

@@ -1438,7 +1438,7 @@ protected function reduceRule159() {
     }
 
     protected function reduceRule160() {
-         $this->semValue = $this->semStack[$this->stackPos-(4-3)];
+         $this->semValue = new Stmt\Finally_($this->semStack[$this->stackPos-(4-3)], $this->startAttributeStack[$this->stackPos-(4-1)] + $this->endAttributes);
     }
 
     protected function reduceRule161() {

lib/PhpParser/PrettyPrinter/Standard.php

@@ -729,16 +729,18 @@ public function pStmt_Case(Stmt\Case_ $node) {
     public function pStmt_TryCatch(Stmt\TryCatch $node) {
         return 'try {' . $this->pStmts($node->stmts) . "\n" . '}'
              . $this->pImplode($node->catches)
-             . ($node->finallyStmts !== null
-                ? ' finally {' . $this->pStmts($node->finallyStmts) . "\n" . '}'
-                : '');
+             . ($node->finally !== null ? $this->p($node->finally) : '');
     }
 
     public function pStmt_Catch(Stmt\Catch_ $node) {
         return ' catch (' . $this->pImplode($node->types, '|') . ' $' . $node->var . ') {'
              . $this->pStmts($node->stmts) . "\n" . '}';
     }
 
+    public function pStmt_Finally(Stmt\Finally_ $node) {
+        return ' finally {' . $this->pStmts($node->stmts) . "\n" . '}';
+    }
+
     public function pStmt_Break(Stmt\Break_ $node) {
         return 'break' . ($node->num !== null ? ' ' . $this->p($node->num) : '') . ';';
     }

test/code/parser/stmt/multiCatch.test

@@ -60,6 +60,6 @@ array(
                 )
             )
         )
-        finallyStmts: null
+        finally: null
     )
 )

test/code/parser/stmt/tryCatch.test

@@ -78,14 +78,16 @@ array(
                 )
             )
         )
-        finallyStmts: array(
-            0: Expr_FuncCall(
-                name: Name(
-                    parts: array(
-                        0: doFinally
+        finally: Stmt_Finally(
+            stmts: array(
+                0: Expr_FuncCall(
+                    name: Name(
+                        parts: array(
+                            0: doFinally
+                        )
+                    )
+                    args: array(
                     )
-                )
-                args: array(
                 )
             )
         )
@@ -107,7 +109,7 @@ array(
                 )
             )
         )
-        finallyStmts: null
+        finally: null
         comments: array(
             0: // no finally
         )
@@ -117,7 +119,9 @@ array(
         )
         catches: array(
         )
-        finallyStmts: array(
+        finally: Stmt_Finally(
+            stmts: array(
+            )
         )
         comments: array(
             0: // no catch