add inline sourceMaps support

Author: Nicolas FRANÇOIS

src/Block.php

@@ -28,6 +28,11 @@ class Block
      */
     public $parent;
 
+    /**
+     * @var string;
+     */
+    public $sourceName;
+
     /**
      * @var integer
      */

src/Compiler.php

@@ -18,6 +18,7 @@
 use Leafo\ScssPhp\Exception\CompilerException;
 use Leafo\ScssPhp\Formatter\OutputBlock;
 use Leafo\ScssPhp\Node;
+use Leafo\ScssPhp\SourceMap\SourceMapGenerator;
 use Leafo\ScssPhp\Type;
 use Leafo\ScssPhp\Parser;
 use Leafo\ScssPhp\Util;
@@ -64,6 +65,9 @@ class Compiler
     const WITH_SUPPORTS = 4;
     const WITH_ALL      = 7;
 
+    const SOURCE_MAP_NONE = 0;
+    const SOURCE_MAP_INLINE = 1;
+
     /**
      * @var array
      */
@@ -120,11 +124,16 @@ class Compiler
     protected $encoding = null;
     protected $lineNumberStyle = null;
 
+    protected $sourceMap = self::SOURCE_MAP_NONE;
+    protected $sourceMapOptions = [];
+
+    /** @var string|Formatter */
     protected $formatter = 'Leafo\ScssPhp\Formatter\Nested';
 
     protected $rootEnv;
     protected $rootBlock;
 
+    /** @var  Environment */
     protected $env;
     protected $scope;
     protected $storeEnv;
@@ -191,8 +200,21 @@ public function compile($code, $path = null)
         $this->compileRoot($tree);
         $this->popEnv();
 
-        $out = $this->formatter->format($this->scope);
+        $sourceMapGenerator = null;
+        if($this->sourceMap &&  $this->sourceMap !== self::SOURCE_MAP_NONE) {
+            $sourceMapGenerator = new SourceMapGenerator($this->sourceMapOptions);
+        }
+        $out = $this->formatter->format($this->scope, $sourceMapGenerator);
+        if($this->sourceMap &&  $this->sourceMap !== self::SOURCE_MAP_NONE) {
+            $sourceMap = $sourceMapGenerator->generateJson();
+
+            $sourceMapUrl = null;
+            if($this->sourceMap == self::SOURCE_MAP_INLINE) {
+                $sourceMapUrl = sprintf('data:application/json,%s', self::encodeURIComponent($sourceMap));
+            }
 
+            $out .= sprintf('/*# sourceMappingURL=%s */', $sourceMapUrl);
+        }
         return $out;
     }
 
@@ -274,6 +296,9 @@ protected function makeOutputBlock($type, $selectors = null)
         $out->parent    = $this->scope;
         $out->selectors = $selectors;
         $out->depth     = $this->env->depth;
+        $out->sourceName = $this->env->block->sourceName;
+        $out->sourceLine = $this->env->block->sourceLine;
+        $out->sourceColumn = $this->env->block->sourceColumn;
 
         return $out;
     }
@@ -656,6 +681,7 @@ protected function compileMedia(Block $media)
 
             if ($needsWrap) {
                 $wrapped = new Block;
+                $wrapped->sourceName = $media->sourceName;
                 $wrapped->sourceIndex  = $media->sourceIndex;
                 $wrapped->sourceLine   = $media->sourceLine;
                 $wrapped->sourceColumn = $media->sourceColumn;
@@ -729,6 +755,7 @@ protected function compileAtRoot(Block $block)
         // wrap inline selector
         if ($block->selector) {
             $wrapped = new Block;
+            $wrapped->sourceName   = $block->sourceName;
             $wrapped->sourceIndex  = $block->sourceIndex;
             $wrapped->sourceLine   = $block->sourceLine;
             $wrapped->sourceColumn = $block->sourceColumn;
@@ -785,6 +812,7 @@ private function spliceTree($envs, Block $block, $without)
             }
 
             $b = new Block;
+            $b->sourceName   = $e->block->sourceName;
             $b->sourceIndex  = $e->block->sourceIndex;
             $b->sourceLine   = $e->block->sourceLine;
             $b->sourceColumn = $e->block->sourceColumn;
@@ -1076,6 +1104,13 @@ protected function evalSelectors($selectors)
         return $selectors;
     }
 
