Chris@13: <?php declare(strict_types=1);
Chris@0: 
Chris@0: namespace PhpParser;
Chris@0: 
Chris@0: use PhpParser\Node\Expr\Include_;
Chris@0: use PhpParser\Node\Stmt\Class_;
Chris@0: use PhpParser\Node\Stmt\GroupUse;
Chris@0: use PhpParser\Node\Stmt\Use_;
Chris@0: use PhpParser\Node\Stmt\UseUse;
Chris@0: 
Chris@0: class NodeDumper
Chris@0: {
Chris@0:     private $dumpComments;
Chris@0:     private $dumpPositions;
Chris@0:     private $code;
Chris@0: 
Chris@0:     /**
Chris@0:      * Constructs a NodeDumper.
Chris@0:      *
Chris@0:      * Supported options:
Chris@0:      *  * bool dumpComments: Whether comments should be dumped.
Chris@0:      *  * bool dumpPositions: Whether line/offset information should be dumped. To dump offset
Chris@0:      *                        information, the code needs to be passed to dump().
Chris@0:      *
Chris@0:      * @param array $options Options (see description)
Chris@0:      */
Chris@0:     public function __construct(array $options = []) {
Chris@0:         $this->dumpComments = !empty($options['dumpComments']);
Chris@0:         $this->dumpPositions = !empty($options['dumpPositions']);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Dumps a node or array.
Chris@0:      *
Chris@0:      * @param array|Node  $node Node or array to dump
Chris@0:      * @param string|null $code Code corresponding to dumped AST. This only needs to be passed if
Chris@0:      *                          the dumpPositions option is enabled and the dumping of node offsets
Chris@0:      *                          is desired.
Chris@0:      *
Chris@0:      * @return string Dumped value
Chris@0:      */
Chris@13:     public function dump($node, string $code = null) : string {
Chris@0:         $this->code = $code;
Chris@0:         return $this->dumpRecursive($node);
Chris@0:     }
Chris@0: 
Chris@0:     protected function dumpRecursive($node) {
Chris@0:         if ($node instanceof Node) {
Chris@0:             $r = $node->getType();
Chris@0:             if ($this->dumpPositions && null !== $p = $this->dumpPosition($node)) {
Chris@0:                 $r .= $p;
Chris@0:             }
Chris@0:             $r .= '(';
Chris@0: 
Chris@0:             foreach ($node->getSubNodeNames() as $key) {
Chris@0:                 $r .= "\n    " . $key . ': ';
Chris@0: 
Chris@0:                 $value = $node->$key;
Chris@0:                 if (null === $value) {
Chris@0:                     $r .= 'null';
Chris@0:                 } elseif (false === $value) {
Chris@0:                     $r .= 'false';
Chris@0:                 } elseif (true === $value) {
Chris@0:                     $r .= 'true';
Chris@0:                 } elseif (is_scalar($value)) {
Chris@0:                     if ('flags' === $key || 'newModifier' === $key) {
Chris@0:                         $r .= $this->dumpFlags($value);
Chris@13:                     } elseif ('type' === $key && $node instanceof Include_) {
Chris@0:                         $r .= $this->dumpIncludeType($value);
Chris@13:                     } elseif ('type' === $key
Chris@0:                             && ($node instanceof Use_ || $node instanceof UseUse || $node instanceof GroupUse)) {
Chris@0:                         $r .= $this->dumpUseType($value);
Chris@0:                     } else {
Chris@0:                         $r .= $value;
Chris@0:                     }
Chris@0:                 } else {
Chris@0:                     $r .= str_replace("\n", "\n    ", $this->dumpRecursive($value));
Chris@0:                 }
Chris@0:             }
Chris@0: 
Chris@13:             if ($this->dumpComments && $comments = $node->getComments()) {
Chris@0:                 $r .= "\n    comments: " . str_replace("\n", "\n    ", $this->dumpRecursive($comments));
Chris@0:             }
Chris@0:         } elseif (is_array($node)) {
Chris@0:             $r = 'array(';
Chris@0: 
Chris@0:             foreach ($node as $key => $value) {
Chris@0:                 $r .= "\n    " . $key . ': ';
Chris@0: 
Chris@0:                 if (null === $value) {
Chris@0:                     $r .= 'null';
Chris@0:                 } elseif (false === $value) {
Chris@0:                     $r .= 'false';
Chris@0:                 } elseif (true === $value) {
Chris@0:                     $r .= 'true';
Chris@0:                 } elseif (is_scalar($value)) {
Chris@0:                     $r .= $value;
Chris@0:                 } else {
Chris@0:                     $r .= str_replace("\n", "\n    ", $this->dumpRecursive($value));
Chris@0:                 }
Chris@0:             }
Chris@0:         } elseif ($node instanceof Comment) {
Chris@0:             return $node->getReformattedText();
Chris@0:         } else {
Chris@0:             throw new \InvalidArgumentException('Can only dump nodes and arrays.');
Chris@0:         }
Chris@0: 
Chris@0:         return $r . "\n)";
Chris@0:     }
Chris@0: 
Chris@0:     protected function dumpFlags($flags) {
Chris@0:         $strs = [];
Chris@0:         if ($flags & Class_::MODIFIER_PUBLIC) {
Chris@0:             $strs[] = 'MODIFIER_PUBLIC';
Chris@0:         }
Chris@0:         if ($flags & Class_::MODIFIER_PROTECTED) {
Chris@0:             $strs[] = 'MODIFIER_PROTECTED';
Chris@0:         }
Chris@0:         if ($flags & Class_::MODIFIER_PRIVATE) {
Chris@0:             $strs[] = 'MODIFIER_PRIVATE';
Chris@0:         }
Chris@0:         if ($flags & Class_::MODIFIER_ABSTRACT) {
Chris@0:             $strs[] = 'MODIFIER_ABSTRACT';
Chris@0:         }
Chris@0:         if ($flags & Class_::MODIFIER_STATIC) {
Chris@0:             $strs[] = 'MODIFIER_STATIC';
Chris@0:         }
Chris@0:         if ($flags & Class_::MODIFIER_FINAL) {
Chris@0:             $strs[] = 'MODIFIER_FINAL';
Chris@0:         }
Chris@0: 
Chris@0:         if ($strs) {
Chris@0:             return implode(' | ', $strs) . ' (' . $flags . ')';
Chris@0:         } else {
Chris@0:             return $flags;
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     protected function dumpIncludeType($type) {
Chris@0:         $map = [
Chris@0:             Include_::TYPE_INCLUDE      => 'TYPE_INCLUDE',
Chris@0:             Include_::TYPE_INCLUDE_ONCE => 'TYPE_INCLUDE_ONCE',
Chris@0:             Include_::TYPE_REQUIRE      => 'TYPE_REQUIRE',
Chris@13:             Include_::TYPE_REQUIRE_ONCE => 'TYPE_REQUIRE_ONCE',
Chris@0:         ];
Chris@0: 
Chris@0:         if (!isset($map[$type])) {
Chris@0:             return $type;
Chris@0:         }
Chris@0:         return $map[$type] . ' (' . $type . ')';
Chris@0:     }
Chris@0: 
Chris@0:     protected function dumpUseType($type) {
Chris@0:         $map = [
Chris@0:             Use_::TYPE_UNKNOWN  => 'TYPE_UNKNOWN',
Chris@0:             Use_::TYPE_NORMAL   => 'TYPE_NORMAL',
Chris@0:             Use_::TYPE_FUNCTION => 'TYPE_FUNCTION',
Chris@0:             Use_::TYPE_CONSTANT => 'TYPE_CONSTANT',
Chris@0:         ];
Chris@0: 
Chris@0:         if (!isset($map[$type])) {
Chris@0:             return $type;
Chris@0:         }
Chris@0:         return $map[$type] . ' (' . $type . ')';
Chris@0:     }
Chris@0: 
Chris@13:     /**
Chris@13:      * Dump node position, if possible.
Chris@13:      *
Chris@13:      * @param Node $node Node for which to dump position
Chris@13:      *
Chris@13:      * @return string|null Dump of position, or null if position information not available
Chris@13:      */
Chris@0:     protected function dumpPosition(Node $node) {
Chris@0:         if (!$node->hasAttribute('startLine') || !$node->hasAttribute('endLine')) {
Chris@0:             return null;
Chris@0:         }
Chris@0: 
Chris@13:         $start = $node->getStartLine();
Chris@13:         $end = $node->getEndLine();
Chris@0:         if ($node->hasAttribute('startFilePos') && $node->hasAttribute('endFilePos')
Chris@0:             && null !== $this->code
Chris@0:         ) {
Chris@13:             $start .= ':' . $this->toColumn($this->code, $node->getStartFilePos());
Chris@13:             $end .= ':' . $this->toColumn($this->code, $node->getEndFilePos());
Chris@0:         }
Chris@0:         return "[$start - $end]";
Chris@0:     }
Chris@0: 
Chris@0:     // Copied from Error class
Chris@0:     private function toColumn($code, $pos) {
Chris@0:         if ($pos > strlen($code)) {
Chris@0:             throw new \RuntimeException('Invalid position information');
Chris@0:         }
Chris@0: 
Chris@0:         $lineStartPos = strrpos($code, "\n", $pos - strlen($code));
Chris@0:         if (false === $lineStartPos) {
Chris@0:             $lineStartPos = -1;
Chris@0:         }
Chris@0: 
Chris@0:         return $pos - $lineStartPos;
Chris@0:     }
Chris@0: }