Allow nodes to have custom attributes

phpstan · Mar 18, 2021 · cfe3c78 · cfe3c78
1 parent 37a74df
commit cfe3c78
Show file tree

Hide file tree

Showing 44 changed files with 243 additions and 0 deletions.
diff --git a/src/Ast/ConstExpr/ConstExprArrayItemNode.php b/src/Ast/ConstExpr/ConstExprArrayItemNode.php
@@ -2,9 +2,13 @@
 
 namespace PHPStan\PhpDocParser\Ast\ConstExpr;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
+
 class ConstExprArrayItemNode implements ConstExprNode
 {
 
+	use NodeAttributes;
+
 	/** @var ConstExprNode|null */
 	public $key;
 

diff --git a/src/Ast/ConstExpr/ConstExprArrayNode.php b/src/Ast/ConstExpr/ConstExprArrayNode.php
@@ -2,9 +2,13 @@
 
 namespace PHPStan\PhpDocParser\Ast\ConstExpr;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
+
 class ConstExprArrayNode implements ConstExprNode
 {
 
+	use NodeAttributes;
+
 	/** @var ConstExprArrayItemNode[] */
 	public $items;
 

diff --git a/src/Ast/ConstExpr/ConstExprFalseNode.php b/src/Ast/ConstExpr/ConstExprFalseNode.php
@@ -2,9 +2,13 @@
 
 namespace PHPStan\PhpDocParser\Ast\ConstExpr;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
+
 class ConstExprFalseNode implements ConstExprNode
 {
 
+	use NodeAttributes;
+
 	public function __toString(): string
 	{
 		return 'false';

diff --git a/src/Ast/ConstExpr/ConstExprFloatNode.php b/src/Ast/ConstExpr/ConstExprFloatNode.php
@@ -2,9 +2,13 @@
 
 namespace PHPStan\PhpDocParser\Ast\ConstExpr;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
+
 class ConstExprFloatNode implements ConstExprNode
 {
 
+	use NodeAttributes;
+
 	/** @var string */
 	public $value;
 

diff --git a/src/Ast/ConstExpr/ConstExprIntegerNode.php b/src/Ast/ConstExpr/ConstExprIntegerNode.php
@@ -2,9 +2,13 @@
 
 namespace PHPStan\PhpDocParser\Ast\ConstExpr;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
+
 class ConstExprIntegerNode implements ConstExprNode
 {
 
+	use NodeAttributes;
+
 	/** @var string */
 	public $value;
 

diff --git a/src/Ast/ConstExpr/ConstExprNullNode.php b/src/Ast/ConstExpr/ConstExprNullNode.php
@@ -2,9 +2,13 @@
 
 namespace PHPStan\PhpDocParser\Ast\ConstExpr;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
+
 class ConstExprNullNode implements ConstExprNode
 {
 
+	use NodeAttributes;
+
 	public function __toString(): string
 	{
 		return 'null';

diff --git a/src/Ast/ConstExpr/ConstExprStringNode.php b/src/Ast/ConstExpr/ConstExprStringNode.php
@@ -2,9 +2,13 @@
 
 namespace PHPStan\PhpDocParser\Ast\ConstExpr;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
+
 class ConstExprStringNode implements ConstExprNode
 {
 
+	use NodeAttributes;
+
 	/** @var string */
 	public $value;
 

diff --git a/src/Ast/ConstExpr/ConstExprTrueNode.php b/src/Ast/ConstExpr/ConstExprTrueNode.php
@@ -2,9 +2,13 @@
 
 namespace PHPStan\PhpDocParser\Ast\ConstExpr;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
+
 class ConstExprTrueNode implements ConstExprNode
 {
 
+	use NodeAttributes;
+
 	public function __toString(): string
 	{
 		return 'true';

diff --git a/src/Ast/ConstExpr/ConstFetchNode.php b/src/Ast/ConstExpr/ConstFetchNode.php
@@ -2,9 +2,13 @@
 
 namespace PHPStan\PhpDocParser\Ast\ConstExpr;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
+
 class ConstFetchNode implements ConstExprNode
 {
 
+	use NodeAttributes;
+
 	/** @var string class name for class constants or empty string for non-class constants */
 	public $className;
 

diff --git a/src/Ast/Node.php b/src/Ast/Node.php
@@ -7,4 +7,18 @@ interface Node
 
 	public function __toString(): string;
 
+	/**
+	 * @param string $key
+	 * @param mixed $value
+	 */
+	public function setAttribute(string $key, $value): void;
+
+	public function hasAttribute(string $key): bool;
+
+	/**
+	 * @param string $key
+	 * @return mixed
+	 */
+	public function getAttribute(string $key);
+
 }
diff --git a/src/Ast/NodeAttributes.php b/src/Ast/NodeAttributes.php
@@ -0,0 +1,38 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\PhpDocParser\Ast;
+
+trait NodeAttributes
+{
+
+	/** @var array<string, mixed> */
+	private $attributes = [];
+
+	/**
+	 * @param string $key
+	 * @param mixed $value
+	 */
+	public function setAttribute(string $key, $value): void
+	{
+		$this->attributes[$key] = $value;
+	}
+
+	public function hasAttribute(string $key): bool
+	{
+		return array_key_exists($key, $this->attributes);
+	}
+
+	/**
+	 * @param string $key
+	 * @return mixed
+	 */
+	public function getAttribute(string $key)
+	{
+		if ($this->hasAttribute($key)) {
+			return $this->attributes[$key];
+		}
+
+		return null;
+	}
+
+}
diff --git a/src/Ast/PhpDoc/DeprecatedTagValueNode.php b/src/Ast/PhpDoc/DeprecatedTagValueNode.php
@@ -2,9 +2,13 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
+
 class DeprecatedTagValueNode implements PhpDocTagValueNode
 {
 
+	use NodeAttributes;
+
 	/** @var string (may be empty) */
 	public $description;
 

diff --git a/src/Ast/PhpDoc/ExtendsTagValueNode.php b/src/Ast/PhpDoc/ExtendsTagValueNode.php
@@ -2,11 +2,14 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
 use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
 
 class ExtendsTagValueNode implements PhpDocTagValueNode
 {
 
+	use NodeAttributes;
+
 	/** @var GenericTypeNode */
 	public $type;
 

diff --git a/src/Ast/PhpDoc/GenericTagValueNode.php b/src/Ast/PhpDoc/GenericTagValueNode.php
@@ -2,9 +2,13 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
+
 class GenericTagValueNode implements PhpDocTagValueNode
 {
 
+	use NodeAttributes;
+
 	/** @var string (may be empty) */
 	public $value;
 

diff --git a/src/Ast/PhpDoc/ImplementsTagValueNode.php b/src/Ast/PhpDoc/ImplementsTagValueNode.php
@@ -2,11 +2,14 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
 use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
 
 class ImplementsTagValueNode implements PhpDocTagValueNode
 {
 
+	use NodeAttributes;
+
 	/** @var GenericTypeNode */
 	public $type;
 

diff --git a/src/Ast/PhpDoc/InvalidTagValueNode.php b/src/Ast/PhpDoc/InvalidTagValueNode.php
@@ -2,9 +2,13 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
+
 class InvalidTagValueNode implements PhpDocTagValueNode
 {
 
+	use NodeAttributes;
+
 	/** @var string (may be empty) */
 	public $value;
 

diff --git a/src/Ast/PhpDoc/MethodTagValueNode.php b/src/Ast/PhpDoc/MethodTagValueNode.php
@@ -2,11 +2,14 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 
 class MethodTagValueNode implements PhpDocTagValueNode
 {
 
+	use NodeAttributes;
+
 	/** @var bool */
 	public $isStatic;
 

diff --git a/src/Ast/PhpDoc/MethodTagValueParameterNode.php b/src/Ast/PhpDoc/MethodTagValueParameterNode.php
@@ -4,11 +4,14 @@
 
 use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprNode;
 use PHPStan\PhpDocParser\Ast\Node;
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 
 class MethodTagValueParameterNode implements Node
 {
 
+	use NodeAttributes;
+
 	/** @var TypeNode|null */
 	public $type;
 

diff --git a/src/Ast/PhpDoc/MixinTagValueNode.php b/src/Ast/PhpDoc/MixinTagValueNode.php
@@ -2,11 +2,14 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 
 class MixinTagValueNode implements PhpDocTagValueNode
 {
 
+	use NodeAttributes;
+
 	/** @var TypeNode */
 	public $type;
 

diff --git a/src/Ast/PhpDoc/ParamTagValueNode.php b/src/Ast/PhpDoc/ParamTagValueNode.php
@@ -2,11 +2,14 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 
 class ParamTagValueNode implements PhpDocTagValueNode
 {
 
+	use NodeAttributes;
+
 	/** @var TypeNode */
 	public $type;
 

diff --git a/src/Ast/PhpDoc/PhpDocNode.php b/src/Ast/PhpDoc/PhpDocNode.php
@@ -3,10 +3,13 @@
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
 use PHPStan\PhpDocParser\Ast\Node;
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
 
 class PhpDocNode implements Node
 {
 
+	use NodeAttributes;
+
 	/** @var PhpDocChildNode[] */
 	public $children;
 

diff --git a/src/Ast/PhpDoc/PhpDocTagNode.php b/src/Ast/PhpDoc/PhpDocTagNode.php
@@ -2,9 +2,13 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
+
 class PhpDocTagNode implements PhpDocChildNode
 {
 
+	use NodeAttributes;
+
 	/** @var string */
 	public $name;
 

diff --git a/src/Ast/PhpDoc/PhpDocTextNode.php b/src/Ast/PhpDoc/PhpDocTextNode.php
@@ -2,9 +2,13 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
+
 class PhpDocTextNode implements PhpDocChildNode
 {
 
+	use NodeAttributes;
+
 	/** @var string */
 	public $text;
 

diff --git a/src/Ast/PhpDoc/PropertyTagValueNode.php b/src/Ast/PhpDoc/PropertyTagValueNode.php
@@ -2,11 +2,14 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 
 class PropertyTagValueNode implements PhpDocTagValueNode
 {
 
+	use NodeAttributes;
+
 	/** @var TypeNode */
 	public $type;
 

diff --git a/src/Ast/PhpDoc/ReturnTagValueNode.php b/src/Ast/PhpDoc/ReturnTagValueNode.php
@@ -2,11 +2,14 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 
 class ReturnTagValueNode implements PhpDocTagValueNode
 {
 
+	use NodeAttributes;
+
 	/** @var TypeNode */
 	public $type;