+    /**
+     * @param array $sourceMapOptions
+     */
+    public function setSourceMapOptions($sourceMapOptions) {
+        $this->sourceMapOptions = $sourceMapOptions;
+    }
+
     /**
      * Evaluate selector
      *
@@ -3299,6 +3334,13 @@ public function setLineNumberStyle($lineNumberStyle)
         $this->lineNumberStyle = $lineNumberStyle;
     }
 
+    /**
+     * @param int $sourceMap
+     */
+    public function setSourceMap($sourceMap) {
+        $this->sourceMap = $sourceMap;
+    }
+
     /**
      * Register function
      *
@@ -5256,4 +5298,9 @@ protected function libInspect($args)
 
         return $args[0];
     }
+
+    public static function encodeURIComponent($string){
+        $revert = array('%21' => '!', '%2A' => '*', '%27' => "'", '%28' => '(', '%29' => ')');
+        return strtr(rawurlencode($string), $revert);
+    }
 }

src/Formatter.php

@@ -12,6 +12,7 @@
 namespace Leafo\ScssPhp;
 
 use Leafo\ScssPhp\Formatter\OutputBlock;
+use Leafo\ScssPhp\SourceMap\SourceMapGenerator;
 
 /**
  * Base formatter
@@ -56,10 +57,31 @@ abstract class Formatter
     public $assignSeparator;
 
     /**
-     * @var boolea
+     * @var boolean
      */
     public $keepSemicolons;
 
+    /**
+     * @var OutputBlock;
+     */
+    protected $currentBlock;
+
+
+    /**
+     * @var int
+     */
+    protected $currentLine;
+
+    /**
+     * @var int;
+     */
+    protected $currentColumn;
+
+    /**
+     * @var SourceMapGenerator
+     */
+    protected $sourceMapGenerator;
+
     /**
      * Initialize formatter
      *
@@ -123,10 +145,10 @@ protected function blockLines(OutputBlock $block)
 
         $glue = $this->break . $inner;
 
-        echo $inner . implode($glue, $block->lines);
+        $this->write($inner . implode($glue, $block->lines));
 
         if (! empty($block->children)) {
-            echo $this->break;
+            $this->write($this->break);
         }
     }
 
@@ -139,9 +161,9 @@ protected function blockSelectors(OutputBlock $block)
     {
         $inner = $this->indentStr();
 
-        echo $inner
+        $this->write($inner
             . implode($this->tagSeparator, $block->selectors)
-            . $this->open . $this->break;
+            . $this->open . $this->break);
     }
 
     /**
@@ -167,6 +189,8 @@ protected function block(OutputBlock $block)
             return;
         }
 
+        $this->currentBlock = $block;
+
         $pre = $this->indentStr();
 
         if (! empty($block->selectors)) {
@@ -187,10 +211,10 @@ protected function block(OutputBlock $block)
             $this->indentLevel--;
 
             if (empty($block->children)) {
-                echo $this->break;
+                $this->write($this->break);
             }
 
-            echo $pre . $this->close . $this->break;
+            $this->write($pre . $this->close . $this->break);
         }
     }
 
@@ -201,10 +225,19 @@ protected function block(OutputBlock $block)
      *
      * @param \Leafo\ScssPhp\Formatter\OutputBlock $block An abstract syntax tree
      *
+     * @param SourceMapGenerator|null $sourceMapGenerator
      * @return string
+     * @internal param bool $collectSourceMap
      */
-    public function format(OutputBlock $block)
+    public function format(OutputBlock $block, SourceMapGenerator $sourceMapGenerator = null)
     {
+        if($sourceMapGenerator) {
+            $this->currentLine = 1;
+            $this->currentColumn = 0;
+            $this->sourceMapGenerator = $sourceMapGenerator;
+        } else {
+            $this->sourceMapGenerator = null;
+        }
         ob_start();
 
         $this->block($block);
@@ -213,4 +246,32 @@ public function format(OutputBlock $block)
 
         return $out;
     }
