Merge pull request #572 from stof/stringable_ast

Make AST nodes castable to string
scssphp · May 12, 2022 · e4dbc63 · e4dbc63
2 parents 2e77caa + 7b5838d
commit e4dbc63
Show file tree

Hide file tree

Showing 59 changed files with 524 additions and 7 deletions.
diff --git a/src/Ast/AstNode.php b/src/Ast/AstNode.php
@@ -22,4 +22,6 @@
 interface AstNode
 {
     public function getSpan(): FileSpan;
+
+    public function __toString(): string;
 }
diff --git a/src/Ast/Css/CssValue.php b/src/Ast/Css/CssValue.php
@@ -59,4 +59,13 @@ public function getSpan(): FileSpan
     {
         return $this->span;
     }
+
+    public function __toString(): string
+    {
+        if (\is_array($this->value)) {
+            return implode($this->value);
+        }
+
+        return (string) $this->value;
+    }
 }
diff --git a/src/Ast/Css/ModifiableCssNode.php b/src/Ast/Css/ModifiableCssNode.php
@@ -12,6 +12,7 @@
 
 namespace ScssPhp\ScssPhp\Ast\Css;
 
+use ScssPhp\ScssPhp\Serializer\Serializer;
 use ScssPhp\ScssPhp\Visitor\ModifiableCssVisitor;
 
 /**
@@ -161,4 +162,9 @@ public function remove(): void
         $this->parent = null;
         $this->indexInParent = null;
     }
+
+    public function __toString(): string
+    {
+        return Serializer::serialize($this, true)->getCss();
+    }
 }
diff --git a/src/Ast/Sass/Argument.php b/src/Ast/Sass/Argument.php
@@ -70,4 +70,13 @@ public function getSpan(): FileSpan
     {
         return $this->span;
     }
+
+    public function __toString(): string
+    {
+        if ($this->defaultValue === null) {
+            return $this->name;
+        }
+
+        return $this->name . ': ' . $this->defaultValue;
+    }
 }
diff --git a/src/Ast/Sass/ArgumentDeclaration.php b/src/Ast/Sass/ArgumentDeclaration.php
@@ -78,4 +78,17 @@ public function getSpan(): FileSpan
     {
         return $this->span;
     }
+
+    public function __toString(): string
+    {
+        $parts = [];
+        foreach ($this->arguments as $arg) {
+            $parts[] = "\$$arg";
+        }
+        if ($this->restArgument !== null) {
+            $parts[] = "\$$this->restArgument...";
+        }
+
+        return implode(', ', $parts);
+    }
 }
diff --git a/src/Ast/Sass/ArgumentInvocation.php b/src/Ast/Sass/ArgumentInvocation.php
@@ -108,4 +108,20 @@ public function getSpan(): FileSpan
     {
         return $this->span;
     }
+
+    public function __toString(): string
+    {
+        $parts = $this->positional;
+        foreach ($this->named as $name => $arg) {
+            $parts[] = "\$$name: $arg";
+        }
+        if ($this->rest !== null) {
+            $parts[] = "$this->rest...";
+        }
+        if ($this->keywordRest !== null) {
+            $parts[] = "$this->keywordRest...";
+        }
+
+        return '(' . implode(', ', $parts) . ')';
+    }
 }
diff --git a/src/Ast/Sass/ConfiguredVariable.php b/src/Ast/Sass/ConfiguredVariable.php
@@ -78,4 +78,9 @@ public function getNameSpan(): FileSpan
     {
         return SpanUtil::initialIdentifier($this->span, 1);
     }
+
+    public function __toString(): string
+    {
+        return '$' . $this->name . ': ' . $this->expression . ($this->guarded ? ' !default' : '');
+    }
 }
diff --git a/src/Ast/Sass/Expression/BinaryOperationExpression.php b/src/Ast/Sass/Expression/BinaryOperationExpression.php
@@ -116,4 +116,33 @@ public function accept(ExpressionVisitor $visitor)
     {
         return $visitor->visitBinaryOperationExpression($this);
     }
+
+    public function __toString(): string
+    {
+        $buffer = '';
+
+        $leftNeedsParens = $this->left instanceof BinaryOperationExpression && BinaryOperator::getPrecedence($this->left->getOperator()) < BinaryOperator::getPrecedence($this->operator);
+        if ($leftNeedsParens) {
+            $buffer .= '(';
+        }
+        $buffer .= $this->left;
+        if ($leftNeedsParens) {
+            $buffer .= ')';
+        }
+
+        $buffer .= ' ';
+        $buffer .= $this->operator;
+        $buffer .= ' ';
+
+        $rightNeedsParens = $this->right instanceof BinaryOperationExpression && BinaryOperator::getPrecedence($this->right->getOperator()) <= BinaryOperator::getPrecedence($this->operator);
+        if ($rightNeedsParens) {
+            $buffer .= '(';
+        }
+        $buffer .= $this->right;
+        if ($rightNeedsParens) {
+            $buffer .= ')';
+        }
+
+        return $buffer;
+    }
 }
diff --git a/src/Ast/Sass/Expression/BooleanExpression.php b/src/Ast/Sass/Expression/BooleanExpression.php
@@ -55,4 +55,9 @@ public function accept(ExpressionVisitor $visitor)
     {
         return $visitor->visitBooleanExpression($this);
     }
+
+    public function __toString(): string
+    {
+        return $this->value ? 'true' : 'false';
+    }
 }
diff --git a/src/Ast/Sass/Expression/CalculationExpression.php b/src/Ast/Sass/Expression/CalculationExpression.php
@@ -227,4 +227,9 @@ private static function verify(Expression $expression): void
 
         throw new \InvalidArgumentException('Invalid calculation argument.');
     }
+
+    public function __toString(): string
+    {
+        return $this->name . '(' . implode(', ', $this->arguments) . ')';
+    }
 }
diff --git a/src/Ast/Sass/Expression/ColorExpression.php b/src/Ast/Sass/Expression/ColorExpression.php
@@ -56,4 +56,9 @@ public function accept(ExpressionVisitor $visitor)
     {
         return $visitor->visitColorExpression($this);
     }
+
+    public function __toString(): string
+    {
+        return (string) $this->value;
+    }
 }
diff --git a/src/Ast/Sass/Expression/FunctionExpression.php b/src/Ast/Sass/Expression/FunctionExpression.php
@@ -125,4 +125,17 @@ public function accept(ExpressionVisitor $visitor)
     {
         return $visitor->visitFunctionExpression($this);
     }
+
+    public function __toString(): string
+    {
+        $buffer = '';
+
+        if ($this->namespace !== null) {
+            $buffer .= $this->namespace . '.';
+        }
+
+        $buffer .= $this->originalName . $this->arguments;
+
+        return $buffer;
+    }
 }
diff --git a/src/Ast/Sass/Expression/IfExpression.php b/src/Ast/Sass/Expression/IfExpression.php
@@ -63,4 +63,9 @@ public function accept(ExpressionVisitor $visitor)
     {
         return $visitor->visitIfExpression($this);
     }
+
+    public function __toString(): string
+    {
+        return 'if' . $this->arguments;
+    }
 }
diff --git a/src/Ast/Sass/Expression/InterpolatedFunctionExpression.php b/src/Ast/Sass/Expression/InterpolatedFunctionExpression.php
@@ -76,4 +76,9 @@ public function accept(ExpressionVisitor $visitor)
     {
         return $visitor->visitInterpolatedFunctionExpression($this);
     }
+
+    public function __toString(): string
+    {
+        return $this->name . $this->arguments;
+    }
 }
diff --git a/src/Ast/Sass/Expression/ListExpression.php b/src/Ast/Sass/Expression/ListExpression.php
@@ -92,4 +92,51 @@ public function accept(ExpressionVisitor $visitor)
     {
         return $visitor->visitListExpression($this);
     }
+
+    public function __toString(): string
+    {
+        $buffer = '';
+        if ($this->hasBrackets()) {
+            $buffer .= '[';
+        }
+
+        $buffer .= implode($this->separator === ListSeparator::COMMA ? ', ' : ' ', array_map(function ($element) {
+            return $this->elementNeedsParens($element) ? "($element)" : (string) $element;
+        }, $this->contents));
+
+        if ($this->hasBrackets()) {
+            $buffer .= ']';
+        }
+
+        return $buffer;
+    }
+
+    /**
+     * Returns whether $expression, contained in $this, needs parentheses when
+     * printed as Sass source.
+     */
+    private function elementNeedsParens(Expression $expression): bool
+    {
+        if ($expression instanceof ListExpression) {
+            if (\count($expression->contents) < 2) {
+                return false;
+            }
+
+            if ($expression->brackets) {
+                return false;
+            }
+
+            return $this->separator === ListSeparator::COMMA ? $expression->separator === ListSeparator::COMMA : $expression->separator !== ListSeparator::UNDECIDED;
+        }
+
+        if ($this->separator !== ListSeparator::SPACE) {
+            return false;
+        }
+
+        if ($expression instanceof UnaryOperationExpression) {
+            return $expression->getOperator() === UnaryOperator::PLUS || $expression->getOperator() === UnaryOperator::MINUS;
+        }
+
+        return false;
+    }
 }
diff --git a/src/Ast/Sass/Expression/MapExpression.php b/src/Ast/Sass/Expression/MapExpression.php
@@ -61,4 +61,11 @@ public function accept(ExpressionVisitor $visitor)
     {
         return $visitor->visitMapExpression($this);
     }
+
+    public function __toString(): string
+    {
+        return '(' . implode(', ', array_map(function ($pair) {
+            return $pair[0] . ': ' . $pair[1];
+        }, $this->pairs)) . ')';
+    }
 }
diff --git a/src/Ast/Sass/Expression/NullExpression.php b/src/Ast/Sass/Expression/NullExpression.php
@@ -43,4 +43,9 @@ public function accept(ExpressionVisitor $visitor)
     {
         return $visitor->visitNullExpression($this);
     }
+
+    public function __toString(): string
+    {
+        return 'null';
+    }
 }
diff --git a/src/Ast/Sass/Expression/NumberExpression.php b/src/Ast/Sass/Expression/NumberExpression.php
@@ -73,4 +73,9 @@ public function accept(ExpressionVisitor $visitor)
     {
         return $visitor->visitNumberExpression($this);
     }
+
+    public function __toString(): string
+    {
+        return $this->value . ($this->unit ?? '');
+    }
 }
diff --git a/src/Ast/Sass/Expression/ParenthesizedExpression.php b/src/Ast/Sass/Expression/ParenthesizedExpression.php
@@ -55,4 +55,9 @@ public function accept(ExpressionVisitor $visitor)
     {
         return $visitor->visitParenthesizedExpression($this);
     }