+
+    /**
+     * @param $str
+     */
+    protected function write($str) {
+        if($this->sourceMapGenerator) {
+            $this->sourceMapGenerator->addMapping(
+                $this->currentLine,
+                $this->currentColumn,
+                $this->currentBlock->sourceLine,
+                $this->currentBlock->sourceColumn,
+                $this->currentBlock->sourceName
+            );
+
+            $lines = explode("\n", $str);
+            $lineCount = count($lines);
+            $this->currentLine += $lineCount-1;
+
+            $lastLine = array_pop($lines);
+            if($lineCount == 1) {
+                $this->currentColumn += mb_strlen($lastLine);
+            } else {
+                $this->currentColumn = mb_strlen($lastLine);
+            }
+        }
+
+        echo $str;
+    }
 }

src/Formatter/Compressed.php

@@ -53,10 +53,10 @@ public function blockLines(OutputBlock $block)
             }
         }
 
-        echo $inner . implode($glue, $block->lines);
+        $this->write( $inner . implode($glue, $block->lines));
 
         if (! empty($block->children)) {
-            echo $this->break;
+            $this->write( $this->break);
         }
     }
 }

src/Formatter/Crunched.php

@@ -51,10 +51,10 @@ public function blockLines(OutputBlock $block)
             }
         }
 
-        echo $inner . implode($glue, $block->lines);
+        $this->write($inner . implode($glue, $block->lines));
 
         if (! empty($block->children)) {
-            echo $this->break;
+            $this->write($this->break);
         }
     }
 }

src/Formatter/Debug.php

@@ -52,13 +52,13 @@ protected function blockLines(OutputBlock $block)
         $indent = $this->indentStr();
 
         if (empty($block->lines)) {
-            echo "{$indent}block->lines: []\n";
+            $this->write("{$indent}block->lines: []\n");
 
             return;
         }
 
         foreach ($block->lines as $index => $line) {
-            echo "{$indent}block->lines[{$index}]: $line\n";
+            $this->write( "{$indent}block->lines[{$index}]: $line\n");
         }
     }
 
@@ -70,13 +70,13 @@ protected function blockSelectors(OutputBlock $block)
         $indent = $this->indentStr();
 
         if (empty($block->selectors)) {
-            echo "{$indent}block->selectors: []\n";
+            $this->write( "{$indent}block->selectors: []\n");
 
             return;
         }
 
         foreach ($block->selectors as $index => $selector) {
-            echo "{$indent}block->selectors[{$index}]: $selector\n";
+            $this->write( "{$indent}block->selectors[{$index}]: $selector\n");
         }
     }
 
@@ -88,7 +88,7 @@ protected function blockChildren(OutputBlock $block)
         $indent = $this->indentStr();
 
         if (empty($block->children)) {
-            echo "{$indent}block->children: []\n";
+            $this->write( "{$indent}block->children: []\n");
 
             return;
         }
@@ -109,8 +109,10 @@ protected function block(OutputBlock $block)
     {
         $indent = $this->indentStr();
 
-        echo "{$indent}block->type: {$block->type}\n" .
-             "{$indent}block->depth: {$block->depth}\n";
+        $this->write( "{$indent}block->type: {$block->type}\n" .
+             "{$indent}block->depth: {$block->depth}\n");
+
+        $this->currentBlock = $block;
 
         $this->blockSelectors($block);
         $this->blockLines($block);

src/Formatter/Expanded.php

@@ -59,10 +59,10 @@ protected function blockLines(OutputBlock $block)
             }
         }
 
-        echo $inner . implode($glue, $block->lines);
+        $this->write($inner . implode($glue, $block->lines));
 
         if (empty($block->selectors) || ! empty($block->children)) {
-            echo $this->break;
+            $this->write($this->break);
         }
     }
 }