+
+    public function __toString(): string
+    {
+        return '(' . $this->expression . ')';
+    }
 }
diff --git a/src/Ast/Sass/Expression/SelectorExpression.php b/src/Ast/Sass/Expression/SelectorExpression.php
@@ -43,4 +43,9 @@ public function accept(ExpressionVisitor $visitor)
     {
         return $visitor->visitSelectorExpression($this);
     }
+
+    public function __toString(): string
+    {
+        return '&';
+    }
 }
diff --git a/src/Ast/Sass/Expression/StringExpression.php b/src/Ast/Sass/Expression/StringExpression.php
@@ -52,6 +52,20 @@ public static function plain(string $text, FileSpan $span, bool $quotes = false)
         return new self(new Interpolation([$text], $span), $quotes);
     }
 
+    /**
+     * Returns Sass source for a quoted string that, when evaluated, will have
+     * $text as its contents.
+     */
+    public static function quoteText(string $text): string
+    {
+        $quote = self::bestQuote([$text]);
+        $buffer = $quote;
+        $buffer .= self::quoteInnerText($text, $quote, true);
+        $buffer .= $quote;
+
+        return $buffer;
+    }
+
     public function getText(): Interpolation
     {
         return $this->text;
@@ -87,7 +101,7 @@ public function asInterpolation(bool $static = false, string $quote = null): Int
             if ($value instanceof Expression) {
                 $buffer->add($value);
             } else {
-                self::quoteInnerText($value, $quote, $buffer, $static);
+                $buffer->write(self::quoteInnerText($value, $quote, $static));
             }
         }
 
@@ -96,41 +110,43 @@ public function asInterpolation(bool $static = false, string $quote = null): Int
         return $buffer->buildInterpolation($this->text->getSpan());
     }
 
-    private static function quoteInnerText(string $value, string $quote, InterpolationBuffer $buffer, bool $static = false): void
+    private static function quoteInnerText(string $value, string $quote, bool $static = false): string
     {
+        $buffer = '';
         $length = \strlen($value);
 
         for ($i = 0; $i < $length; $i++) {
             $char = $value[$i];
 
             if (Character::isNewline($char)) {
-                $buffer->write('\\a');
+                $buffer .= '\\a';
 
                 if ($i !== $length - 1) {
                     $next = $value[$i + 1];
 
                     if (Character::isWhitespace($next) || Character::isHex($next)) {
-                        $buffer->write(' ');
+                        $buffer .= ' ';
                     }
                 }
             } else {
                 if ($char === $quote || $char === '\\' || ($static && $char === '#' && $i < $length - 1 && $value[$i + 1] === '{')) {
-                    $buffer->write('\\');
+                    $buffer .= '\\';
                 }
 
                 if (\ord($char) < 0x80) {
-                    $buffer->write($char);
+                    $buffer .= $char;
                 } else {
                     if (!preg_match('/./usA', $value, $m, 0, $i)) {
                         throw new \UnexpectedValueException('Invalid UTF-8 char');
                     }
 
-                    $buffer->write($m[0]);
+                    $buffer .= $m[0];
                     $i += \strlen($m[0]) - 1; // skip over the extra bytes that have been processed.
                 }
             }
         }
 
+        return $buffer;
     }
 
     /**
@@ -158,4 +174,9 @@ private static function bestQuote(array $parts): string
 
         return $containsDoubleQuote ? "'": '"';
     }
+
+    public function __toString(): string
+    {
+        return (string) $this->asInterpolation();
+    }
 }