diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000..31dd6aa4 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,14 @@ +root = true + +[*] +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +charset = utf-8 + +[Makefile] +indent_style = tab + +[*.php] +indent_style = space +indent_size = 4 diff --git a/.gitattributes b/.gitattributes index a116ff23..73d1a258 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,4 +1,5 @@ Makefile export-ignore +.editorconfig export-ignore .gitattributes export-ignore .gitignore export-ignore .travis.yml export-ignore diff --git a/.gitignore b/.gitignore index 4ffba003..999984a4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,11 @@ +.idea .sass-cache +scss_cache composer.lock -pscss.phar /*.css /*.scss /_site/ /sass/ /compass/ /vendor/ +/frameworks/ diff --git a/.travis.yml b/.travis.yml index 8c3a2996..ccbbf00b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,16 +2,21 @@ language: php sudo: false php: - - 5.3 - - 5.4 - - 5.5 - 5.6 + - 7.0 + - 7.1 + - 7.2 - nightly - - hhvm + +install: composer install script: - - phpunit tests + - vendor/bin/phpunit tests branches: only: - master + +matrix: + allow_failures: + - php: nightly diff --git a/Makefile b/Makefile index c608f8e1..fb50ffdb 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,8 @@ test: vendor/bin/phpunit --colors tests -phar: - php -dphar.readonly=0 vendor/bin/box build -v +compat: + TEST_SCSS_COMPAT=1 vendor/bin/phpunit --colors tests | tail -2 + +standard: + vendor/bin/phpcs --standard=PSR2 bin src example tests *.php diff --git a/README.md b/README.md index 53a4c7a4..d3fbf154 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,17 @@ -# scssphp -### +# This repo has been archived -[![Build](https://travis-ci.org/leafo/scssphp.svg?branch=master)](http://travis-ci.org/leafo/scssphp) -[![License](https://poser.pugx.org/leafo/scssphp/license.svg)](https://packagist.org/packages/leafo/scssphp) -`scssphp` is a compiler for SCSS written in PHP. +#### Please go to https://github.com/scssphp/scssphp + +---- + +## scssphp -Checkout the homepage, , for directions on how to use. +![License](https://poser.pugx.org/leafo/scssphp/license.svg) + +`scssphp` is a compiler for SCSS written in PHP. -## Running Tests +### Running Tests `scssphp` uses [PHPUnit](https://github.com/sebastianbergmann/phpunit) for testing. @@ -38,7 +41,7 @@ To enable the `scss` compatibility tests: TEST_SCSS_COMPAT=1 vendor/bin/phpunit tests -## Coding Standard +### Coding Standard `scssphp` source conforms to [PSR2](http://www.php-fig.org/psr/psr-2/). diff --git a/bin/pscss b/bin/pscss index 8a21393e..ce80e6a9 100755 --- a/bin/pscss +++ b/bin/pscss @@ -12,8 +12,8 @@ error_reporting(E_ALL); -if (version_compare(PHP_VERSION, '5.3') < 0) { - die('Requires PHP 5.3 or above'); +if (version_compare(PHP_VERSION, '5.4') < 0) { + die('Requires PHP 5.4 or above'); } include __DIR__ . '/../scss.inc.php'; @@ -30,6 +30,9 @@ $inputFile = null; $changeDir = false; $debugInfo = false; $lineNumbers = false; +$ignoreErrors = false; +$encoding = false; +$sourceMap = false; /** * Parse argument @@ -67,14 +70,17 @@ Usage: $exe [options] [input-file] Options include: - --debug-info Annotate selectors with CSS referring to the source file and line number - -h, --help Show this message - -f=format Set the output format (compact, compressed, crunched, expanded, or nested) - -i=path Set import path - --line-numbers Annotate selectors with comments referring to the source file and line number - -p=precision Set decimal number precision (default 5) - -T Dump formatted parse tree - -v, --version Print the version + -h, --help Show this message + --continue-on-error Continue compilation (as best as possible) when error encountered + --debug-info Annotate selectors with CSS referring to the source file and line number + -f=format Set the output format (compact, compressed, crunched, expanded, or nested) + -i=path Set import path + --iso8859-1 Use iso8859-1 encoding instead of utf-8 (default utf-8) + --line-numbers Annotate selectors with comments referring to the source file and line number + -p=precision Set decimal number precision (default 10) + --sourcemap Create source map file + -T Dump formatted parse tree + -v, --version Print the version EOT; exit($HELP); @@ -84,16 +90,31 @@ EOT; exit(Version::VERSION . "\n"); } + if ($argv[$i] === '--continue-on-error') { + $ignoreErrors = true; + continue; + } + if ($argv[$i] === '--debug-info') { $debugInfo = true; continue; } + if ($argv[$i] === '--iso8859-1') { + $encoding = 'iso8859-1'; + continue; + } + if ($argv[$i] === '--line-numbers' || $argv[$i] === '--line-comments') { $lineNumbers = true; continue; } + if ($argv[$i] === '--sourcemap') { + $sourceMap = true; + continue; + } + if ($argv[$i] === '-T') { $dumpTree = true; continue; @@ -146,7 +167,7 @@ if ($inputFile) { } if ($dumpTree) { - $parser = new Parser($inputFile ?: 'STDIN'); + $parser = new Parser($inputFile); print_r(json_decode(json_encode($parser->parse($data)), true)); @@ -155,14 +176,18 @@ if ($dumpTree) { $scss = new Compiler(); -if ($debugInfo && $inputFile) { +if ($debugInfo) { $scss->setLineNumberStyle(Compiler::DEBUG_INFO); } -if ($lineNumbers && $inputFile) { +if ($lineNumbers) { $scss->setLineNumberStyle(Compiler::LINE_COMMENTS); } +if ($ignoreErrors) { + $scss->setIgnoreErrors($ignoreErrors); +} + if ($loadPaths) { $scss->setImportPaths(explode(PATH_SEPARATOR, $loadPaths)); } @@ -175,7 +200,15 @@ if ($style) { $scss->setFormatter('Leafo\\ScssPhp\\Formatter\\' . ucfirst($style)); } -echo $scss->compile($data, $inputFile ?: 'STDIN'); +if ($sourceMap) { + $scss->setSourceMap(Compiler::SOURCE_MAP_INLINE); +} + +if ($encoding) { + $scss->setEncoding($encoding); +} + +echo $scss->compile($data, $inputFile); if ($changeDir) { chdir($oldWorkingDir); diff --git a/box.json.dist b/box.json.dist deleted file mode 100644 index 9e61a65e..00000000 --- a/box.json.dist +++ /dev/null @@ -1,13 +0,0 @@ -{ - "chmod": "0755", - "files": [ - "LICENSE.md", - "classmap.php", - "scss.inc.php" - ], - "directories": ["src"], - "main": "bin/pscss", - "output": "pscss.phar", - "compactors": "Herrera\\Box\\Compactor\\Php", - "stub": true -} diff --git a/classmap.php b/classmap.php deleted file mode 100644 index 2d8a52b8..00000000 --- a/classmap.php +++ /dev/null @@ -1,63 +0,0 @@ -=5.3.0" + "php": "^5.4.0 || ^7" }, "require-dev": { - "squizlabs/php_codesniffer": "~2.3", - "phpunit/phpunit": "~3.7", - "kherge/box": "~2.5" + "squizlabs/php_codesniffer": "~2.5", + "phpunit/phpunit": "~4.6", + "twbs/bootstrap": "~4.3", + "zurb/foundation": "~6.5" }, "bin": ["bin/pscss"], "archive": { @@ -36,9 +36,9 @@ "/.gitattributes", "/.gitignore", "/.travis.yml", - "/box.json.dist", "/phpunit.xml.dist", "/tests" ] - } + }, + "abandoned": "scssphp/scssphp" } diff --git a/src/Server.php b/example/Server.php similarity index 71% rename from src/Server.php rename to example/Server.php index 5bd9bef0..54060b1a 100644 --- a/src/Server.php +++ b/example/Server.php @@ -2,7 +2,7 @@ /** * SCSSPHP * - * @copyright 2012-2015 Leaf Corcoran + * @copyright 2012-2017 Leaf Corcoran * * @license http://opensource.org/licenses/MIT MIT * @@ -12,10 +12,11 @@ namespace Leafo\ScssPhp; use Leafo\ScssPhp\Compiler; +use Leafo\ScssPhp\Exception\ServerException; use Leafo\ScssPhp\Version; /** - * SCSS server + * Server * * @author Leaf Corcoran */ @@ -115,13 +116,12 @@ protected function metadataName($out) /** * Determine whether .scss file needs to be re-compiled. * - * @param string $in Input path * @param string $out Output path * @param string $etag ETag * * @return boolean True if compile required. */ - protected function needsCompile($in, $out, &$etag) + protected function needsCompile($out, &$etag) { if (! is_file($out)) { return true; @@ -129,21 +129,25 @@ protected function needsCompile($in, $out, &$etag) $mtime = filemtime($out); - if (filemtime($in) > $mtime) { - return true; - } - $metadataName = $this->metadataName($out); if (is_readable($metadataName)) { $metadata = unserialize(file_get_contents($metadataName)); - foreach ($metadata['imports'] as $import => $importMtime) { - if ($importMtime > $mtime) { + foreach ($metadata['imports'] as $import => $originalMtime) { + $currentMtime = filemtime($import); + + if ($currentMtime !== $originalMtime || $currentMtime > $mtime) { return true; } } + $metaVars = crc32(serialize($this->scss->getVariables())); + + if ($metaVars !== $metadata['vars']) { + return true; + } + $etag = $metadata['etag']; return false; @@ -203,20 +207,21 @@ protected function compile($in, $out) $elapsed = round((microtime(true) - $start), 4); $v = Version::VERSION; - $t = @date('r'); + $t = gmdate('r'); $css = "/* compiled by scssphp $v on $t (${elapsed}s) */\n\n" . $css; $etag = md5($css); file_put_contents($out, $css); file_put_contents( $this->metadataName($out), - serialize(array( + serialize([ 'etag' => $etag, 'imports' => $this->scss->getParsedFiles(), - )) + 'vars' => crc32(serialize($this->scss->getVariables())), + ]) ); - return array($css, $etag); + return [$css, $etag]; } /** @@ -226,11 +231,11 @@ protected function compile($in, $out) * * @return string */ - protected function createErrorCSS($error) + protected function createErrorCSS(\Exception $error) { $message = str_replace( - array("'", "\n"), - array("\\'", "\\A"), + ["'", "\n"], + ["\\'", "\\A"], $error->getfile() . ":\n\n" . $error->getMessage() ); @@ -264,11 +269,13 @@ public function showErrorsAsCSS($show = true) * @param string $out Output file (.css) optional * * @return string|bool + * + * @throws \Leafo\ScssPhp\Exception\ServerException */ public function compileFile($in, $out = null) { if (! is_readable($in)) { - throw new \Exception('load error: failed to find ' . $in); + throw new ServerException('load error: failed to find ' . $in); } $pi = pathinfo($in); @@ -318,18 +325,17 @@ public function serve($salt = '') $output = $this->cacheName($salt . $input); $etag = $noneMatch = trim($this->getIfNoneMatchHeader(), '"'); - if ($this->needsCompile($input, $output, $etag)) { + if ($this->needsCompile($output, $etag)) { try { list($css, $etag) = $this->compile($input, $output); - $lastModified = gmdate('D, d M Y H:i:s', filemtime($output)) . ' GMT'; + $lastModified = gmdate('r', filemtime($output)); header('Last-Modified: ' . $lastModified); header('Content-type: text/css'); header('ETag: "' . $etag . '"'); echo $css; - } catch (\Exception $e) { if ($this->showErrorsAsCSS) { header('Content-type: text/css'); @@ -341,7 +347,6 @@ public function serve($salt = '') echo 'Parse error: ' . $e->getMessage() . "\n"; } - } return; @@ -360,13 +365,13 @@ public function serve($salt = '') $modifiedSince = $this->getIfModifiedSinceHeader(); $mtime = filemtime($output); - if (@strtotime($modifiedSince) === $mtime) { + if (strtotime($modifiedSince) === $mtime) { header($protocol . ' 304 Not Modified'); return; } - $lastModified = gmdate('D, d M Y H:i:s', $mtime) . ' GMT'; + $lastModified = gmdate('r', $mtime); header('Last-Modified: ' . $lastModified); echo file_get_contents($output); @@ -390,19 +395,19 @@ public function serve($salt = '') * * @return string Compiled CSS results * - * @throws \Exception + * @throws \Leafo\ScssPhp\Exception\ServerException */ public function checkedCachedCompile($in, $out, $force = false) { if (! is_file($in) || ! is_readable($in)) { - throw new \Exception('Invalid or unreadable input file specified.'); + throw new ServerException('Invalid or unreadable input file specified.'); } if (is_dir($out) || ! is_writable(file_exists($out) ? $out : dirname($out))) { - throw new \Exception('Invalid or unwritable output file specified.'); + throw new ServerException('Invalid or unwritable output file specified.'); } - if ($force || $this->needsCompile($in, $out, $etag)) { + if ($force || $this->needsCompile($out, $etag)) { list($css, $etag) = $this->compile($in, $out); } else { $css = file_get_contents($out); @@ -411,6 +416,71 @@ public function checkedCachedCompile($in, $out, $force = false) return $css; } + /** + * Execute scssphp on a .scss file or a scssphp cache structure + * + * The scssphp cache structure contains information about a specific + * scss file having been parsed. It can be used as a hint for future + * calls to determine whether or not a rebuild is required. + * + * The cache structure contains two important keys that may be used + * externally: + * + * compiled: The final compiled CSS + * updated: The time (in seconds) the CSS was last compiled + * + * The cache structure is a plain-ol' PHP associative array and can + * be serialized and unserialized without a hitch. + * + * @param mixed $in Input + * @param boolean $force Force rebuild? + * + * @return array scssphp cache structure + */ + public function cachedCompile($in, $force = false) + { + // assume no root + $root = null; + + if (is_string($in)) { + $root = $in; + } elseif (is_array($in) and isset($in['root'])) { + if ($force or ! isset($in['files'])) { + // If we are forcing a recompile or if for some reason the + // structure does not contain any file information we should + // specify the root to trigger a rebuild. + $root = $in['root']; + } elseif (isset($in['files']) and is_array($in['files'])) { + foreach ($in['files'] as $fname => $ftime) { + if (! file_exists($fname) or filemtime($fname) > $ftime) { + // One of the files we knew about previously has changed + // so we should look at our incoming root again. + $root = $in['root']; + break; + } + } + } + } else { + // TODO: Throw an exception? We got neither a string nor something + // that looks like a compatible lessphp cache structure. + return null; + } + + if ($root !== null) { + // If we have a root value which means we should rebuild. + $out = []; + $out['root'] = $root; + $out['compiled'] = $this->compileFile($root); + $out['files'] = $this->scss->getParsedFiles(); + $out['updated'] = time(); + return $out; + } else { + // No changes, pass back the structure + // we were given initially. + return $in; + } + } + /** * Constructor * @@ -429,7 +499,7 @@ public function __construct($dir, $cacheDir = null, $scss = null) $this->cacheDir = $cacheDir; if (! is_dir($this->cacheDir)) { - mkdir($this->cacheDir, 0755, true); + throw new ServerException('Cache directory doesn\'t exist: ' . $cacheDir); } if (! isset($scss)) { @@ -439,16 +509,7 @@ public function __construct($dir, $cacheDir = null, $scss = null) $this->scss = $scss; $this->showErrorsAsCSS = false; - } - /** - * Helper method to serve compiled scss - * - * @param string $path Root path - */ - public static function serveFrom($path) - { - $server = new self($path); - $server->serve(); + date_default_timezone_set('UTC'); } } diff --git a/scss.inc.php b/scss.inc.php index da641f7c..2a5f0774 100644 --- a/scss.inc.php +++ b/scss.inc.php @@ -1,12 +1,19 @@ */ diff --git a/src/Block.php b/src/Block.php new file mode 100644 index 00000000..41abf01a --- /dev/null +++ b/src/Block.php @@ -0,0 +1,70 @@ + + */ +class Block +{ + /** + * @var string + */ + public $type; + + /** + * @var \Leafo\ScssPhp\Block + */ + public $parent; + + /** + * @var string + */ + public $sourceName; + + /** + * @var integer + */ + public $sourceIndex; + + /** + * @var integer + */ + public $sourceLine; + + /** + * @var integer + */ + public $sourceColumn; + + /** + * @var array + */ + public $selectors; + + /** + * @var array + */ + public $comments; + + /** + * @var array + */ + public $children; + + /** + * @var \Leafo\ScssPhp\Block + */ + public $selfParent; +} diff --git a/src/Cache.php b/src/Cache.php new file mode 100644 index 00000000..49cf631b --- /dev/null +++ b/src/Cache.php @@ -0,0 +1,239 @@ + $lastModified) + && $cacheTime + self::$gcLifetime > time() + ) { + $c = file_get_contents($fileCache); + $c = unserialize($c); + + if (is_array($c) && isset($c['value'])) { + return $c['value']; + } + } + } + + return null; + } + + /** + * Put in cache the result of $operation on $what, + * which is known as dependant from the content of $options + * + * @param string $operation + * @param mixed $what + * @param mixed $value + * @param array $options + */ + public function setCache($operation, $what, $value, $options = []) + { + $fileCache = self::$cacheDir . self::cacheName($operation, $what, $options); + + $c = ['value' => $value]; + $c = serialize($c); + file_put_contents($fileCache, $c); + + if (self::$forceRefresh === 'once') { + self::$refreshed[$fileCache] = true; + } + } + + /** + * Get the cache name for the caching of $operation on $what, + * which is known as dependant from the content of $options + * + * @param string $operation + * @param mixed $what + * @param array $options + * + * @return string + */ + private static function cacheName($operation, $what, $options = []) + { + $t = [ + 'version' => self::CACHE_VERSION, + 'operation' => $operation, + 'what' => $what, + 'options' => $options + ]; + + $t = self::$prefix + . sha1(json_encode($t)) + . ".$operation" + . ".scsscache"; + + return $t; + } + + /** + * Check that the cache dir exists and is writeable + * + * @throws \Exception + */ + public static function checkCacheDir() + { + self::$cacheDir = str_replace('\\', '/', self::$cacheDir); + self::$cacheDir = rtrim(self::$cacheDir, '/') . '/'; + + if (! file_exists(self::$cacheDir)) { + if (! mkdir(self::$cacheDir)) { + throw new Exception('Cache directory couldn\'t be created: ' . self::$cacheDir); + } + } elseif (! is_dir(self::$cacheDir)) { + throw new Exception('Cache directory doesn\'t exist: ' . self::$cacheDir); + } elseif (! is_writable(self::$cacheDir)) { + throw new Exception('Cache directory isn\'t writable: ' . self::$cacheDir); + } + } + + /** + * Delete unused cached files + */ + public static function cleanCache() + { + static $clean = false; + + if ($clean || empty(self::$cacheDir)) { + return; + } + + $clean = true; + + // only remove files with extensions created by SCSSPHP Cache + // css files removed based on the list files + $removeTypes = ['scsscache' => 1]; + + $files = scandir(self::$cacheDir); + + if (! $files) { + return; + } + + $checkTime = time() - self::$gcLifetime; + + foreach ($files as $file) { + // don't delete if the file wasn't created with SCSSPHP Cache + if (strpos($file, self::$prefix) !== 0) { + continue; + } + + $parts = explode('.', $file); + $type = array_pop($parts); + + if (! isset($removeTypes[$type])) { + continue; + } + + $fullPath = self::$cacheDir . $file; + $mtime = filemtime($fullPath); + + // don't delete if it's a relatively new file + if ($mtime > $checkTime) { + continue; + } + + unlink($fullPath); + } + } +} diff --git a/src/Colors.php b/src/Colors.php index dd32be21..2314ea58 100644 --- a/src/Colors.php +++ b/src/Colors.php @@ -2,7 +2,7 @@ /** * SCSSPHP * - * @copyright 2012-2015 Leaf Corcoran + * @copyright 2012-2018 Leaf Corcoran * * @license http://opensource.org/licenses/MIT MIT * @@ -22,8 +22,10 @@ class Colors * CSS Colors * * @see http://www.w3.org/TR/css3-color + * + * @var array */ - public static $cssColors = array( + public static $cssColors = [ 'aliceblue' => '240,248,255', 'antiquewhite' => '250,235,215', 'aqua' => '0,255,255', @@ -143,6 +145,7 @@ class Colors 'plum' => '221,160,221', 'powderblue' => '176,224,230', 'purple' => '128,0,128', + 'rebeccapurple' => '102,51,153', 'red' => '255,0,0', 'rosybrown' => '188,143,143', 'royalblue' => '65,105,225', @@ -171,6 +174,6 @@ class Colors 'white' => '255,255,255', 'whitesmoke' => '245,245,245', 'yellow' => '255,255,0', - 'yellowgreen' => '154,205,50' - ); + 'yellowgreen' => '154,205,50', + ]; } diff --git a/src/Compiler.php b/src/Compiler.php index 620821c9..d22d0a35 100644 --- a/src/Compiler.php +++ b/src/Compiler.php @@ -2,7 +2,7 @@ /** * SCSSPHP * - * @copyright 2012-2015 Leaf Corcoran + * @copyright 2012-2018 Leaf Corcoran * * @license http://opensource.org/licenses/MIT MIT * @@ -12,7 +12,15 @@ namespace Leafo\ScssPhp; use Leafo\ScssPhp\Base\Range; +use Leafo\ScssPhp\Block; +use Leafo\ScssPhp\Cache; use Leafo\ScssPhp\Colors; +use Leafo\ScssPhp\Compiler\Environment; +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; @@ -53,82 +61,134 @@ class Compiler const LINE_COMMENTS = 1; const DEBUG_INFO = 2; - /** - * @var array - */ - static protected $operatorNames = array( - '+' => 'add', - '-' => 'sub', - '*' => 'mul', - '/' => 'div', - '%' => 'mod', - - '==' => 'eq', - '!=' => 'neq', - '<' => 'lt', - '>' => 'gt', + const WITH_RULE = 1; + const WITH_MEDIA = 2; + const WITH_SUPPORTS = 4; + const WITH_ALL = 7; - '<=' => 'lte', - '>=' => 'gte', - ); + const SOURCE_MAP_NONE = 0; + const SOURCE_MAP_INLINE = 1; + const SOURCE_MAP_FILE = 2; /** * @var array */ - static protected $namespaces = array( - 'special' => '%', - 'mixin' => '@', - 'function' => '^', - ); + static protected $operatorNames = [ + '+' => 'add', + '-' => 'sub', + '*' => 'mul', + '/' => 'div', + '%' => 'mod', + + '==' => 'eq', + '!=' => 'neq', + '<' => 'lt', + '>' => 'gt', + + '<=' => 'lte', + '>=' => 'gte', + '<=>' => 'cmp', + ]; /** * @var array */ - static protected $unitTable = array( - 'in' => array( - 'in' => 1, - 'pt' => 72, - 'pc' => 6, - 'cm' => 2.54, - 'mm' => 25.4, - 'px' => 96, - 'q' => 101.6, - ) - ); - - static public $true = array('keyword', 'true'); - static public $false = array('keyword', 'false'); - static public $null = array('null'); - static public $defaultValue = array('keyword', ''); - static public $selfSelector = array('self'); - static public $emptyList = array('list', '', array()); - static public $emptyMap = array('map', array(), array()); - static public $emptyString = array('string', '"', array()); - - protected $importPaths = array(''); - protected $importCache = array(); - protected $userFunctions = array(); - protected $registeredVars = array(); - - protected $numberPrecision = 5; + static protected $namespaces = [ + 'special' => '%', + 'mixin' => '@', + 'function' => '^', + ]; + + static public $true = [Type::T_KEYWORD, 'true']; + static public $false = [Type::T_KEYWORD, 'false']; + static public $null = [Type::T_NULL]; + static public $nullString = [Type::T_STRING, '', []]; + static public $defaultValue = [Type::T_KEYWORD, '']; + static public $selfSelector = [Type::T_SELF]; + static public $emptyList = [Type::T_LIST, '', []]; + static public $emptyMap = [Type::T_MAP, [], []]; + static public $emptyString = [Type::T_STRING, '"', []]; + static public $with = [Type::T_KEYWORD, 'with']; + static public $without = [Type::T_KEYWORD, 'without']; + + protected $importPaths = ['']; + protected $importCache = []; + protected $importedFiles = []; + protected $userFunctions = []; + protected $registeredVars = []; + protected $registeredFeatures = [ + 'extend-selector-pseudoclass' => false, + 'at-error' => true, + 'units-level-3' => false, + 'global-variable-shadowing' => false, + ]; + + protected $encoding = null; protected $lineNumberStyle = null; + protected $sourceMap = self::SOURCE_MAP_NONE; + protected $sourceMapOptions = []; + + /** + * @var string|\Leafo\ScssPhp\Formatter + */ protected $formatter = 'Leafo\ScssPhp\Formatter\Nested'; - private $indentLevel; - private $commentsSeen; - private $extends; - private $extendsMap; - private $parsedFiles; - private $env; - private $scope; - private $parser; - private $sourcePos; - private $sourceParser; - private $storeEnv; - private $charsetSeen; - private $stderr; - private $shouldEvaluate; + protected $rootEnv; + protected $rootBlock; + + /** + * @var \Leafo\ScssPhp\Compiler\Environment + */ + protected $env; + protected $scope; + protected $storeEnv; + protected $charsetSeen; + protected $sourceNames; + + protected $cache; + + protected $indentLevel; + protected $extends; + protected $extendsMap; + protected $parsedFiles; + protected $parser; + protected $sourceIndex; + protected $sourceLine; + protected $sourceColumn; + protected $stderr; + protected $shouldEvaluate; + protected $ignoreErrors; + + protected $callStack = []; + + /** + * Constructor + */ + public function __construct($cacheOptions = null) + { + $this->parsedFiles = []; + $this->sourceNames = []; + + if ($cacheOptions) { + $this->cache = new Cache($cacheOptions); + } + } + + public function getCompileOptions() + { + $options = [ + 'importPaths' => $this->importPaths, + 'registeredVars' => $this->registeredVars, + 'registeredFeatures' => $this->registeredFeatures, + 'encoding' => $this->encoding, + 'sourceMap' => serialize($this->sourceMap), + 'sourceMapOptions' => $this->sourceMapOptions, + 'formatter' => $this->formatter, + ]; + + return $options; + } /** * Compile scss @@ -136,43 +196,122 @@ class Compiler * @api * * @param string $code - * @param string $name + * @param string $path * * @return string */ - public function compile($code, $name = null) + public function compile($code, $path = null) { - $this->indentLevel = -1; - $this->commentsSeen = array(); - $this->extends = array(); - $this->extendsMap = array(); - $this->parsedFiles = array(); - $this->env = null; - $this->scope = null; + if ($this->cache) { + $cacheKey = ($path ? $path : "(stdin)") . ":" . md5($code); + $compileOptions = $this->getCompileOptions(); + $cache = $this->cache->getCache("compile", $cacheKey, $compileOptions); + + if (is_array($cache) + && isset($cache['dependencies']) + && isset($cache['out']) + ) { + // check if any dependency file changed before accepting the cache + foreach ($cache['dependencies'] as $file => $mtime) { + if (! file_exists($file) + || filemtime($file) !== $mtime + ) { + unset($cache); + break; + } + } - $this->stderr = fopen('php://stderr', 'w'); + if (isset($cache)) { + return $cache['out']; + } + } + } - $locale = setlocale(LC_NUMERIC, 0); - setlocale(LC_NUMERIC, 'C'); - $this->parser = new Parser($name); + $this->indentLevel = -1; + $this->extends = []; + $this->extendsMap = []; + $this->sourceIndex = null; + $this->sourceLine = null; + $this->sourceColumn = null; + $this->env = null; + $this->scope = null; + $this->storeEnv = null; + $this->charsetSeen = null; + $this->shouldEvaluate = null; + $this->stderr = fopen('php://stderr', 'w'); + $this->parser = $this->parserFactory($path); $tree = $this->parser->parse($code); + $this->parser = null; $this->formatter = new $this->formatter(); + $this->rootBlock = null; + $this->rootEnv = $this->pushEnv($tree); - $this->rootEnv = $this->pushEnv($tree); $this->injectVariables($this->registeredVars); $this->compileRoot($tree); $this->popEnv(); - $out = $this->formatter->format($this->scope); + $sourceMapGenerator = null; + + if ($this->sourceMap) { + if (is_object($this->sourceMap) && $this->sourceMap instanceof SourceMapGenerator) { + $sourceMapGenerator = $this->sourceMap; + $this->sourceMap = self::SOURCE_MAP_FILE; + } elseif ($this->sourceMap !== self::SOURCE_MAP_NONE) { + $sourceMapGenerator = new SourceMapGenerator($this->sourceMapOptions); + } + } + + $out = $this->formatter->format($this->scope, $sourceMapGenerator); + + if (! empty($out) && $this->sourceMap && $this->sourceMap !== self::SOURCE_MAP_NONE) { + $sourceMap = $sourceMapGenerator->generateJson(); + $sourceMapUrl = null; + + switch ($this->sourceMap) { + case self::SOURCE_MAP_INLINE: + $sourceMapUrl = sprintf('data:application/json,%s', Util::encodeURIComponent($sourceMap)); + break; + + case self::SOURCE_MAP_FILE: + $sourceMapUrl = $sourceMapGenerator->saveMap($sourceMap); + break; + } - setlocale(LC_NUMERIC, $locale); + $out .= sprintf('/*# sourceMappingURL=%s */', $sourceMapUrl); + } + + if ($this->cache && isset($cacheKey) && isset($compileOptions)) { + $v = [ + 'dependencies' => $this->getParsedFiles(), + 'out' => &$out, + ]; + + $this->cache->setCache("compile", $cacheKey, $v, $compileOptions); + } return $out; } + /** + * Instantiate parser + * + * @param string $path + * + * @return \Leafo\ScssPhp\Parser + */ + protected function parserFactory($path) + { + $parser = new Parser($path, count($this->sourceNames), $this->encoding, $this->cache); + + $this->sourceNames[] = $path; + $this->addParsedFile($path); + + return $parser; + } + /** * Is self extend? * @@ -195,23 +334,24 @@ protected function isSelfExtend($target, $origin) /** * Push extends * - * @param array $target - * @param array $origin + * @param array $target + * @param array $origin + * @param \stdClass $block */ - protected function pushExtends($target, $origin) + protected function pushExtends($target, $origin, $block) { if ($this->isSelfExtend($target, $origin)) { return; } $i = count($this->extends); - $this->extends[] = array($target, $origin); + $this->extends[] = [$target, $origin, $block]; foreach ($target as $part) { if (isset($this->extendsMap[$part])) { $this->extendsMap[$part][] = $i; } else { - $this->extendsMap[$part] = array($i); + $this->extendsMap[$part] = [$i]; } } } @@ -222,17 +362,27 @@ protected function pushExtends($target, $origin) * @param string $type * @param array $selectors * - * @return \stdClass + * @return \Leafo\ScssPhp\Formatter\OutputBlock */ protected function makeOutputBlock($type, $selectors = null) { - $out = new \stdClass; - $out->type = $type; - $out->lines = array(); - $out->children = array(); - $out->parent = $this->scope; - $out->selectors = $selectors; - $out->depth = $this->env->depth; + $out = new OutputBlock; + $out->type = $type; + $out->lines = []; + $out->children = []; + $out->parent = $this->scope; + $out->selectors = $selectors; + $out->depth = $this->env->depth; + + if ($this->env->block instanceof Block) { + $out->sourceName = $this->env->block->sourceName; + $out->sourceLine = $this->env->block->sourceLine; + $out->sourceColumn = $this->env->block->sourceColumn; + } else { + $out->sourceName = null; + $out->sourceLine = null; + $out->sourceColumn = null; + } return $out; } @@ -240,26 +390,52 @@ protected function makeOutputBlock($type, $selectors = null) /** * Compile root * - * @param \stdClass $rootBlock + * @param \Leafo\ScssPhp\Block $rootBlock */ - protected function compileRoot($rootBlock) + protected function compileRoot(Block $rootBlock) { - $this->scope = $this->makeOutputBlock('root'); + $this->rootBlock = $this->scope = $this->makeOutputBlock(Type::T_ROOT); - $this->compileChildren($rootBlock->children, $this->scope); + $this->compileChildrenNoReturn($rootBlock->children, $this->scope); $this->flattenSelectors($this->scope); + $this->missingSelectors(); + } + + /** + * Report missing selectors + */ + protected function missingSelectors() + { + foreach ($this->extends as $extend) { + if (isset($extend[3])) { + continue; + } + + list($target, $origin, $block) = $extend; + + // ignore if !optional + if ($block[2]) { + continue; + } + + $target = implode(' ', $target); + $origin = $this->collapseSelectors($origin); + + $this->sourceLine = $block[Parser::SOURCE_LINE]; + $this->throwError("\"$origin\" failed to @extend \"$target\". The selector \"$target\" was not found."); + } } /** * Flatten selectors * - * @param \stdClass $block - * @parent string $parentKey + * @param \Leafo\ScssPhp\Formatter\OutputBlock $block + * @param string $parentKey */ - protected function flattenSelectors($block, $parentKey = null) + protected function flattenSelectors(OutputBlock $block, $parentKey = null) { if ($block->selectors) { - $selectors = array(); + $selectors = []; foreach ($block->selectors as $s) { $selectors[] = $s; @@ -274,16 +450,18 @@ protected function flattenSelectors($block, $parentKey = null) // remove duplicates array_walk($selectors, function (&$value) { - $value = json_encode($value); + $value = serialize($value); }); + $selectors = array_unique($selectors); + array_walk($selectors, function (&$value) { - $value = json_decode($value); + $value = unserialize($value); }); } } - $block->selectors = array(); + $block->selectors = []; $placeholderSelector = false; foreach ($selectors as $selector) { @@ -307,6 +485,37 @@ protected function flattenSelectors($block, $parentKey = null) } } + /** + * Glue parts of :not( or :nth-child( ... that are in general splitted in selectors parts + * + * @param array $parts + * + * @return array + */ + protected function glueFunctionSelectors($parts) + { + $new = []; + + foreach ($parts as $part) { + if (is_array($part)) { + $part = $this->glueFunctionSelectors($part); + $new[] = $part; + } else { + // a selector part finishing with a ) is the last part of a :not( or :nth-child( + // and need to be joined to this + if (count($new) && is_string($new[count($new) - 1]) + && strlen($part) && substr($part, -1) === ')' && strpos($part, '(') === false + ) { + $new[count($new) - 1] .= $part; + } else { + $new[] = $part; + } + } + } + + return $new; + } + /** * Match extends * @@ -317,29 +526,70 @@ protected function flattenSelectors($block, $parentKey = null) */ protected function matchExtends($selector, &$out, $from = 0, $initial = true) { + static $partsPile = []; + + $selector = $this->glueFunctionSelectors($selector); + foreach ($selector as $i => $part) { if ($i < $from) { continue; } + // check that we are not building an infinite loop of extensions + // if the new part is just including a previous part don't try to extend anymore + if (count($part) > 1) { + foreach ($partsPile as $previousPart) { + if (! count(array_diff($previousPart, $part))) { + continue 2; + } + } + } + if ($this->matchExtendsSingle($part, $origin)) { - $before = array_slice($selector, 0, $i); - $after = array_slice($selector, $i + 1); - $s = count($before); + $partsPile[] = $part; + $after = array_slice($selector, $i + 1); + $before = array_slice($selector, 0, $i); + + list($before, $nonBreakableBefore) = $this->extractRelationshipFromFragment($before); foreach ($origin as $new) { $k = 0; // remove shared parts - if ($initial) { - while ($k < $s && isset($new[$k]) && $before[$k] === $new[$k]) { + if (count($new) > 1) { + while ($k < $i && isset($new[$k]) && $selector[$k] === $new[$k]) { $k++; } } + $replacement = []; + $tempReplacement = $k > 0 ? array_slice($new, $k) : $new; + + for ($l = count($tempReplacement) - 1; $l >= 0; $l--) { + $slice = []; + + foreach ($tempReplacement[$l] as $chunk) { + if (! in_array($chunk, $slice)) { + $slice[] = $chunk; + } + } + + array_unshift($replacement, $slice); + + if (! $this->isImmediateRelationshipCombinator(end($slice))) { + break; + } + } + + $afterBefore = $l != 0 ? array_slice($tempReplacement, 0, $l) : []; + + // Merge shared direct relationships. + $mergedBefore = $this->mergeDirectRelationships($afterBefore, $nonBreakableBefore); + $result = array_merge( $before, - $k > 0 ? array_slice($new, $k) : $new, + $mergedBefore, + $replacement, $after ); @@ -350,20 +600,31 @@ protected function matchExtends($selector, &$out, $from = 0, $initial = true) $out[] = $result; // recursively check for more matches - $this->matchExtends($result, $out, $i, false); + $startRecurseFrom = count($before) + min(count($nonBreakableBefore), count($mergedBefore)); + $this->matchExtends($result, $out, $startRecurseFrom, false); // selector sequence merging if (! empty($before) && count($new) > 1) { + $preSharedParts = $k > 0 ? array_slice($before, 0, $k) : []; + $postSharedParts = $k > 0 ? array_slice($before, $k) : $before; + + list($betweenSharedParts, $nonBreakable2) = $this->extractRelationshipFromFragment($afterBefore); + $result2 = array_merge( - array_slice($new, 0, -1), - $k > 0 ? array_slice($before, $k) : $before, - array_slice($new, -1), + $preSharedParts, + $betweenSharedParts, + $postSharedParts, + $nonBreakable2, + $nonBreakableBefore, + $replacement, $after ); $out[] = $result2; } } + + array_pop($partsPile); } } } @@ -378,8 +639,13 @@ protected function matchExtends($selector, &$out, $from = 0, $initial = true) */ protected function matchExtendsSingle($rawSingle, &$outOrigin) { - $counts = array(); - $single = array(); + $counts = []; + $single = []; + + // simple usual cases, no need to do the whole trick + if (in_array($rawSingle, [['>'],['+'],['~']])) { + return false; + } foreach ($rawSingle as $part) { // matches Number @@ -394,6 +660,13 @@ protected function matchExtendsSingle($rawSingle, &$outOrigin) } } + $extendingDecoratedTag = false; + + if (count($single) > 1) { + $matches = null; + $extendingDecoratedTag = preg_match('/^[a-z0-9]+$/i', $single[0], $matches) ? $matches[0] : false; + } + foreach ($single as $part) { if (isset($this->extendsMap[$part])) { foreach ($this->extendsMap[$part] as $idx) { @@ -402,17 +675,21 @@ protected function matchExtendsSingle($rawSingle, &$outOrigin) } } - $outOrigin = array(); + $outOrigin = []; $found = false; foreach ($counts as $idx => $count) { - list($target, $origin) = $this->extends[$idx]; + list($target, $origin, /* $block */) = $this->extends[$idx]; + + $origin = $this->glueFunctionSelectors($origin); // check count if ($count !== count($target)) { continue; } + $this->extends[$idx][3] = true; + $rem = array_diff($single, $target); foreach ($origin as $j => $new) { @@ -421,7 +698,21 @@ protected function matchExtendsSingle($rawSingle, &$outOrigin) return false; } - $origin[$j][count($origin[$j]) - 1] = $this->combineSelectorSingle(end($new), $rem); + $replacement = end($new); + + // Extending a decorated tag with another tag is not possible. + if ($extendingDecoratedTag && $replacement[0] != $extendingDecoratedTag && + preg_match('/^[a-z0-9]+$/i', $replacement[0]) + ) { + unset($origin[$j]); + continue; + } + + $combined = $this->combineSelectorSingle($replacement, $rem); + + if (count(array_diff($combined, $origin[$j][count($origin[$j]) - 1]))) { + $origin[$j][count($origin[$j]) - 1] = $combined; + } } $outOrigin = array_merge($outOrigin, $origin); @@ -432,6 +723,39 @@ protected function matchExtendsSingle($rawSingle, &$outOrigin) return $found; } + /** + * Extract a relationship from the fragment. + * + * When extracting the last portion of a selector we will be left with a + * fragment which may end with a direction relationship combinator. This + * method will extract the relationship fragment and return it along side + * the rest. + * + * @param array $fragment The selector fragment maybe ending with a direction relationship combinator. + * + * @return array The selector without the relationship fragment if any, the relationship fragment. + */ + protected function extractRelationshipFromFragment(array $fragment) + { + $parents = []; + $children = []; + $j = $i = count($fragment); + + for (;;) { + $children = $j != $i ? array_slice($fragment, $j, $i - $j) : []; + $parents = array_slice($fragment, 0, $j); + $slice = end($parents); + + if (empty($slice) || ! $this->isImmediateRelationshipCombinator($slice[0])) { + break; + } + + $j -= 2; + } + + return [$parents, $children]; + } + /** * Combine selector single * @@ -442,21 +766,28 @@ protected function matchExtendsSingle($rawSingle, &$outOrigin) */ protected function combineSelectorSingle($base, $other) { - $tag = null; - $out = array(); + $tag = []; + $out = []; + $wasTag = true; - foreach (array($base, $other) as $single) { + foreach ([$base, $other] as $single) { foreach ($single as $part) { - if (preg_match('/^[^\[.#:]/', $part)) { - $tag = $part; - } else { + if (preg_match('/^[\[.:#]/', $part)) { $out[] = $part; + $wasTag = false; + } elseif (preg_match('/^[^_-]/', $part)) { + $tag[] = $part; + $wasTag = true; + } elseif ($wasTag) { + $tag[count($tag) - 1] .= $part; + } else { + $out[count($out) - 1] .= $part; } } } - if ($tag) { - array_unshift($out, $tag); + if (count($tag)) { + array_unshift($out, $tag[0]); } return $out; @@ -465,19 +796,24 @@ protected function combineSelectorSingle($base, $other) /** * Compile media * - * @param \stdClass $media + * @param \Leafo\ScssPhp\Block $media */ - protected function compileMedia($media) + protected function compileMedia(Block $media) { $this->pushEnv($media); - $mediaQuery = $this->compileMediaQuery($this->multiplyMedia($this->env)); - - if (! empty($mediaQuery)) { - $this->scope = $this->makeOutputBlock('media', array($mediaQuery)); + $mediaQueries = $this->compileMediaQuery($this->multiplyMedia($this->env)); + if (! empty($mediaQueries) && $mediaQueries) { + $previousScope = $this->scope; $parentScope = $this->mediaParent($this->scope); - $parentScope->children[] = $this->scope; + + foreach ($mediaQueries as $mediaQuery) { + $this->scope = $this->makeOutputBlock(Type::T_MEDIA, [$mediaQuery]); + + $parentScope->children[] = $this->scope; + $parentScope = $this->scope; + } // top level properties in a media cause it to be wrapped $needsWrap = false; @@ -485,23 +821,56 @@ protected function compileMedia($media) foreach ($media->children as $child) { $type = $child[0]; - if ($type !== 'block' && $type !== 'media' && $type !== 'directive') { + if ($type !== Type::T_BLOCK && + $type !== Type::T_MEDIA && + $type !== Type::T_DIRECTIVE && + $type !== Type::T_IMPORT + ) { $needsWrap = true; break; } } if ($needsWrap) { - $wrapped = (object)array( - 'selectors' => array(), - 'children' => $media->children - ); - $media->children = array(array('block', $wrapped)); + $wrapped = new Block; + $wrapped->sourceName = $media->sourceName; + $wrapped->sourceIndex = $media->sourceIndex; + $wrapped->sourceLine = $media->sourceLine; + $wrapped->sourceColumn = $media->sourceColumn; + $wrapped->selectors = []; + $wrapped->comments = []; + $wrapped->parent = $media; + $wrapped->children = $media->children; + + $media->children = [[Type::T_BLOCK, $wrapped]]; + if (isset($this->lineNumberStyle)) { + $annotation = $this->makeOutputBlock(Type::T_COMMENT); + $annotation->depth = 0; + + $file = $this->sourceNames[$media->sourceIndex]; + $line = $media->sourceLine; + + switch ($this->lineNumberStyle) { + case static::LINE_COMMENTS: + $annotation->lines[] = '/* line ' . $line + . ($file ? ', ' . $file : '') + . ' */'; + break; + + case static::DEBUG_INFO: + $annotation->lines[] = '@media -sass-debug-info{' + . ($file ? 'filename{font-family:"' . $file . '"}' : '') + . 'line{font-family:' . $line . '}}'; + break; + } + + $this->scope->children[] = $annotation; + } } - $this->compileChildren($media->children, $this->scope); + $this->compileChildrenNoReturn($media->children, $this->scope); - $this->scope = $this->scope->parent; + $this->scope = $previousScope; } $this->popEnv(); @@ -510,14 +879,14 @@ protected function compileMedia($media) /** * Media parent * - * @param \stdClass $scope + * @param \Leafo\ScssPhp\Formatter\OutputBlock $scope * - * @return \stdClass + * @return \Leafo\ScssPhp\Formatter\OutputBlock */ - protected function mediaParent($scope) + protected function mediaParent(OutputBlock $scope) { while (! empty($scope->parent)) { - if (! empty($scope->type) && $scope->type !== 'media') { + if (! empty($scope->type) && $scope->type !== Type::T_MEDIA) { break; } @@ -528,135 +897,507 @@ protected function mediaParent($scope) } /** - * Compile nested block + * Compile directive * - * @todo refactor compileNestedBlock and compileMedia into same thing? + * @param \Leafo\ScssPhp\Block $block + */ + protected function compileDirective(Block $block) + { + $s = '@' . $block->name; + + if (! empty($block->value)) { + $s .= ' ' . $this->compileValue($block->value); + } + + if ($block->name === 'keyframes' || substr($block->name, -10) === '-keyframes') { + $this->compileKeyframeBlock($block, [$s]); + } else { + $this->compileNestedBlock($block, [$s]); + } + } + + /** + * Compile at-root * - * @param \stdClass $block - * @param array $selectors + * @param \Leafo\ScssPhp\Block $block */ - protected function compileNestedBlock($block, $selectors) + protected function compileAtRoot(Block $block) { - $this->pushEnv($block); + $env = $this->pushEnv($block); + $envs = $this->compactEnv($env); + $without = isset($block->with) ? $this->compileWith($block->with) : static::WITH_RULE; - $this->scope = $this->makeOutputBlock($block->type, $selectors); - $this->scope->parent->children[] = $this->scope; + // 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; + $wrapped->selectors = $block->selector; + $wrapped->comments = []; + $wrapped->parent = $block; + $wrapped->children = $block->children; + $wrapped->selfParent = $block->selfParent; - $this->compileChildren($block->children, $this->scope); + $block->children = [[Type::T_BLOCK, $wrapped]]; + $block->selector = null; + } - $this->scope = $this->scope->parent; + $selfParent = $block->selfParent; + + if (! $block->selfParent->selectors && isset($block->parent) && $block->parent && + isset($block->parent->selectors) && $block->parent->selectors + ) { + $selfParent = $block->parent; + } + + $this->env = $this->filterWithout($envs, $without); + + $saveScope = $this->scope; + $this->scope = $this->filterScopeWithout($saveScope, $without); + + // propagate selfParent to the children where they still can be useful + $this->compileChildrenNoReturn($block->children, $this->scope, $selfParent); + + $this->scope = $this->completeScope($this->scope, $saveScope); + $this->scope = $saveScope; + $this->env = $this->extractEnv($envs); $this->popEnv(); } /** - * Recursively compiles a block. - * - * A block is analogous to a CSS block in most cases. A single SCSS document - * is encapsulated in a block when parsed, but it does not have parent tags - * so all of its children appear on the root level when compiled. - * - * Blocks are made up of selectors and children. + * Filter at-root scope depending of with/without option * - * The children of a block are just all the blocks that are defined within. - * - * Compiling the block involves pushing a fresh environment on the stack, - * and iterating through the props, compiling each one. + * @param \Leafo\ScssPhp\Formatter\OutputBlock $scope + * @param mixed $without * - * @see Compiler::compileChild() - * - * @param \stdClass $block + * @return mixed */ - protected function compileBlock($block) + protected function filterScopeWithout($scope, $without) { - $env = $this->pushEnv($block); + $filteredScopes = []; - $env->selectors = $this->evalSelectors($block->selectors); + if ($scope->type === TYPE::T_ROOT) { + return $scope; + } - $out = $this->makeOutputBlock(null, $this->multiplySelectors($env)); + // start from the root + while ($scope->parent && $scope->parent->type !== TYPE::T_ROOT) { + $scope = $scope->parent; + } - if (isset($this->lineNumberStyle) && count($env->selectors) && count($block->children)) { - $annotation = $this->makeOutputBlock('comment'); - $annotation->depth = 0; + for (;;) { + if (! $scope) { + break; + } - $file = $block->sourceParser->getSourceName(); - $line = $block->sourceParser->getLineNo($block->sourcePosition); + if (! $this->isWithout($without, $scope)) { + $s = clone $scope; + $s->children = []; + $s->lines = []; + $s->parent = null; - switch ($this->lineNumberStyle) { - case self::LINE_COMMENTS: - $annotation->lines[] = '/* line ' . $line . ', ' . $file . ' */'; - break; + if ($s->type !== Type::T_MEDIA && $s->type !== Type::T_DIRECTIVE) { + $s->selectors = []; + } - case self::DEBUG_INFO: - $annotation->lines[] = '@media -sass-debug-info{filename{font-family:"' . $file - . '"}line{font-family:' . $line . '}}'; - break; + $filteredScopes[] = $s; } - $this->scope->children[] = $annotation; + if ($scope->children) { + $scope = end($scope->children); + } else { + $scope = null; + } } - $this->scope->children[] = $out; + if (! count($filteredScopes)) { + return $this->rootBlock; + } - $this->compileChildren($block->children, $out); + $newScope = array_shift($filteredScopes); + $newScope->parent = $this->rootBlock; - $this->formatter->stripSemicolon($out->lines); + $this->rootBlock->children[] = $newScope; - $this->popEnv(); + $p = &$newScope; + + while (count($filteredScopes)) { + $s = array_shift($filteredScopes); + $s->parent = $p; + $p->children[] = &$s; + $p = $s; + } + + return $newScope; } /** - * Compile root level comment + * found missing selector from a at-root compilation in the previous scope + * (if at-root is just enclosing a property, the selector is in the parent tree) * - * @param array $block + * @param \Leafo\ScssPhp\Formatter\OutputBlock $scope + * @param \Leafo\ScssPhp\Formatter\OutputBlock $previousScope + * + * @return mixed */ - protected function compileComment($block) + protected function completeScope($scope, $previousScope) { - $out = $this->makeOutputBlock('comment'); - $out->lines[] = $block[1]; - $this->scope->children[] = $out; + if (! $scope->type && (! $scope->selectors || ! count($scope->selectors)) && count($scope->lines)) { + $scope->selectors = $this->findScopeSelectors($previousScope, $scope->depth); + } + + if ($scope->children) { + foreach ($scope->children as $k => $c) { + $scope->children[$k] = $this->completeScope($c, $previousScope); + } + } + + return $scope; } /** - * Evaluate selectors + * Find a selector by the depth node in the scope * - * @param array $selectors + * @param \Leafo\ScssPhp\Formatter\OutputBlock $scope + * @param integer $depth * * @return array */ - protected function evalSelectors($selectors) + protected function findScopeSelectors($scope, $depth) { - $this->shouldEvaluate = false; - - $selectors = array_map(array($this, 'evalSelector'), $selectors); - - // after evaluating interpolates, we might need a second pass - if ($this->shouldEvaluate) { - $buffer = $this->collapseSelectors($selectors); - $parser = new Parser(__METHOD__, false); + if ($scope->depth === $depth && $scope->selectors) { + return $scope->selectors; + } - if ($parser->parseSelector($buffer, $newSelectors)) { - $selectors = array_map(array($this, 'evalSelector'), $newSelectors); + if ($scope->children) { + foreach (array_reverse($scope->children) as $c) { + if ($s = $this->findScopeSelectors($c, $depth)) { + return $s; + } } } - return $selectors; + return []; } /** - * Evaluate selector + * Compile @at-root's with: inclusion / without: exclusion into filter flags * - * @param array $selector + * @param array $with * - * @return array + * @return integer */ - protected function evalSelector($selector) + protected function compileWith($with) { - return array_map(array($this, 'evalSelectorPart'), $selector); - } + static $mapping = [ + 'rule' => self::WITH_RULE, + 'media' => self::WITH_MEDIA, + 'supports' => self::WITH_SUPPORTS, + 'all' => self::WITH_ALL, + ]; - /** - * Evaluate selector part; replaces all the interpolates, stripping quotes + // exclude selectors by default + $without = static::WITH_RULE; + + if ($this->libMapHasKey([$with, static::$with])) { + $without = static::WITH_ALL; + + $list = $this->coerceList($this->libMapGet([$with, static::$with])); + + foreach ($list[2] as $item) { + $keyword = $this->compileStringContent($this->coerceString($item)); + + if (array_key_exists($keyword, $mapping)) { + $without &= ~($mapping[$keyword]); + } + } + } + + if ($this->libMapHasKey([$with, static::$without])) { + $without = 0; + + $list = $this->coerceList($this->libMapGet([$with, static::$without])); + + foreach ($list[2] as $item) { + $keyword = $this->compileStringContent($this->coerceString($item)); + + if (array_key_exists($keyword, $mapping)) { + $without |= $mapping[$keyword]; + } + } + } + + return $without; + } + + /** + * Filter env stack + * + * @param array $envs + * @param integer $without + * + * @return \Leafo\ScssPhp\Compiler\Environment + */ + protected function filterWithout($envs, $without) + { + $filtered = []; + + foreach ($envs as $e) { + if ($e->block && $this->isWithout($without, $e->block)) { + $ec = clone $e; + $ec->block = null; + $ec->selectors = []; + $filtered[] = $ec; + } else { + $filtered[] = $e; + } + } + + return $this->extractEnv($filtered); + } + + /** + * Filter WITH rules + * + * @param integer $without + * @param \Leafo\ScssPhp\Block|\Leafo\ScssPhp\Formatter\OutputBlock $block + * + * @return boolean + */ + protected function isWithout($without, $block) + { + if (isset($block->type)) { + if ($block->type === Type::T_MEDIA) { + return ($without & static::WITH_MEDIA) ? true : false; + } + + if ($block->type === Type::T_DIRECTIVE) { + if (isset($block->name) && $block->name === 'supports') { + return ($without & static::WITH_SUPPORTS) ? true : false; + } + + if (isset($block->selectors) && strpos(serialize($block->selectors), '@supports') !== false) { + return ($without & static::WITH_SUPPORTS) ? true : false; + } + } + } + + if ((($without & static::WITH_RULE) && isset($block->selectors))) { + return true; + } + + return false; + } + + /** + * Compile keyframe block + * + * @param \Leafo\ScssPhp\Block $block + * @param array $selectors + */ + protected function compileKeyframeBlock(Block $block, $selectors) + { + $env = $this->pushEnv($block); + + $envs = $this->compactEnv($env); + + $this->env = $this->extractEnv(array_filter($envs, function (Environment $e) { + return ! isset($e->block->selectors); + })); + + $this->scope = $this->makeOutputBlock($block->type, $selectors); + $this->scope->depth = 1; + $this->scope->parent->children[] = $this->scope; + + $this->compileChildrenNoReturn($block->children, $this->scope); + + $this->scope = $this->scope->parent; + $this->env = $this->extractEnv($envs); + + $this->popEnv(); + } + + /** + * Compile nested block + * + * @param \Leafo\ScssPhp\Block $block + * @param array $selectors + */ + protected function compileNestedBlock(Block $block, $selectors) + { + $this->pushEnv($block); + + $this->scope = $this->makeOutputBlock($block->type, $selectors); + $this->scope->parent->children[] = $this->scope; + + // wrap assign children in a block + // except for @font-face + if ($block->type !== Type::T_DIRECTIVE || $block->name !== "font-face") { + // need wrapping? + $needWrapping = false; + + foreach ($block->children as $child) { + if ($child[0] === Type::T_ASSIGN) { + $needWrapping = true; + break; + } + } + + if ($needWrapping) { + $wrapped = new Block; + $wrapped->sourceName = $block->sourceName; + $wrapped->sourceIndex = $block->sourceIndex; + $wrapped->sourceLine = $block->sourceLine; + $wrapped->sourceColumn = $block->sourceColumn; + $wrapped->selectors = []; + $wrapped->comments = []; + $wrapped->parent = $block; + $wrapped->children = $block->children; + $wrapped->selfParent = $block->selfParent; + + $block->children = [[Type::T_BLOCK, $wrapped]]; + } + } + + $this->compileChildrenNoReturn($block->children, $this->scope); + + $this->scope = $this->scope->parent; + + $this->popEnv(); + } + + /** + * Recursively compiles a block. + * + * A block is analogous to a CSS block in most cases. A single SCSS document + * is encapsulated in a block when parsed, but it does not have parent tags + * so all of its children appear on the root level when compiled. + * + * Blocks are made up of selectors and children. + * + * The children of a block are just all the blocks that are defined within. + * + * Compiling the block involves pushing a fresh environment on the stack, + * and iterating through the props, compiling each one. + * + * @see Compiler::compileChild() + * + * @param \Leafo\ScssPhp\Block $block + */ + protected function compileBlock(Block $block) + { + $env = $this->pushEnv($block); + $env->selectors = $this->evalSelectors($block->selectors); + + $out = $this->makeOutputBlock(null); + + if (isset($this->lineNumberStyle) && count($env->selectors) && count($block->children)) { + $annotation = $this->makeOutputBlock(Type::T_COMMENT); + $annotation->depth = 0; + + $file = $this->sourceNames[$block->sourceIndex]; + $line = $block->sourceLine; + + switch ($this->lineNumberStyle) { + case static::LINE_COMMENTS: + $annotation->lines[] = '/* line ' . $line + . ($file ? ', ' . $file : '') + . ' */'; + break; + + case static::DEBUG_INFO: + $annotation->lines[] = '@media -sass-debug-info{' + . ($file ? 'filename{font-family:"' . $file . '"}' : '') + . 'line{font-family:' . $line . '}}'; + break; + } + + $this->scope->children[] = $annotation; + } + + $this->scope->children[] = $out; + + if (count($block->children)) { + $out->selectors = $this->multiplySelectors($env, $block->selfParent); + + // propagate selfParent to the children where they still can be useful + $selfParentSelectors = null; + + if (isset($block->selfParent->selectors)) { + $selfParentSelectors = $block->selfParent->selectors; + $block->selfParent->selectors = $out->selectors; + } + + $this->compileChildrenNoReturn($block->children, $out, $block->selfParent); + + // and revert for the following childs of the same block + if ($selfParentSelectors) { + $block->selfParent->selectors = $selfParentSelectors; + } + } + + $this->formatter->stripSemicolon($out->lines); + + $this->popEnv(); + } + + /** + * Compile root level comment + * + * @param array $block + */ + protected function compileComment($block) + { + $out = $this->makeOutputBlock(Type::T_COMMENT); + $out->lines[] = is_string($block[1]) ? $block[1] : $this->compileValue($block[1]); + + $this->scope->children[] = $out; + } + + /** + * Evaluate selectors + * + * @param array $selectors + * + * @return array + */ + protected function evalSelectors($selectors) + { + $this->shouldEvaluate = false; + + $selectors = array_map([$this, 'evalSelector'], $selectors); + + // after evaluating interpolates, we might need a second pass + if ($this->shouldEvaluate) { + $selectors = $this->revertSelfSelector($selectors); + $buffer = $this->collapseSelectors($selectors); + $parser = $this->parserFactory(__METHOD__); + + if ($parser->parseSelector($buffer, $newSelectors)) { + $selectors = array_map([$this, 'evalSelector'], $newSelectors); + } + } + + return $selectors; + } + + /** + * Evaluate selector + * + * @param array $selector + * + * @return array + */ + protected function evalSelector($selector) + { + return array_map([$this, 'evalSelectorPart'], $selector); + } + + /** + * Evaluate selector part; replaces all the interpolates, stripping quotes * * @param array $part * @@ -665,7 +1406,7 @@ protected function evalSelector($selector) protected function evalSelectorPart($part) { foreach ($part as &$p) { - if (is_array($p) && ($p[0] === 'interpolate' || $p[0] === 'string')) { + if (is_array($p) && ($p[0] === Type::T_INTERPOLATE || $p[0] === Type::T_STRING)) { $p = $this->compileValue($p); // force re-evaluation @@ -686,28 +1427,87 @@ protected function evalSelectorPart($part) /** * Collapse selectors * - * @param array $selectors + * @param array $selectors + * @param boolean $selectorFormat + * if false return a collapsed string + * if true return an array description of a structured selector * * @return string */ - protected function collapseSelectors($selectors) + protected function collapseSelectors($selectors, $selectorFormat = false) { - $parts = array(); + $parts = []; foreach ($selectors as $selector) { - $output = ''; + $output = []; + $glueNext = false; - array_walk_recursive( - $selector, - function ($value, $key) use (&$output) { - $output .= $value; + foreach ($selector as $node) { + $compound = ''; + + array_walk_recursive( + $node, + function ($value, $key) use (&$compound) { + $compound .= $value; + } + ); + + if ($selectorFormat && $this->isImmediateRelationshipCombinator($compound)) { + if (count($output)) { + $output[count($output) - 1] .= ' ' . $compound; + } else { + $output[] = $compound; + } + $glueNext = true; + } elseif ($glueNext) { + $output[count($output) - 1] .= ' ' . $compound; + $glueNext = false; + } else { + $output[] = $compound; } - ); + } + + if ($selectorFormat) { + foreach ($output as &$o) { + $o = [Type::T_STRING, '', [$o]]; + } + $output = [Type::T_LIST, ' ', $output]; + } else { + $output = implode(' ', $output); + } $parts[] = $output; } - return implode(', ', $parts); + if ($selectorFormat) { + $parts = [Type::T_LIST, ',', $parts]; + } else { + $parts = implode(', ', $parts); + } + + return $parts; + } + + /** + * Parse down the selector and revert [self] to "&" before a reparsing + * + * @param array $selectors + * + * @return array + */ + protected function revertSelfSelector($selectors) + { + foreach ($selectors as &$part) { + if (is_array($part)) { + if ($part === [Type::T_SELF]) { + $part = '&'; + } else { + $part = $this->revertSelfSelector($part); + } + } + } + + return $selectors; } /** @@ -719,7 +1519,7 @@ function ($value, $key) use (&$output) { */ protected function flattenSelectorSingle($single) { - $joined = array(); + $joined = []; foreach ($single as $part) { if (empty($joined) || @@ -743,7 +1543,7 @@ protected function flattenSelectorSingle($single) /** * Compile selector to string; self(&) should have been replaced by now * - * @param array $selector + * @param string|array $selector * * @return string */ @@ -756,7 +1556,7 @@ protected function compileSelector($selector) return implode( ' ', array_map( - array($this, 'compileSelectorPart'), + [$this, 'compileSelectorPart'], $selector ) ); @@ -765,7 +1565,7 @@ protected function compileSelector($selector) /** * Compile selector part * - * @param arary $piece + * @param array $piece * * @return string */ @@ -777,7 +1577,7 @@ protected function compileSelectorPart($piece) } switch ($p[0]) { - case 'self': + case Type::T_SELF: $p = '&'; break; @@ -805,7 +1605,7 @@ protected function hasSelectorPlaceholder($selector) foreach ($selector as $parts) { foreach ($parts as $part) { - if ('%' === $part[0]) { + if (strlen($part) && '%' === $part[0]) { return true; } } @@ -814,16 +1614,42 @@ protected function hasSelectorPlaceholder($selector) return false; } + protected function pushCallStack($name = '') + { + $this->callStack[] = [ + 'n' => $name, + Parser::SOURCE_INDEX => $this->sourceIndex, + Parser::SOURCE_LINE => $this->sourceLine, + Parser::SOURCE_COLUMN => $this->sourceColumn + ]; + + // infinite calling loop + if (count($this->callStack) > 25000) { + // not displayed but you can var_dump it to deep debug + $msg = $this->callStackMessage(true, 100); + $msg = "Infinite calling loop"; + $this->throwError($msg); + } + } + + protected function popCallStack() + { + array_pop($this->callStack); + } + /** - * Compile children + * Compile children and return result * - * @param array $stms - * @param array $out + * @param array $stms + * @param \Leafo\ScssPhp\Formatter\OutputBlock $out + * @param string $traceName * - * @return array + * @return array|null */ - protected function compileChildren($stms, $out) + protected function compileChildren($stms, OutputBlock $out, $traceName = '') { + $this->pushCallStack($traceName); + foreach ($stms as $stm) { $ret = $this->compileChild($stm, $out); @@ -831,45 +1657,188 @@ protected function compileChildren($stms, $out) return $ret; } } + + $this->popCallStack(); + + return null; } /** - * Compile media query + * Compile children and throw exception if unexpected @return * - * @param array $queryList + * @param array $stms + * @param \Leafo\ScssPhp\Formatter\OutputBlock $out + * @param \Leafo\ScssPhp\Block $selfParent + * @param string $traceName * - * @return string + * @throws \Exception */ - protected function compileMediaQuery($queryList) + protected function compileChildrenNoReturn($stms, OutputBlock $out, $selfParent = null, $traceName = '') { - $out = '@media'; - $first = true; + $this->pushCallStack($traceName); - foreach ($queryList as $query) { - $type = null; - $parts = array(); + foreach ($stms as $stm) { + if ($selfParent && isset($stm[1]) && is_object($stm[1]) && $stm[1] instanceof Block) { + $stm[1]->selfParent = $selfParent; + $ret = $this->compileChild($stm, $out); + $stm[1]->selfParent = null; + } elseif ($selfParent && $stm[0] === TYPE::T_INCLUDE) { + $stm['selfParent'] = $selfParent; + $ret = $this->compileChild($stm, $out); + unset($stm['selfParent']); + } else { + $ret = $this->compileChild($stm, $out); + } - foreach ($query as $q) { - switch ($q[0]) { - case 'mediaType': - if ($type) { - $type = $this->mergeMediaTypes( - $type, - array_map(array($this, 'compileValue'), array_slice($q, 1)) - ); - - if (empty($type)) { // merge failed - return null; - } - } else { - $type = array_map(array($this, 'compileValue'), array_slice($q, 1)); - } - break; + if (isset($ret)) { + $this->throwError('@return may only be used within a function'); - case 'mediaExp': - if (isset($q[2])) { - $parts[] = '(' - . $this->compileValue($q[1]) + return; + } + } + + $this->popCallStack(); + } + + + /** + * evaluate media query : compile internal value keeping the structure inchanged + * + * @param array $queryList + * + * @return array + */ + protected function evaluateMediaQuery($queryList) + { + foreach ($queryList as $kql => $query) { + foreach ($query as $kq => $q) { + for ($i = 1; $i < count($q); $i++) { + $value = $this->compileValue($q[$i]); + + // the parser had no mean to know if media type or expression if it was an interpolation + if ($q[0] == Type::T_MEDIA_TYPE && + (strpos($value, '(') !== false || + strpos($value, ')') !== false || + strpos($value, ':') !== false) + ) { + $queryList[$kql][$kq][0] = Type::T_MEDIA_EXPRESSION; + + if (strpos($value, 'and') !== false) { + $values = explode('and', $value); + $value = trim(array_pop($values)); + + while ($v = trim(array_pop($values))) { + $type = Type::T_MEDIA_EXPRESSION; + + if (strpos($v, '(') === false && + strpos($v, ')') === false && + strpos($v, ':') === false + ) { + $type = Type::T_MEDIA_TYPE; + } + + if (substr($v, 0, 1) === '(' && substr($v, -1) === ')') { + $v = substr($v, 1, -1); + } + + $queryList[$kql][] = [$type,[Type::T_KEYWORD, $v]]; + } + } + + if (substr($value, 0, 1) === '(' && substr($value, -1) === ')') { + $value = substr($value, 1, -1); + } + } + + $queryList[$kql][$kq][$i] = [Type::T_KEYWORD, $value]; + } + } + } + + return $queryList; + } + + /** + * Compile media query + * + * @param array $queryList + * + * @return array + */ + protected function compileMediaQuery($queryList) + { + $start = '@media '; + $default = trim($start); + $out = []; + $current = ""; + + foreach ($queryList as $query) { + $type = null; + $parts = []; + + $mediaTypeOnly = true; + + foreach ($query as $q) { + if ($q[0] !== Type::T_MEDIA_TYPE) { + $mediaTypeOnly = false; + break; + } + } + + foreach ($query as $q) { + switch ($q[0]) { + case Type::T_MEDIA_TYPE: + $newType = array_map([$this, 'compileValue'], array_slice($q, 1)); + // combining not and anything else than media type is too risky and should be avoided + if (! $mediaTypeOnly) { + if (in_array(Type::T_NOT, $newType) || ($type && in_array(Type::T_NOT, $type) )) { + if ($type) { + array_unshift($parts, implode(' ', array_filter($type))); + } + + if (! empty($parts)) { + if (strlen($current)) { + $current .= $this->formatter->tagSeparator; + } + + $current .= implode(' and ', $parts); + } + + if ($current) { + $out[] = $start . $current; + } + + $current = ""; + $type = null; + $parts = []; + } + } + + if ($newType === ['all'] && $default) { + $default = $start . 'all'; + } + + // all can be safely ignored and mixed with whatever else + if ($newType !== ['all']) { + if ($type) { + $type = $this->mergeMediaTypes($type, $newType); + + if (empty($type)) { + // merge failed : ignore this query that is not valid, skip to the next one + $parts = []; + $default = ''; // if everything fail, no @media at all + continue 3; + } + } else { + $type = $newType; + } + } + break; + + case Type::T_MEDIA_EXPRESSION: + if (isset($q[2])) { + $parts[] = '(' + . $this->compileValue($q[1]) . $this->formatter->assignSeparator . $this->compileValue($q[2]) . ')'; @@ -879,6 +1848,10 @@ protected function compileMediaQuery($queryList) . ')'; } break; + + case Type::T_MEDIA_VALUE: + $parts[] = $this->compileValue($q[1]); + break; } } @@ -887,20 +1860,70 @@ protected function compileMediaQuery($queryList) } if (! empty($parts)) { - if ($first) { - $first = false; - $out .= ' '; - } else { - $out .= $this->formatter->tagSeparator; + if (strlen($current)) { + $current .= $this->formatter->tagSeparator; } - $out .= implode(' and ', $parts); + $current .= implode(' and ', $parts); } } + if ($current) { + $out[] = $start . $current; + } + + // no @media type except all, and no conflict? + if (! $out && $default) { + $out[] = $default; + } + return $out; } + /** + * Merge direct relationships between selectors + * + * @param array $selectors1 + * @param array $selectors2 + * + * @return array + */ + protected function mergeDirectRelationships($selectors1, $selectors2) + { + if (empty($selectors1) || empty($selectors2)) { + return array_merge($selectors1, $selectors2); + } + + $part1 = end($selectors1); + $part2 = end($selectors2); + + if (! $this->isImmediateRelationshipCombinator($part1[0]) && $part1 !== $part2) { + return array_merge($selectors1, $selectors2); + } + + $merged = []; + + do { + $part1 = array_pop($selectors1); + $part2 = array_pop($selectors2); + + if (! $this->isImmediateRelationshipCombinator($part1[0]) && $part1 !== $part2) { + if ($this->isImmediateRelationshipCombinator(reset($merged)[0])) { + array_unshift($merged, [$part1[0] . $part2[0]]); + $merged = array_merge($selectors1, $selectors2, $merged); + } else { + $merged = array_merge($selectors1, [$part1], $selectors2, [$part2], $merged); + } + + break; + } + + array_unshift($merged, $part1); + } while (! empty($selectors1) && ! empty($selectors2)); + + return $merged; + } + /** * Merge media types * @@ -939,24 +1962,24 @@ protected function mergeMediaTypes($type1, $type2) $t2 = strtolower($type2[0]); } - if (($m1 === 'not') ^ ($m2 === 'not')) { + if (($m1 === Type::T_NOT) ^ ($m2 === Type::T_NOT)) { if ($t1 === $t2) { return null; } - return array( - $m1 === 'not' ? $m2 : $m1, - $m1 === 'not' ? $t2 : $t1 - ); + return [ + $m1 === Type::T_NOT ? $m2 : $m1, + $m1 === Type::T_NOT ? $t2 : $t1, + ]; } - if ($m1 === 'not' && $m2 === 'not') { + if ($m1 === Type::T_NOT && $m2 === Type::T_NOT) { // CSS has no way of representing "neither screen nor print" if ($t1 !== $t2) { return null; } - return array('not', $t1); + return [Type::T_NOT, $t1]; } if ($t1 !== $t2) { @@ -964,24 +1987,28 @@ protected function mergeMediaTypes($type1, $type2) } // t1 == t2, neither m1 nor m2 are "not" - return array(empty($m1)? $m2 : $m1, $t1); + return [empty($m1)? $m2 : $m1, $t1]; } /** * Compile import; returns true if the value was something that could be imported * - * @param array $rawPath - * @param array $out + * @param array $rawPath + * @param \Leafo\ScssPhp\Formatter\OutputBlock $out + * @param boolean $once * * @return boolean */ - protected function compileImport($rawPath, $out) + protected function compileImport($rawPath, OutputBlock $out, $once = false) { - if ($rawPath[0] === 'string') { + if ($rawPath[0] === Type::T_STRING) { $path = $this->compileStringContent($rawPath); if ($path = $this->findImport($path)) { - $this->importFile($path, $out); + if (! $once || ! in_array($path, $this->importedFiles)) { + $this->importFile($path, $out); + $this->importedFiles[] = $path; + } return true; } @@ -989,14 +2016,14 @@ protected function compileImport($rawPath, $out) return false; } - if ($rawPath[0] === 'list') { + if ($rawPath[0] === Type::T_LIST) { // handle a list of strings if (count($rawPath[2]) === 0) { return false; } foreach ($rawPath[2] as $path) { - if ($path[0] !== 'string') { + if ($path[0] !== Type::T_STRING) { return false; } } @@ -1014,48 +2041,64 @@ protected function compileImport($rawPath, $out) /** * Compile child; returns a value to halt execution * - * @param array $child - * @param \stdClass $out + * @param array $child + * @param \Leafo\ScssPhp\Formatter\OutputBlock $out * * @return array */ - protected function compileChild($child, $out) - { - $this->sourcePos = isset($child[Parser::SOURCE_POSITION]) ? $child[Parser::SOURCE_POSITION] : -1; - $this->sourceParser = isset($child[Parser::SOURCE_PARSER]) ? $child[Parser::SOURCE_PARSER] : $this->parser; + protected function compileChild($child, OutputBlock $out) + { + if (isset($child[Parser::SOURCE_LINE])) { + $this->sourceIndex = isset($child[Parser::SOURCE_INDEX]) ? $child[Parser::SOURCE_INDEX] : null; + $this->sourceLine = isset($child[Parser::SOURCE_LINE]) ? $child[Parser::SOURCE_LINE] : -1; + $this->sourceColumn = isset($child[Parser::SOURCE_COLUMN]) ? $child[Parser::SOURCE_COLUMN] : -1; + } elseif (is_array($child) && isset($child[1]->sourceLine)) { + $this->sourceIndex = $child[1]->sourceIndex; + $this->sourceLine = $child[1]->sourceLine; + $this->sourceColumn = $child[1]->sourceColumn; + } elseif (! empty($out->sourceLine) && ! empty($out->sourceName)) { + $this->sourceLine = $out->sourceLine; + $this->sourceIndex = array_search($out->sourceName, $this->sourceNames); + + if ($this->sourceIndex === false) { + $this->sourceIndex = null; + } + } switch ($child[0]) { - case 'import': - list(, $rawPath) = $child; + case Type::T_SCSSPHP_IMPORT_ONCE: + $rawPath = $this->reduce($child[1]); - $rawPath = $this->reduce($rawPath); - - if (! $this->compileImport($rawPath, $out)) { + if (! $this->compileImport($rawPath, $out, true)) { $out->lines[] = '@import ' . $this->compileValue($rawPath) . ';'; } break; - case 'directive': - list(, $directive) = $child; + case Type::T_IMPORT: + $rawPath = $this->reduce($child[1]); - $s = '@' . $directive->name; - - if (! empty($directive->value)) { - $s .= ' ' . $this->compileValue($directive->value); + if (! $this->compileImport($rawPath, $out)) { + $out->lines[] = '@import ' . $this->compileValue($rawPath) . ';'; } + break; - $this->compileNestedBlock($directive, array($s)); + case Type::T_DIRECTIVE: + $this->compileDirective($child[1]); break; - case 'media': + case Type::T_AT_ROOT: + $this->compileAtRoot($child[1]); + break; + + case Type::T_MEDIA: $this->compileMedia($child[1]); break; - case 'block': + case Type::T_BLOCK: $this->compileBlock($child[1]); break; - case 'charset': + case Type::T_CHARSET: if (! $this->charsetSeen) { $this->charsetSeen = true; @@ -1063,25 +2106,25 @@ protected function compileChild($child, $out) } break; - case 'assign': + case Type::T_ASSIGN: list(, $name, $value) = $child; - if ($name[0] === 'var') { - $flag = isset($child[3]) ? $child[3] : null; - $isDefault = $flag === '!default'; - $isGlobal = $flag === '!global'; + if ($name[0] === Type::T_VARIABLE) { + $flags = isset($child[3]) ? $child[3] : []; + $isDefault = in_array('!default', $flags); + $isGlobal = in_array('!global', $flags); if ($isGlobal) { - $this->set($name[1], $this->reduce($value), false, $this->rootEnv); + $this->set($name[1], $this->reduce($value), false, $this->rootEnv, $value); break; } $shouldSet = $isDefault && (($result = $this->get($name[1], false)) === null - || $result === self::$null); + || $result === static::$null); if (! $isDefault || $shouldSet) { - $this->set($name[1], $this->reduce($value)); + $this->set($name[1], $this->reduce($value), true, null, $value); } break; } @@ -1089,12 +2132,26 @@ protected function compileChild($child, $out) $compiledName = $this->compileValue($name); // handle shorthand syntax: size / line-height - if ($compiledName === 'font') { - if ($value[0] === 'exp' && $value[1] === '/') { - $value = $this->expToString($value); - } elseif ($value[0] === 'list') { - foreach ($value[2] as &$item) { - if ($item[0] === 'exp' && $item[1] === '/') { + if ($compiledName === 'font' || $compiledName === 'grid-row' || $compiledName === 'grid-column') { + if ($value[0] === Type::T_VARIABLE) { + // if the font value comes from variable, the content is already reduced + // (i.e., formulas were already calculated), so we need the original unreduced value + $value = $this->get($value[1], true, null, true); + } + + $fontValue=&$value; + + if ($value[0] === Type::T_LIST && $value[1]==',') { + // this is the case if more than one font is given: example: "font: 400 1em/1.3 arial,helvetica" + // we need to handle the first list element + $fontValue=&$value[2][0]; + } + + if ($fontValue[0] === Type::T_EXPRESSION && $fontValue[1] === '/') { + $fontValue = $this->expToString($fontValue); + } elseif ($fontValue[0] === Type::T_LIST) { + foreach ($fontValue[2] as &$item) { + if ($item[0] === Type::T_EXPRESSION && $item[1] === '/') { $item = $this->expToString($item); } } @@ -1103,10 +2160,10 @@ protected function compileChild($child, $out) // if the value reduces to null from something else then // the property should be discarded - if ($value[0] !== 'null') { + if ($value[0] !== Type::T_NULL) { $value = $this->reduce($value); - if ($value[0] === 'null') { + if ($value[0] === Type::T_NULL || $value === static::$nullString) { break; } } @@ -1119,8 +2176,8 @@ protected function compileChild($child, $out) ); break; - case 'comment': - if ($out->type === 'root') { + case Type::T_COMMENT: + if ($out->type === Type::T_ROOT) { $this->compileComment($child); break; } @@ -1128,26 +2185,27 @@ protected function compileChild($child, $out) $out->lines[] = $child[1]; break; - case 'mixin': - case 'function': + case Type::T_MIXIN: + case Type::T_FUNCTION: list(, $block) = $child; - $this->set(self::$namespaces[$block->type] . $block->name, $block); + $this->set(static::$namespaces[$block->type] . $block->name, $block); break; - case 'extend': - list(, $selectors) = $child; + case Type::T_EXTEND: + foreach ($child[1] as $sel) { + $results = $this->evalSelectors([$sel]); - foreach ($selectors as $sel) { - // only use the first one - $result = $this->evalSelectors(array($sel)); - $result = current($result[0]); + foreach ($results as $result) { + // only use the first one + $result = current($result); - $this->pushExtends($result, $out->selectors); + $this->pushExtends($result, $out->selectors, $child); + } } break; - case 'if': + case Type::T_IF: list(, $if) = $child; if ($this->isTruthy($this->reduce($if->cond, true))) { @@ -1155,18 +2213,15 @@ protected function compileChild($child, $out) } foreach ($if->cases as $case) { - if ($case->type === 'else' || - $case->type === 'elseif' && $this->isTruthy($this->reduce($case->cond)) + if ($case->type === Type::T_ELSE || + $case->type === Type::T_ELSEIF && $this->isTruthy($this->reduce($case->cond)) ) { return $this->compileChildren($case->children, $out); } } break; - case 'return': - return $this->reduce($child[1], true); - - case 'each': + case Type::T_EACH: list(, $each) = $child; $list = $this->coerceList($this->reduce($each->list)); @@ -1180,102 +2235,168 @@ protected function compileChild($child, $out) list(,, $values) = $this->coerceList($item); foreach ($each->vars as $i => $var) { - $this->set($var, isset($values[$i]) ? $values[$i] : self::$null, true); + $this->set($var, isset($values[$i]) ? $values[$i] : static::$null, true); } } $ret = $this->compileChildren($each->children, $out); if ($ret) { - $this->popEnv(); + if ($ret[0] !== Type::T_CONTROL) { + $this->popEnv(); + + return $ret; + } - return $ret; + if ($ret[1]) { + break; + } } } $this->popEnv(); break; - case 'while': + case Type::T_WHILE: list(, $while) = $child; while ($this->isTruthy($this->reduce($while->cond, true))) { $ret = $this->compileChildren($while->children, $out); if ($ret) { - return $ret; + if ($ret[0] !== Type::T_CONTROL) { + return $ret; + } + + if ($ret[1]) { + break; + } } } break; - case 'for': + case Type::T_FOR: list(, $for) = $child; $start = $this->reduce($for->start, true); + $end = $this->reduce($for->end, true); + + if (! ($start[2] == $end[2] || $end->unitless())) { + $this->throwError('Incompatible units: "%s" and "%s".', $start->unitStr(), $end->unitStr()); + + break; + } + + $unit = $start[2]; $start = $start[1]; - $end = $this->reduce($for->end, true); - $end = $end[1]; + $end = $end[1]; + $d = $start < $end ? 1 : -1; - while (true) { + for (;;) { if ((! $for->until && $start - $d == $end) || ($for->until && $start == $end) ) { break; } - $this->set($for->var, array('number', $start, '')); + $this->set($for->var, new Node\Number($start, $unit)); $start += $d; $ret = $this->compileChildren($for->children, $out); if ($ret) { - return $ret; + if ($ret[0] !== Type::T_CONTROL) { + return $ret; + } + + if ($ret[1]) { + break; + } } } break; - case 'nestedprop': + case Type::T_BREAK: + return [Type::T_CONTROL, true]; + + case Type::T_CONTINUE: + return [Type::T_CONTROL, false]; + + case Type::T_RETURN: + return $this->reduce($child[1], true); + + case Type::T_NESTED_PROPERTY: list(, $prop) = $child; - $prefixed = array(); + $prefixed = []; $prefix = $this->compileValue($prop->prefix) . '-'; foreach ($prop->children as $child) { - if ($child[0] === 'assign') { - array_unshift($child[1][2], $prefix); - } - - if ($child[0] === 'nestedprop') { - array_unshift($child[1]->prefix[2], $prefix); + switch ($child[0]) { + case Type::T_ASSIGN: + array_unshift($child[1][2], $prefix); + break; + + case Type::T_NESTED_PROPERTY: + array_unshift($child[1]->prefix[2], $prefix); + break; } $prefixed[] = $child; } - $this->compileChildren($prefixed, $out); + $this->compileChildrenNoReturn($prefixed, $out); break; - case 'include': + case Type::T_INCLUDE: // including a mixin list(, $name, $argValues, $content) = $child; - $mixin = $this->get(self::$namespaces['mixin'] . $name, false); + $mixin = $this->get(static::$namespaces['mixin'] . $name, false); if (! $mixin) { $this->throwError("Undefined mixin $name"); + break; } - $callingScope = $this->env; + $callingScope = $this->getStoreEnv(); // push scope, apply args $this->pushEnv(); $this->env->depth--; + $storeEnv = $this->storeEnv; + $this->storeEnv = $this->env; + + // Find the parent selectors in the env to be able to know what '&' refers to in the mixin + // and assign this fake parent to childs + $selfParent = null; + + if (isset($child['selfParent']) && isset($child['selfParent']->selectors)) { + $selfParent = $child['selfParent']; + } else { + $parentSelectors = $this->multiplySelectors($this->env); + + if ($parentSelectors) { + $parent = new Block(); + $parent->selectors = $parentSelectors; + + foreach ($mixin->children as $k => $child) { + if (isset($child[1]) && is_object($child[1]) && $child[1] instanceof Block) { + $mixin->children[$k][1]->parent = $parent; + } + } + } + } + + // clone the stored content to not have its scope spoiled by a further call to the same mixin + // i.e., recursive @include of the same mixin if (isset($content)) { - $content->scope = $callingScope; + $copyContent = clone $content; + $copyContent->scope = $callingScope; - $this->setRaw(self::$namespaces['special'] . 'content', $content); + $this->setRaw(static::$namespaces['special'] . 'content', $copyContent, $this->env); } if (isset($mixin->args)) { @@ -1284,58 +2405,60 @@ protected function compileChild($child, $out) $this->env->marker = 'mixin'; - foreach ($mixin->children as $child) { - $this->compileChild($child, $out); - } + $this->compileChildrenNoReturn($mixin->children, $out, $selfParent, $this->env->marker . " " . $name); + + $this->storeEnv = $storeEnv; $this->popEnv(); break; - case 'mixin_content': - $content = $this->get(self::$namespaces['special'] . 'content', false); + case Type::T_MIXIN_CONTENT: + $env = isset($this->storeEnv) ? $this->storeEnv : $this->env; + $content = $this->get(static::$namespaces['special'] . 'content', false, $env); if (! $content) { - $this->throwError('Expected @content inside of mixin'); - } - - if (! isset($content->children)) { + $content = new \stdClass(); + $content->scope = new \stdClass(); + $content->children = $this->storeEnv->parent->block->children; break; } + $storeEnv = $this->storeEnv; $this->storeEnv = $content->scope; - //$this->pushEnv(); - - foreach ($content->children as $child) { - $this->compileChild($child, $out); - } - - //$this->popEnv(); - $this->storeEnv = null; + $this->compileChildrenNoReturn($content->children, $out); + $this->storeEnv = $storeEnv; break; - case 'debug': + case Type::T_DEBUG: list(, $value) = $child; - $line = $this->parser->getLineNo($this->sourcePos); + $fname = $this->sourceNames[$this->sourceIndex]; + $line = $this->sourceLine; $value = $this->compileValue($this->reduce($value, true)); - fwrite($this->stderr, "Line $line DEBUG: $value\n"); + fwrite($this->stderr, "File $fname on line $line DEBUG: $value\n"); break; - case 'warn': + case Type::T_WARN: list(, $value) = $child; - $line = $this->parser->getLineNo($this->sourcePos); + $fname = $this->sourceNames[$this->sourceIndex]; + $line = $this->sourceLine; $value = $this->compileValue($this->reduce($value, true)); - echo "Line $line WARN: $value\n"; + fwrite($this->stderr, "File $fname on line $line WARN: $value\n"); break; - case 'error': + case Type::T_ERROR: list(, $value) = $child; - $line = $this->parser->getLineNo($this->sourcePos); + $fname = $this->sourceNames[$this->sourceIndex]; + $line = $this->sourceLine; $value = $this->compileValue($this->reduce($value, true)); - $this->throwError("Line $line ERROR: $value\n"); + $this->throwError("File $fname on line $line ERROR: $value\n"); + break; + + case Type::T_CONTROL: + $this->throwError('@break/@continue not permitted in this scope'); break; default: @@ -1352,9 +2475,9 @@ protected function compileChild($child, $out) */ protected function expToString($exp) { - list(, $op, $left, $right, $inParens, $whiteLeft, $whiteRight) = $exp; + list(, $op, $left, $right, /* $inParens */, $whiteLeft, $whiteRight) = $exp; - $content = array($this->reduce($left)); + $content = [$this->reduce($left)]; if ($whiteLeft) { $content[] = ' '; @@ -1368,7 +2491,7 @@ protected function expToString($exp) $content[] = $this->reduce($right); - return array('string', '', $content); + return [Type::T_STRING, '', $content]; } /** @@ -1376,11 +2499,23 @@ protected function expToString($exp) * * @param array $value * - * @return array + * @return boolean */ protected function isTruthy($value) { - return $value !== self::$false && $value !== self::$null; + return $value !== static::$false && $value !== static::$null; + } + + /** + * Is the value a direct relationship combinator? + * + * @param string $value + * + * @return boolean + */ + protected function isImmediateRelationshipCombinator($value) + { + return $value === '>' || $value === '+' || $value === '~'; } /** @@ -1393,14 +2528,14 @@ protected function isTruthy($value) protected function shouldEval($value) { switch ($value[0]) { - case 'exp': + case Type::T_EXPRESSION: if ($value[1] === '/') { - return $this->shouldEval($value[2], $value[3]); + return $this->shouldEval($value[2]) || $this->shouldEval($value[3]); } // fall-thru - case 'var': - case 'fncall': + case Type::T_VARIABLE: + case Type::T_FUNCTION_CALL: return true; } @@ -1413,24 +2548,29 @@ protected function shouldEval($value) * @param array $value * @param boolean $inExp * - * @return array + * @return array|\Leafo\ScssPhp\Node\Number */ protected function reduce($value, $inExp = false) { - list($type) = $value; - switch ($type) { - case 'exp': + switch ($value[0]) { + case Type::T_EXPRESSION: list(, $op, $left, $right, $inParens) = $value; - $opName = isset(self::$operatorNames[$op]) ? self::$operatorNames[$op] : $op; + $opName = isset(static::$operatorNames[$op]) ? static::$operatorNames[$op] : $op; $inExp = $inExp || $this->shouldEval($left) || $this->shouldEval($right); $left = $this->reduce($left, true); - $right = $this->reduce($right, true); - // special case: looks like css short-hand - if ($opName === 'div' && ! $inParens && ! $inExp && isset($right[2]) && $right[2] !== '') { + if ($op !== 'and' && $op !== 'or') { + $right = $this->reduce($right, true); + } + + // special case: looks like css shorthand + if ($opName == 'div' && ! $inParens && ! $inExp && isset($right[2]) + && (($right[0] !== Type::T_NUMBER && $right[2] != '') + || ($right[0] === Type::T_NUMBER && ! $right->unitless())) + ) { return $this->expToString($value); } @@ -1450,47 +2590,49 @@ protected function reduce($value, $inExp = false) // 3. op[op name] $fn = "op${ucOpName}${ucLType}${ucRType}"; - if (is_callable(array($this, $fn)) || + if (is_callable([$this, $fn]) || (($fn = "op${ucLType}${ucRType}") && - is_callable(array($this, $fn)) && + is_callable([$this, $fn]) && $passOp = true) || (($fn = "op${ucOpName}") && - is_callable(array($this, $fn)) && + is_callable([$this, $fn]) && $genOp = true) ) { - $unitChange = false; + $coerceUnit = false; if (! isset($genOp) && - $left[0] === 'number' && $right[0] === 'number' + $left[0] === Type::T_NUMBER && $right[0] === Type::T_NUMBER ) { - if ($opName === 'mod' && $right[2] !== '') { - $this->throwError("Cannot modulo by a number with units: $right[1]$right[2]."); - } + $coerceUnit = true; - $unitChange = true; - $emptyUnit = $left[2] === '' || $right[2] === ''; - $targetUnit = '' !== $left[2] ? $left[2] : $right[2]; + switch ($opName) { + case 'mul': + $targetUnit = $left[2]; - if ($opName !== 'mul') { - $left[2] = '' !== $left[2] ? $left[2] : $targetUnit; - $right[2] = '' !== $right[2] ? $right[2] : $targetUnit; - } + foreach ($right[2] as $unit => $exp) { + $targetUnit[$unit] = (isset($targetUnit[$unit]) ? $targetUnit[$unit] : 0) + $exp; + } + break; - if ($opName !== 'mod') { - $left = $this->normalizeNumber($left); - $right = $this->normalizeNumber($right); - } + case 'div': + $targetUnit = $left[2]; + + foreach ($right[2] as $unit => $exp) { + $targetUnit[$unit] = (isset($targetUnit[$unit]) ? $targetUnit[$unit] : 0) - $exp; + } + break; - if ($opName === 'div' && ! $emptyUnit && $left[2] === $right[2]) { - $targetUnit = ''; + case 'mod': + $targetUnit = $left[2]; + break; + + default: + $targetUnit = $left->unitless() ? $right[2] : $left[2]; } - if ($opName === 'mul') { - $left[2] = '' !== $left[2] ? $left[2] : $right[2]; - $right[2] = '' !== $right[2] ? $right[2] : $left[2]; - } elseif ($opName === 'div' && $left[2] === $right[2]) { - $left[2] = ''; - $right[2] = ''; + if (! $left->unitless() && ! $right->unitless()) { + $left = $left->normalize(); + $right = $right->normalize(); } } @@ -1503,8 +2645,8 @@ protected function reduce($value, $inExp = false) } if (isset($out)) { - if ($unitChange && $out[0] === 'number') { - $out = $this->coerceUnit($out, $targetUnit); + if ($coerceUnit && $out[0] === Type::T_NUMBER) { + $out = $out->coerce($targetUnit); } return $out; @@ -1513,51 +2655,47 @@ protected function reduce($value, $inExp = false) return $this->expToString($value); - case 'unary': + case Type::T_UNARY: list(, $op, $exp, $inParens) = $value; $inExp = $inExp || $this->shouldEval($exp); $exp = $this->reduce($exp); - if ($exp[0] === 'number') { + if ($exp[0] === Type::T_NUMBER) { switch ($op) { case '+': - return $exp; + return new Node\Number($exp[1], $exp[2]); case '-': - $exp[1] *= -1; - - return $exp; + return new Node\Number(-$exp[1], $exp[2]); } } if ($op === 'not') { if ($inExp || $inParens) { - if ($exp === self::$false) { - return self::$true; + if ($exp === static::$false || $exp === static::$null) { + return static::$true; } - return self::$false; + return static::$false; } $op = $op . ' '; } - return array('string', '', array($op, $exp)); + return [Type::T_STRING, '', [$op, $exp]]; - case 'var': - list(, $name) = $value; + case Type::T_VARIABLE: + return $this->reduce($this->get($value[1])); - return $this->reduce($this->get($name)); - - case 'list': + case Type::T_LIST: foreach ($value[2] as &$item) { $item = $this->reduce($item); } return $value; - case 'map': + case Type::T_MAP: foreach ($value[1] as &$item) { $item = $this->reduce($item); } @@ -1568,66 +2706,66 @@ protected function reduce($value, $inExp = false) return $value; - case 'string': + case Type::T_STRING: foreach ($value[2] as &$item) { - if (is_array($item)) { + if (is_array($item) || $item instanceof \ArrayAccess) { $item = $this->reduce($item); } } return $value; - case 'interpolate': + case Type::T_INTERPOLATE: $value[1] = $this->reduce($value[1]); + if ($inExp) { + return $value[1]; + } return $value; - case 'fncall': - list(, $name, $argValues) = $value; - - // user defined function? - $func = $this->get(self::$namespaces['function'] . $name, false); - - if ($func) { - $this->pushEnv(); - - // set the args - if (isset($func->args)) { - $this->applyArguments($func->args, $argValues); - } - - // throw away lines and children - $tmp = (object)array( - 'lines' => array(), - 'children' => array() - ); - - $ret = $this->compileChildren($func->children, $tmp); - - $this->popEnv(); + case Type::T_FUNCTION_CALL: + return $this->fncall($value[1], $value[2]); - return ! isset($ret) ? self::$defaultValue : $ret; - } + case Type::T_SELF: + $selfSelector = $this->multiplySelectors($this->env); + $selfSelector = $this->collapseSelectors($selfSelector, true); + return $selfSelector; - // built in function - if ($this->callBuiltin($name, $argValues, $returnValue)) { - return $returnValue; - } + default: + return $value; + } + } - // need to flatten the arguments into a list - $listArgs = array(); + /** + * Function caller + * + * @param string $name + * @param array $argValues + * + * @return array|null + */ + protected function fncall($name, $argValues) + { + // SCSS @function + if ($this->callScssFunction($name, $argValues, $returnValue)) { + return $returnValue; + } - foreach ((array)$argValues as $arg) { - if (empty($arg[0])) { - $listArgs[] = $this->reduce($arg[1]); - } - } + // native PHP functions + if ($this->callNativeFunction($name, $argValues, $returnValue)) { + return $returnValue; + } - return array('function', $name, array('list', ',', $listArgs)); + // for CSS functions, simply flatten the arguments into a list + $listArgs = []; - default: - return $value; + foreach ((array) $argValues as $arg) { + if (empty($arg[0])) { + $listArgs[] = $this->reduce($arg[1]); + } } + + return [Type::T_FUNCTION, $name, [Type::T_LIST, ',', $listArgs]]; } /** @@ -1652,14 +2790,13 @@ protected function normalizeName($name) public function normalizeValue($value) { $value = $this->coerceForExpression($this->reduce($value)); - list($type) = $value; - switch ($type) { - case 'list': + switch ($value[0]) { + case Type::T_LIST: $value = $this->extractInterpolation($value); - if ($value[0] !== 'list') { - return array('keyword', $this->compileValue($value)); + if ($value[0] !== Type::T_LIST) { + return [Type::T_KEYWORD, $this->compileValue($value)]; } foreach ($value[2] as $key => $item) { @@ -1668,48 +2805,31 @@ public function normalizeValue($value) return $value; - case 'string': - return array($type, '"', $this->compileStringContent($value)); + case Type::T_STRING: + return [$value[0], '"', [$this->compileStringContent($value)]]; + + case Type::T_NUMBER: + return $value->normalize(); - case 'number': - return $this->normalizeNumber($value); + case Type::T_INTERPOLATE: + return [Type::T_KEYWORD, $this->compileValue($value)]; default: return $value; } } - /** - * Normalize number; just does physical lengths for now - * - * @param array $number - * - * @return array - */ - protected function normalizeNumber($number) - { - list(, $value, $unit) = $number; - - if (isset(self::$unitTable['in'][$unit])) { - $conv = self::$unitTable['in'][$unit]; - - return array('number', $value / $conv, 'in'); - } - - return $number; - } - /** * Add numbers * * @param array $left * @param array $right * - * @return array + * @return \Leafo\ScssPhp\Node\Number */ protected function opAddNumberNumber($left, $right) { - return array('number', $left[1] + $right[1], $left[2]); + return new Node\Number($left[1] + $right[1], $left[2]); } /** @@ -1718,11 +2838,11 @@ protected function opAddNumberNumber($left, $right) * @param array $left * @param array $right * - * @return array + * @return \Leafo\ScssPhp\Node\Number */ protected function opMulNumberNumber($left, $right) { - return array('number', $left[1] * $right[1], $left[2]); + return new Node\Number($left[1] * $right[1], $left[2]); } /** @@ -1731,11 +2851,11 @@ protected function opMulNumberNumber($left, $right) * @param array $left * @param array $right * - * @return array + * @return \Leafo\ScssPhp\Node\Number */ protected function opSubNumberNumber($left, $right) { - return array('number', $left[1] - $right[1], $left[2]); + return new Node\Number($left[1] - $right[1], $left[2]); } /** @@ -1744,15 +2864,15 @@ protected function opSubNumberNumber($left, $right) * @param array $left * @param array $right * - * @return array + * @return array|\Leafo\ScssPhp\Node\Number */ protected function opDivNumberNumber($left, $right) { if ($right[1] == 0) { - $this->throwError('Division by zero'); + return [Type::T_STRING, '', [$left[1] . $left[2] . '/' . $right[1] . $right[2]]]; } - return array('number', $left[1] / $right[1], $left[2]); + return new Node\Number($left[1] / $right[1], $left[2]); } /** @@ -1761,11 +2881,11 @@ protected function opDivNumberNumber($left, $right) * @param array $left * @param array $right * - * @return array + * @return \Leafo\ScssPhp\Node\Number */ protected function opModNumberNumber($left, $right) { - return array('number', $left[1] % $right[1], $left[2]); + return new Node\Number($left[1] % $right[1], $left[2]); } /** @@ -1774,12 +2894,12 @@ protected function opModNumberNumber($left, $right) * @param array $left * @param array $right * - * @return array + * @return array|null */ protected function opAdd($left, $right) { if ($strLeft = $this->coerceString($left)) { - if ($right[0] === 'string') { + if ($right[0] === Type::T_STRING) { $right[1] = ''; } @@ -1789,7 +2909,7 @@ protected function opAdd($left, $right) } if ($strRight = $this->coerceString($right)) { - if ($left[0] === 'string') { + if ($left[0] === Type::T_STRING) { $left[1] = ''; } @@ -1797,6 +2917,8 @@ protected function opAdd($left, $right) return $strRight; } + + return null; } /** @@ -1806,16 +2928,22 @@ protected function opAdd($left, $right) * @param array $right * @param boolean $shouldEval * - * @return array + * @return array|null */ protected function opAnd($left, $right, $shouldEval) { + $truthy = ($left === static::$null || $right === static::$null) || + ($left === static::$false || $left === static::$true) && + ($right === static::$false || $right === static::$true); + if (! $shouldEval) { - return; + if (! $truthy) { + return null; + } } - if ($left !== self::$false) { - return $right; + if ($left !== static::$false && $left !== static::$null) { + return $this->reduce($right, true); } return $left; @@ -1828,19 +2956,25 @@ protected function opAnd($left, $right, $shouldEval) * @param array $right * @param boolean $shouldEval * - * @return array + * @return array|null */ protected function opOr($left, $right, $shouldEval) { + $truthy = ($left === static::$null || $right === static::$null) || + ($left === static::$false || $left === static::$true) && + ($right === static::$false || $right === static::$true); + if (! $shouldEval) { - return; + if (! $truthy) { + return null; + } } - if ($left !== self::$false) { + if ($left !== static::$false && $left !== static::$null) { return $left; } - return $right; + return $this->reduce($right, true); } /** @@ -1854,9 +2988,9 @@ protected function opOr($left, $right, $shouldEval) */ protected function opColorColor($op, $left, $right) { - $out = array('color'); + $out = [Type::T_COLOR]; - foreach (range(1, 3) as $i) { + foreach ([1, 2, 3] as $i) { $lval = isset($left[$i]) ? $left[$i] : 0; $rval = isset($right[$i]) ? $right[$i] : 0; @@ -1880,6 +3014,7 @@ protected function opColorColor($op, $left, $right) case '/': if ($rval == 0) { $this->throwError("color: Can't divide by zero"); + break 2; } $out[] = (int) ($lval / $rval); @@ -1893,6 +3028,7 @@ protected function opColorColor($op, $left, $right) default: $this->throwError("color: unknown op $op"); + break 2; } } @@ -1921,7 +3057,7 @@ protected function opColorNumber($op, $left, $right) return $this->opColorColor( $op, $left, - array('color', $value, $value, $value) + [Type::T_COLOR, $value, $value, $value] ); } @@ -1940,7 +3076,7 @@ protected function opNumberColor($op, $left, $right) return $this->opColorColor( $op, - array('color', $value, $value, $value), + [Type::T_COLOR, $value, $value, $value], $right ); } @@ -2039,6 +3175,21 @@ protected function opLtNumberNumber($left, $right) return $this->toBool($left[1] < $right[1]); } + /** + * Three-way comparison, aka spaceship operator + * + * @param array $left + * @param array $right + * + * @return \Leafo\ScssPhp\Node\Number + */ + protected function opCmpNumberNumber($left, $right) + { + $n = $left[1] - $right[1]; + + return new Node\Number($n ? $n / abs($n) : 0, ''); + } + /** * Cast to boolean * @@ -2050,7 +3201,7 @@ protected function opLtNumberNumber($left, $right) */ public function toBool($thing) { - return $thing ? self::$true : self::$false; + return $thing ? static::$true : static::$false; } /** @@ -2074,13 +3225,11 @@ public function compileValue($value) { $value = $this->reduce($value); - list($type) = $value; - - switch ($type) { - case 'keyword': + switch ($value[0]) { + case Type::T_KEYWORD: return $value[1]; - case 'color': + case Type::T_COLOR: // [1] - red component (either number for a %) // [2] - green component // [3] - blue component @@ -2092,7 +3241,9 @@ public function compileValue($value) $b = round($b); if (count($value) === 5 && $value[4] !== 1) { // rgba - return 'rgba(' . $r . ', ' . $g . ', ' . $b . ', ' . $value[4] . ')'; + $a = new Node\Number($value[4], ''); + + return 'rgba(' . $r . ', ' . $g . ', ' . $b . ', ' . $a . ')'; } $h = sprintf('#%02x%02x%02x', $r, $g, $b); @@ -2104,42 +3255,46 @@ public function compileValue($value) return $h; - case 'number': - return round($value[1], $this->numberPrecision) . $value[2]; + case Type::T_NUMBER: + return $value->output($this); - case 'string': + case Type::T_STRING: return $value[1] . $this->compileStringContent($value) . $value[1]; - case 'function': + case Type::T_FUNCTION: $args = ! empty($value[2]) ? $this->compileValue($value[2]) : ''; return "$value[1]($args)"; - case 'list': + case Type::T_LIST: $value = $this->extractInterpolation($value); - if ($value[0] !== 'list') { + if ($value[0] !== Type::T_LIST) { return $this->compileValue($value); } list(, $delim, $items) = $value; - $filtered = array(); + if ($delim !== ' ') { + $delim .= ' '; + } + + $filtered = []; foreach ($items as $item) { - if ($item[0] === 'null') { + if ($item[0] === Type::T_NULL) { continue; } $filtered[] = $this->compileValue($item); } - return implode("$delim ", $filtered); + return implode("$delim", $filtered); - case 'map': + case Type::T_MAP: $keys = $value[1]; $values = $value[2]; - $filtered = array(); + $filtered = []; for ($i = 0, $s = count($keys); $i < $s; $i++) { $filtered[$this->compileValue($keys[$i])] = $this->compileValue($values[$i]); @@ -2151,7 +3306,7 @@ public function compileValue($value) return '(' . implode(', ', $filtered) . ')'; - case 'interpolated': + case Type::T_INTERPOLATED: // node created by extractInterpolation list(, $interpolate, $left, $right) = $value; list(,, $whiteLeft, $whiteRight) = $interpolate; @@ -2164,28 +3319,59 @@ public function compileValue($value) return $left . $this->compileValue($interpolate) . $right; - case 'interpolate': - // raw parse node - list(, $exp) = $value; - + case Type::T_INTERPOLATE: // strip quotes if it's a string - $reduced = $this->reduce($exp); + $reduced = $this->reduce($value[1]); + switch ($reduced[0]) { - case 'string': - $reduced = array('keyword', $this->compileStringContent($reduced)); + case Type::T_LIST: + $reduced = $this->extractInterpolation($reduced); + + if ($reduced[0] !== Type::T_LIST) { + break; + } + + list(, $delim, $items) = $reduced; + + if ($delim !== ' ') { + $delim .= ' '; + } + + $filtered = []; + + foreach ($items as $item) { + if ($item[0] === Type::T_NULL) { + continue; + } + + $temp = $this->compileValue([Type::T_KEYWORD, $item]); + if ($temp[0] === Type::T_STRING) { + $filtered[] = $this->compileStringContent($temp); + } elseif ($temp[0] === Type::T_KEYWORD) { + $filtered[] = $temp[1]; + } else { + $filtered[] = $this->compileValue($temp); + } + } + + $reduced = [Type::T_KEYWORD, implode("$delim", $filtered)]; + break; + + case Type::T_STRING: + $reduced = [Type::T_KEYWORD, $this->compileStringContent($reduced)]; break; - case 'null': - $reduced = array('keyword', ''); + case Type::T_NULL: + $reduced = [Type::T_KEYWORD, '']; } return $this->compileValue($reduced); - case 'null': + case Type::T_NULL: return 'null'; default: - $this->throwError("unknown value type: $type"); + $this->throwError("unknown value type: $value[0]"); } } @@ -2210,10 +3396,10 @@ protected function flattenList($list) */ protected function compileStringContent($string) { - $parts = array(); + $parts = []; foreach ($string[2] as $part) { - if (is_array($part)) { + if (is_array($part) || $part instanceof \ArrayAccess) { $parts[] = $this->compileValue($part); } else { $parts[] = $part; @@ -2235,11 +3421,11 @@ protected function extractInterpolation($list) $items = $list[2]; foreach ($items as $i => $item) { - if ($item[0] === 'interpolate') { - $before = array('list', $list[1], array_slice($items, 0, $i)); - $after = array('list', $list[1], array_slice($items, $i + 1)); + if ($item[0] === Type::T_INTERPOLATE) { + $before = [Type::T_LIST, $list[1], array_slice($items, 0, $i)]; + $after = [Type::T_LIST, $list[1], array_slice($items, $i + 1)]; - return array('interpolated', $item, $before, $after); + return [Type::T_INTERPOLATED, $item, $before, $after]; } } @@ -2249,67 +3435,105 @@ protected function extractInterpolation($list) /** * Find the final set of selectors * - * @param \stdClass $env + * @param \Leafo\ScssPhp\Compiler\Environment $env + * @param \Leafo\ScssPhp\Block $selfParent * * @return array */ - protected function multiplySelectors($env) + protected function multiplySelectors(Environment $env, $selfParent = null) { - $envs = array(); + $envs = $this->compactEnv($env); + $selectors = []; + $parentSelectors = [[]]; - while (null !== $env) { - if (! empty($env->selectors)) { - $envs[] = $env; - } - - $env = $env->parent; - }; + $selfParentSelectors = null; - $selectors = array(); - $parentSelectors = array(array()); + if (! is_null($selfParent) && $selfParent->selectors) { + $selfParentSelectors = $this->evalSelectors($selfParent->selectors); + } while ($env = array_pop($envs)) { - $selectors = array(); + if (empty($env->selectors)) { + continue; + } + + $selectors = $env->selectors; + + do { + $stillHasSelf = false; + $prevSelectors = $selectors; + $selectors = []; - foreach ($env->selectors as $selector) { - foreach ($parentSelectors as $parent) { - $selectors[] = $this->joinSelectors($parent, $selector); + foreach ($prevSelectors as $selector) { + foreach ($parentSelectors as $parent) { + if ($selfParentSelectors) { + foreach ($selfParentSelectors as $selfParent) { + // if no '&' in the selector, each call will give same result, only add once + $s = $this->joinSelectors($parent, $selector, $stillHasSelf, $selfParent); + $selectors[serialize($s)] = $s; + } + } else { + $s = $this->joinSelectors($parent, $selector, $stillHasSelf); + $selectors[serialize($s)] = $s; + } + } } - } + } while ($stillHasSelf); $parentSelectors = $selectors; } + $selectors = array_values($selectors); + return $selectors; } /** * Join selectors; looks for & to replace, or append parent before child * - * @param array $parent - * @param array $child - * + * @param array $parent + * @param array $child + * @param boolean &$stillHasSelf + * @param array $selfParentSelectors + * @return array */ - protected function joinSelectors($parent, $child) + protected function joinSelectors($parent, $child, &$stillHasSelf, $selfParentSelectors = null) { $setSelf = false; - $out = array(); + $out = []; foreach ($child as $part) { - $newPart = array(); + $newPart = []; foreach ($part as $p) { - if ($p === self::$selfSelector) { + // only replace & once and should be recalled to be able to make combinations + if ($p === static::$selfSelector && $setSelf) { + $stillHasSelf = true; + } + + if ($p === static::$selfSelector && ! $setSelf) { $setSelf = true; - foreach ($parent as $i => $parentPart) { + if (is_null($selfParentSelectors)) { + $selfParentSelectors = $parent; + } + + foreach ($selfParentSelectors as $i => $parentPart) { if ($i > 0) { $out[] = $newPart; - $newPart = array(); + $newPart = []; } foreach ($parentPart as $pp) { + if (is_array($pp)) { + $flatten = []; + array_walk_recursive($pp, function ($a) use (&$flatten) { + $flatten[] = $a; + }); + $pp = implode($flatten); + } + $newPart[] = $pp; } } @@ -2327,15 +3551,15 @@ protected function joinSelectors($parent, $child) /** * Multiply media * - * @param \stdClass $env - * @param array $childQueries + * @param \Leafo\ScssPhp\Compiler\Environment $env + * @param array $childQueries * * @return array */ - protected function multiplyMedia($env, $childQueries = null) + protected function multiplyMedia(Environment $env = null, $childQueries = null) { if (! isset($env) || - ! empty($env->block->type) && $env->block->type !== 'media' + ! empty($env->block->type) && $env->block->type !== Type::T_MEDIA ) { return $childQueries; } @@ -2345,16 +3569,29 @@ protected function multiplyMedia($env, $childQueries = null) return $this->multiplyMedia($env->parent, $childQueries); } - $parentQueries = $env->block->queryList; + $parentQueries = isset($env->block->queryList) + ? $env->block->queryList + : [[[Type::T_MEDIA_VALUE, $env->block->value]]]; + + $store = [$this->env, $this->storeEnv]; + $this->env = $env; + $this->storeEnv = null; + $parentQueries = $this->evaluateMediaQuery($parentQueries); + list($this->env, $this->storeEnv) = $store; + if ($childQueries === null) { $childQueries = $parentQueries; } else { $originalQueries = $childQueries; - $childQueries = array(); + $childQueries = []; foreach ($parentQueries as $parentQuery) { foreach ($originalQueries as $childQuery) { - $childQueries []= array_merge($parentQuery, $childQuery); + $childQueries[] = array_merge( + $parentQuery, + [[Type::T_MEDIA_TYPE, [Type::T_KEYWORD, 'all']]], + $childQuery + ); } } } @@ -2362,20 +3599,53 @@ protected function multiplyMedia($env, $childQueries = null) return $this->multiplyMedia($env->parent, $childQueries); } + /** + * Convert env linked list to stack + * + * @param \Leafo\ScssPhp\Compiler\Environment $env + * + * @return array + */ + protected function compactEnv(Environment $env) + { + for ($envs = []; $env; $env = $env->parent) { + $envs[] = $env; + } + + return $envs; + } + + /** + * Convert env stack to singly linked list + * + * @param array $envs + * + * @return \Leafo\ScssPhp\Compiler\Environment + */ + protected function extractEnv($envs) + { + for ($env = null; $e = array_pop($envs);) { + $e->parent = $env; + $env = $e; + } + + return $env; + } + /** * Push environment * - * @param \stdClass $block + * @param \Leafo\ScssPhp\Block $block * - * @return \stdClass + * @return \Leafo\ScssPhp\Compiler\Environment */ - protected function pushEnv($block = null) + protected function pushEnv(Block $block = null) { - $env = new \stdClass; + $env = new Environment; $env->parent = $this->env; - $env->store = array(); - $env->block = $block; - $env->depth = isset($this->env->depth) ? $this->env->depth + 1 : 0; + $env->store = []; + $env->block = $block; + $env->depth = isset($this->env->depth) ? $this->env->depth + 1 : 0; $this->env = $env; @@ -2387,16 +3657,13 @@ protected function pushEnv($block = null) */ protected function popEnv() { - $env = $this->env; $this->env = $this->env->parent; - - return $env; } /** * Get store environment * - * @return \stdClass + * @return \Leafo\ScssPhp\Compiler\Environment */ protected function getStoreEnv() { @@ -2406,35 +3673,37 @@ protected function getStoreEnv() /** * Set variable * - * @param string $name - * @param mixed $value - * @param boolean $shadow - * @param \stdClass $env + * @param string $name + * @param mixed $value + * @param boolean $shadow + * @param \Leafo\ScssPhp\Compiler\Environment $env + * @param mixed $valueUnreduced */ - protected function set($name, $value, $shadow = false, $env = null) + protected function set($name, $value, $shadow = false, Environment $env = null, $valueUnreduced = null) { $name = $this->normalizeName($name); + if (! isset($env)) { + $env = $this->getStoreEnv(); + } + if ($shadow) { - $this->setRaw($name, $value, $env); + $this->setRaw($name, $value, $env, $valueUnreduced); } else { - $this->setExisting($name, $value, $env); + $this->setExisting($name, $value, $env, $valueUnreduced); } } /** * Set existing variable * - * @param string $name - * @param mixed $value - * @param \stdClass $env + * @param string $name + * @param mixed $value + * @param \Leafo\ScssPhp\Compiler\Environment $env + * @param mixed $valueUnreduced */ - protected function setExisting($name, $value, $env = null) + protected function setExisting($name, $value, Environment $env, $valueUnreduced = null) { - if (! isset($env)) { - $env = $this->getStoreEnv(); - } - $storeEnv = $env; $hasNamespace = $name[0] === '^' || $name[0] === '@' || $name[0] === '%'; @@ -2458,22 +3727,27 @@ protected function setExisting($name, $value, $env = null) } $env->store[$name] = $value; + + if ($valueUnreduced) { + $env->storeUnreduced[$name] = $valueUnreduced; + } } /** * Set raw variable * - * @param string $name - * @param mixed $value - * @param \stdClass $env + * @param string $name + * @param mixed $value + * @param \Leafo\ScssPhp\Compiler\Environment $env + * @param mixed $valueUnreduced */ - protected function setRaw($name, $value, $env = null) + protected function setRaw($name, $value, Environment $env, $valueUnreduced = null) { - if (! isset($env)) { - $env = $this->getStoreEnv(); - } - $env->store[$name] = $value; + + if ($valueUnreduced) { + $env->storeUnreduced[$name] = $valueUnreduced; + } } /** @@ -2481,28 +3755,46 @@ protected function setRaw($name, $value, $env = null) * * @api * - * @param string $name - * @param boolean $shouldThrow - * @param \stdClass $env + * @param string $name + * @param boolean $shouldThrow + * @param \Leafo\ScssPhp\Compiler\Environment $env + * @param boolean $unreduced * - * @return mixed + * @return mixed|null */ - public function get($name, $shouldThrow = true, $env = null) + public function get($name, $shouldThrow = true, Environment $env = null, $unreduced = false) { - $name = $this->normalizeName($name); + $normalizedName = $this->normalizeName($name); + $specialContentKey = static::$namespaces['special'] . 'content'; if (! isset($env)) { $env = $this->getStoreEnv(); } - $hasNamespace = $name[0] === '^' || $name[0] === '@' || $name[0] === '%'; + $nextIsRoot = false; + $hasNamespace = $normalizedName[0] === '^' || $normalizedName[0] === '@' || $normalizedName[0] === '%'; + + $maxDepth = 10000; for (;;) { - if (array_key_exists($name, $env->store)) { - return $env->store[$name]; + if ($maxDepth-- <= 0) { + break; + } + + if (array_key_exists($normalizedName, $env->store)) { + if ($unreduced && isset($env->storeUnreduced[$normalizedName])) { + return $env->storeUnreduced[$normalizedName]; + } + + return $env->store[$normalizedName]; } if (! $hasNamespace && isset($env->marker)) { + if (! $nextIsRoot && ! empty($env->store[$specialContentKey])) { + $env = $env->store[$specialContentKey]->scope; + continue; + } + $env = $this->rootEnv; continue; } @@ -2515,21 +3807,22 @@ public function get($name, $shouldThrow = true, $env = null) } if ($shouldThrow) { - $this->throwError("Undefined variable \$$name"); + $this->throwError("Undefined variable \$$name" . ($maxDepth<=0 ? " (infinite recursion)" : "")); } // found nothing + return null; } /** * Has variable? * - * @param string $name - * @param \stdClass $env + * @param string $name + * @param \Leafo\ScssPhp\Compiler\Environment $env * * @return boolean */ - protected function has($name, $env = null) + protected function has($name, Environment $env = null) { return $this->get($name, false, $env) !== null; } @@ -2545,7 +3838,7 @@ protected function injectVariables(array $args) return; } - $parser = new Parser(__METHOD__, false); + $parser = $this->parserFactory(__METHOD__); foreach ($args as $name => $strValue) { if ($name[0] === '$') { @@ -2584,6 +3877,32 @@ public function unsetVariable($name) unset($this->registeredVars[$name]); } + /** + * Returns list of variables + * + * @api + * + * @return array + */ + public function getVariables() + { + return $this->registeredVars; + } + + /** + * Adds to list of parsed files + * + * @api + * + * @param string $path + */ + public function addParsedFile($path) + { + if (isset($path) && file_exists($path)) { + $this->parsedFiles[realpath($path)] = filemtime($path); + } + } + /** * Returns list of parsed files * @@ -2601,7 +3920,7 @@ public function getParsedFiles() * * @api * - * @param string $path + * @param string|callable $path */ public function addImportPath($path) { @@ -2619,7 +3938,7 @@ public function addImportPath($path) */ public function setImportPaths($path) { - $this->importPaths = (array)$path; + $this->importPaths = (array) $path; } /** @@ -2631,7 +3950,7 @@ public function setImportPaths($path) */ public function setNumberPrecision($numberPrecision) { - $this->numberPrecision = $numberPrecision; + Node\Number::$precision = $numberPrecision; } /** @@ -2658,6 +3977,30 @@ public function setLineNumberStyle($lineNumberStyle) $this->lineNumberStyle = $lineNumberStyle; } + /** + * Enable/disable source maps + * + * @api + * + * @param integer $sourceMap + */ + public function setSourceMap($sourceMap) + { + $this->sourceMap = $sourceMap; + } + + /** + * Set source map options + * + * @api + * + * @param array $sourceMapOptions + */ + public function setSourceMapOptions($sourceMapOptions) + { + $this->sourceMapOptions = $sourceMapOptions; + } + /** * Register function * @@ -2665,10 +4008,11 @@ public function setLineNumberStyle($lineNumberStyle) * * @param string $name * @param callable $func + * @param array $prototype */ - public function registerFunction($name, $func) + public function registerFunction($name, $func, $prototype = null) { - $this->userFunctions[$this->normalizeName($name)] = $func; + $this->userFunctions[$this->normalizeName($name)] = [$func, $prototype]; } /** @@ -2683,13 +4027,25 @@ public function unregisterFunction($name) unset($this->userFunctions[$this->normalizeName($name)]); } + /** + * Add feature + * + * @api + * + * @param string $name + */ + public function addFeature($name) + { + $this->registeredFeatures[$name] = true; + } + /** * Import file * - * @param string $path - * @param array $out + * @param string $path + * @param \Leafo\ScssPhp\Formatter\OutputBlock $out */ - protected function importFile($path, $out) + protected function importFile($path, OutputBlock $out) { // see if tree is cached $realPath = realpath($path); @@ -2699,17 +4055,16 @@ protected function importFile($path, $out) $tree = $this->importCache[$realPath]; } else { - $code = file_get_contents($path); - $parser = new Parser($path, false); - $tree = $parser->parse($code); + $code = file_get_contents($path); + $parser = $this->parserFactory($path); + $tree = $parser->parse($code); - $this->parsedFiles[$realPath] = filemtime($path); $this->importCache[$realPath] = $tree; } $pi = pathinfo($path); array_unshift($this->importPaths, $pi['dirname']); - $this->compileChildren($tree->children, $out); + $this->compileChildrenNoReturn($tree->children, $out); array_shift($this->importPaths); } @@ -2724,31 +4079,36 @@ protected function importFile($path, $out) */ public function findImport($url) { - $urls = array(); + $urls = []; // for "normal" scss imports (ignore vanilla css and external requests) if (! preg_match('/\.css$|^https?:\/\//', $url)) { // try both normal and the _partial filename - $urls = array($url, preg_replace('/[^\/]+$/', '_\0', $url)); + $urls = [$url, preg_replace('/[^\/]+$/', '_\0', $url)]; } + $hasExtension = preg_match('/[.]s?css$/', $url); + foreach ($this->importPaths as $dir) { if (is_string($dir)) { // check urls for normal import paths foreach ($urls as $full) { - $full = $dir - . (! empty($dir) && substr($dir, -1) !== '/' ? '/' : '') - . $full; + $separator = ( + ! empty($dir) && + substr($dir, -1) !== '/' && + substr($full, 0, 1) !== '/' + ) ? '/' : ''; + $full = $dir . $separator . $full; if ($this->fileExists($file = $full . '.scss') || - $this->fileExists($file = $full) + ($hasExtension && $this->fileExists($file = $full)) ) { return $file; } } } elseif (is_callable($dir)) { // check custom callback for import path - $file = call_user_func($dir, $url, $this); + $file = call_user_func($dir, $url); if ($file !== null) { return $file; @@ -2759,6 +4119,34 @@ public function findImport($url) return null; } + /** + * Set encoding + * + * @api + * + * @param string $encoding + */ + public function setEncoding($encoding) + { + $this->encoding = $encoding; + } + + /** + * Ignore errors? + * + * @api + * + * @param boolean $ignoreErrors + * + * @return \Leafo\ScssPhp\Compiler + */ + public function setIgnoreErrors($ignoreErrors) + { + $this->ignoreErrors = $ignoreErrors; + + return $this; + } + /** * Throw error (exception) * @@ -2766,19 +4154,67 @@ public function findImport($url) * * @param string $msg Message with optional sprintf()-style vararg parameters * - * @throws \Exception + * @throws \Leafo\ScssPhp\Exception\CompilerException */ public function throwError($msg) { + if ($this->ignoreErrors) { + return; + } + + $line = $this->sourceLine; + $column = $this->sourceColumn; + + $loc = isset($this->sourceNames[$this->sourceIndex]) + ? $this->sourceNames[$this->sourceIndex] . " on line $line, at column $column" + : "line: $line, column: $column"; + if (func_num_args() > 1) { $msg = call_user_func_array('sprintf', func_get_args()); } - if ($this->sourcePos >= 0 && isset($this->sourceParser)) { - $this->sourceParser->throwParseError($msg, $this->sourcePos); + $msg = "$msg: $loc"; + + $callStackMsg = $this->callStackMessage(); + + if ($callStackMsg) { + $msg .= "\nCall Stack:\n" . $callStackMsg; + } + + throw new CompilerException($msg); + } + + /** + * Beautify call stack for output + * + * @param boolean $all + * @param null $limit + * + * @return string + */ + protected function callStackMessage($all = false, $limit = null) + { + $callStackMsg = []; + $ncall = 0; + + if ($this->callStack) { + foreach (array_reverse($this->callStack) as $call) { + if ($all || (isset($call['n']) && $call['n'])) { + $msg = "#" . $ncall++ . " " . $call['n'] . " "; + $msg .= (isset($this->sourceNames[$call[Parser::SOURCE_INDEX]]) + ? $this->sourceNames[$call[Parser::SOURCE_INDEX]] + : '(unknown file)'); + $msg .= " on line " . $call[Parser::SOURCE_LINE]; + $callStackMsg[] = $msg; + + if (! is_null($limit) && $ncall>$limit) { + break; + } + } + } } - throw new \Exception($msg); + return implode("\n", $callStackMsg); } /** @@ -2788,17 +4224,14 @@ public function throwError($msg) * * @throws \Exception */ - private function handleImportLoop($name) + protected function handleImportLoop($name) { for ($env = $this->env; $env; $env = $env->parent) { - $file = $env->block->sourceParser->getSourceName(); + $file = $this->sourceNames[$env->block->sourceIndex]; if (realpath($file) === $name) { - $this->throwError( - 'An @import loop has been found: %s imports %s', - $this->env->block->sourceParser->getSourceName(), - basename($file) - ); + $this->throwError('An @import loop has been found: %s imports %s', $file, basename($file)); + break; } } } @@ -2812,7 +4245,52 @@ private function handleImportLoop($name) */ protected function fileExists($name) { - return is_file($name); + return file_exists($name) && is_file($name); + } + + /** + * Call SCSS @function + * + * @param string $name + * @param array $argValues + * @param array $returnValue + * + * @return boolean Returns true if returnValue is set; otherwise, false + */ + protected function callScssFunction($name, $argValues, &$returnValue) + { + $func = $this->get(static::$namespaces['function'] . $name, false); + + if (! $func) { + return false; + } + + $this->pushEnv(); + + $storeEnv = $this->storeEnv; + $this->storeEnv = $this->env; + + // set the args + if (isset($func->args)) { + $this->applyArguments($func->args, $argValues); + } + + // throw away lines and children + $tmp = new OutputBlock; + $tmp->lines = []; + $tmp->children = []; + + $this->env->marker = 'function'; + + $ret = $this->compileChildren($func->children, $tmp, $this->env->marker . " " . $name); + + $this->storeEnv = $storeEnv; + + $this->popEnv(); + + $returnValue = ! isset($ret) ? static::$defaultValue : $ret; + + return true; } /** @@ -2824,44 +4302,38 @@ protected function fileExists($name) * * @return boolean Returns true if returnValue is set; otherwise, false */ - protected function callBuiltin($name, $args, &$returnValue) + protected function callNativeFunction($name, $args, &$returnValue) { // try a lib function $name = $this->normalizeName($name); if (isset($this->userFunctions[$name])) { // see if we can find a user function - $fn = $this->userFunctions[$name]; - - foreach ($args as &$val) { - $val = $this->reduce($val[1], true); - } - - $returnValue = call_user_func($fn, $args, $this); + list($f, $prototype) = $this->userFunctions[$name]; + } elseif (($f = $this->getBuiltinFunction($name)) && is_callable($f)) { + $libName = $f[1]; + $prototype = isset(static::$$libName) ? static::$$libName : null; } else { - $f = $this->getBuiltinFunction($name); - - if (is_callable($f)) { - $libName = $f[1]; - - $prototype = isset(self::$$libName) ? self::$$libName : null; - $sorted = $this->sortArgs($prototype, $args); + return false; + } - foreach ($sorted as &$val) { - $val = $this->reduce($val, true); - } + @list($sorted, $kwargs) = $this->sortArgs($prototype, $args); - $returnValue = call_user_func($f, $sorted, $this); + if ($name !== 'if' && $name !== 'call') { + foreach ($sorted as &$val) { + $val = $this->reduce($val, true); } } - if (isset($returnValue)) { - $returnValue = $this->coerceValue($returnValue); + $returnValue = call_user_func($f, $sorted, $kwargs); - return true; + if (! isset($returnValue)) { + return false; } - return false; + $returnValue = $this->coerceValue($returnValue); + + return true; } /** @@ -2881,14 +4353,12 @@ function ($m) { ucfirst($name) ); - return array($this, $libName); + return [$this, $libName]; } /** * Sorts keyword arguments * - * @todo Merge with applyArguments()? - * * @param array $prototype * @param array $args * @@ -2896,49 +4366,39 @@ function ($m) { */ protected function sortArgs($prototype, $args) { - $keyArgs = array(); - $posArgs = array(); + $keyArgs = []; + $posArgs = []; + // separate positional and keyword arguments foreach ($args as $arg) { list($key, $value) = $arg; $key = $key[1]; if (empty($key)) { - $posArgs[] = $value; + $posArgs[] = empty($arg[2]) ? $value : $arg; } else { $keyArgs[$key] = $value; } } if (! isset($prototype)) { - return $posArgs; + return [$posArgs, $keyArgs]; } - $finalArgs = array(); + // copy positional args + $finalArgs = array_pad($posArgs, count($prototype), null); + // overwrite positional args with keyword args foreach ($prototype as $i => $names) { - if (isset($posArgs[$i])) { - $finalArgs[] = $posArgs[$i]; - continue; - } - - $set = false; - - foreach ((array)$names as $name) { + foreach ((array) $names as $name) { if (isset($keyArgs[$name])) { - $finalArgs[] = $keyArgs[$name]; - $set = true; - break; + $finalArgs[$i] = $keyArgs[$name]; } } - - if (! $set) { - $finalArgs[] = null; - } } - return $finalArgs; + return [$finalArgs, $keyArgs]; } /** @@ -2953,22 +4413,22 @@ protected function applyArguments($argDef, $argValues) { $storeEnv = $this->getStoreEnv(); - $env = new \stdClass; + $env = new Environment; $env->store = $storeEnv->store; $hasVariable = false; - $args = array(); + $args = []; foreach ($argDef as $i => $arg) { list($name, $default, $isVariable) = $argDef[$i]; - $args[$name] = array($i, $name, $default, $isVariable); + $args[$name] = [$i, $name, $default, $isVariable]; $hasVariable |= $isVariable; } - $keywordArgs = array(); - $deferredKeywordArgs = array(); - $remaining = array(); + $keywordArgs = []; + $deferredKeywordArgs = []; + $remaining = []; // assign the keyword args foreach ((array) $argValues as $arg) { @@ -2978,19 +4438,33 @@ protected function applyArguments($argDef, $argValues) $deferredKeywordArgs[$arg[0][1]] = $arg[1]; } else { $this->throwError("Mixin or function doesn't have an argument named $%s.", $arg[0][1]); + break; } } elseif ($args[$arg[0][1]][0] < count($remaining)) { $this->throwError("The argument $%s was passed both by position and by name.", $arg[0][1]); + break; } else { $keywordArgs[$arg[0][1]] = $arg[1]; } } elseif (count($keywordArgs)) { $this->throwError('Positional arguments must come before keyword arguments.'); + break; } elseif ($arg[2] === true) { $val = $this->reduce($arg[1], true); - if ($val[0] === 'list') { + if ($val[0] === Type::T_LIST) { foreach ($val[2] as $name => $item) { + if (! is_numeric($name)) { + $keywordArgs[$name] = $item; + } else { + $remaining[] = $item; + } + } + } elseif ($val[0] === Type::T_MAP) { + foreach ($val[1] as $i => $name) { + $name = $this->compileStringContent($this->coerceString($name)); + $item = $val[2][$i]; + if (! is_numeric($name)) { $keywordArgs[$name] = $item; } else { @@ -3009,7 +4483,7 @@ protected function applyArguments($argDef, $argValues) list($i, $name, $default, $isVariable) = $arg; if ($isVariable) { - $val = array('list', ',', array(), $isVariable); + $val = [Type::T_LIST, ',', [], $isVariable]; for ($count = count($remaining); $i < $count; $i++) { $val[2][] = $remaining[$i]; @@ -3026,6 +4500,7 @@ protected function applyArguments($argDef, $argValues) continue; } else { $this->throwError("Missing argument $name"); + break; } $this->set($name, $this->reduce($val, true), true, $env); @@ -3049,54 +4524,58 @@ protected function applyArguments($argDef, $argValues) * * @param mixed $value * - * @return array + * @return array|\Leafo\ScssPhp\Node\Number */ - private function coerceValue($value) + protected function coerceValue($value) { - if (is_array($value)) { + if (is_array($value) || $value instanceof \ArrayAccess) { return $value; } if (is_bool($value)) { - return $value ? self::$true : self::$false; + return $this->toBool($value); } if ($value === null) { - $value = self::$null; + return static::$null; } if (is_numeric($value)) { - return array('number', $value, ''); + return new Node\Number($value, ''); } if ($value === '') { - return self::$emptyString; + return static::$emptyString; + } + + if (preg_match('/^(#([0-9a-f]{6})|#([0-9a-f]{3}))$/i', $value, $m)) { + $color = [Type::T_COLOR]; + + if (isset($m[3])) { + $num = hexdec($m[3]); + + foreach ([3, 2, 1] as $i) { + $t = $num & 0xf; + $color[$i] = $t << 4 | $t; + $num >>= 4; + } + } else { + $num = hexdec($m[2]); + + foreach ([3, 2, 1] as $i) { + $color[$i] = $num & 0xff; + $num >>= 8; + } + } + + return $color; } - return array('keyword', $value); + return [Type::T_KEYWORD, $value]; } /** - * Coerce unit on number to be normalized - * - * @param array $number - * @param string $unit - * - * @return array - */ - protected function coerceUnit($number, $unit) - { - list(, $value, $baseUnit) = $number; - - if (isset(self::$unitTable[$baseUnit][$unit])) { - $value = $value * self::$unitTable[$baseUnit][$unit]; - } - - return array('number', $value, $unit); - } - - /** - * Coerce something to map + * Coerce something to map * * @param array $item * @@ -3104,46 +4583,51 @@ protected function coerceUnit($number, $unit) */ protected function coerceMap($item) { - if ($item[0] === 'map') { + if ($item[0] === Type::T_MAP) { return $item; } - if ($item === self::$emptyList) { - return self::$emptyMap; + if ($item === static::$emptyList) { + return static::$emptyMap; } - return array('map', array($item), array(self::$null)); + return [Type::T_MAP, [$item], [static::$null]]; } /** * Coerce something to list * - * @param array $item + * @param array $item + * @param string $delim * * @return array */ protected function coerceList($item, $delim = ',') { - if (isset($item) && $item[0] === 'list') { + if (isset($item) && $item[0] === Type::T_LIST) { return $item; } - if (isset($item) && $item[0] === 'map') { + if (isset($item) && $item[0] === Type::T_MAP) { $keys = $item[1]; $values = $item[2]; - $list = array(); + $list = []; for ($i = 0, $s = count($keys); $i < $s; $i++) { $key = $keys[$i]; $value = $values[$i]; - $list[] = array('list', '', array(array('keyword', $this->compileValue($key)), $value)); + $list[] = [ + Type::T_LIST, + '', + [[Type::T_KEYWORD, $this->compileStringContent($this->coerceString($key))], $value] + ]; } - return array('list', ',', $list); + return [Type::T_LIST, ',', $list]; } - return array('list', $delim, ! isset($item) ? array(): array($item)); + return [Type::T_LIST, $delim, ! isset($item) ? []: [$item]]; } /** @@ -3172,18 +4656,18 @@ protected function coerceForExpression($value) protected function coerceColor($value) { switch ($value[0]) { - case 'color': + case Type::T_COLOR: return $value; - case 'keyword': + case Type::T_KEYWORD: $name = strtolower($value[1]); if (isset(Colors::$cssColors[$name])) { $rgba = explode(',', Colors::$cssColors[$name]); return isset($rgba[3]) - ? array('color', (int) $rgba[0], (int) $rgba[1], (int) $rgba[2], (int) $rgba[3]) - : array('color', (int) $rgba[0], (int) $rgba[1], (int) $rgba[2]); + ? [Type::T_COLOR, (int) $rgba[0], (int) $rgba[1], (int) $rgba[2], (int) $rgba[3]] + : [Type::T_COLOR, (int) $rgba[0], (int) $rgba[1], (int) $rgba[2]]; } return null; @@ -3201,11 +4685,11 @@ protected function coerceColor($value) */ protected function coerceString($value) { - if ($value[0] === 'string') { + if ($value[0] === Type::T_STRING) { return $value; } - return array('string', '', array($this->compileValue($value))); + return [Type::T_STRING, '', [$this->compileValue($value)]]; } /** @@ -3217,8 +4701,8 @@ protected function coerceString($value) */ protected function coercePercent($value) { - if ($value[0] === 'number') { - if ($value[2] === '%') { + if ($value[0] === Type::T_NUMBER) { + if (! empty($value[2]['%'])) { return $value[1] / 100; } @@ -3243,8 +4727,8 @@ public function assertMap($value) { $value = $this->coerceMap($value); - if ($value[0] !== 'map') { - $this->throwError('expecting map'); + if ($value[0] !== Type::T_MAP) { + $this->throwError('expecting map, %s received', $value[0]); } return $value; @@ -3263,8 +4747,8 @@ public function assertMap($value) */ public function assertList($value) { - if ($value[0] !== 'list') { - $this->throwError('expecting list'); + if ($value[0] !== Type::T_LIST) { + $this->throwError('expecting list, %s received', $value[0]); } return $value; @@ -3287,7 +4771,7 @@ public function assertColor($value) return $color; } - $this->throwError('expecting color'); + $this->throwError('expecting color, %s received', $value[0]); } /** @@ -3303,8 +4787,8 @@ public function assertColor($value) */ public function assertNumber($value) { - if ($value[0] !== 'number') { - $this->throwError('expecting number'); + if ($value[0] !== Type::T_NUMBER) { + $this->throwError('expecting number, %s received', $value[0]); } return $value[1]; @@ -3319,7 +4803,7 @@ public function assertNumber($value) */ protected function fixColor($c) { - foreach (range(1, 3) as $i) { + foreach ([1, 2, 3] as $i) { if ($c[$i] < 0) { $c[$i] = 0; } @@ -3369,7 +4853,7 @@ public function toHSL($red, $green, $blue) } } - return array('hsl', fmod($h, 360), $s * 100, $l / 5.1); + return [Type::T_HSL, fmod($h, 360), $s * 100, $l / 5.1]; } /** @@ -3381,7 +4865,7 @@ public function toHSL($red, $green, $blue) * * @return float */ - private function hueToRGB($m1, $m2, $h) + protected function hueToRGB($m1, $m2, $h) { if ($h < 0) { $h += 1; @@ -3432,43 +4916,86 @@ public function toRGB($hue, $saturation, $lightness) $g = $this->hueToRGB($m1, $m2, $h) * 255; $b = $this->hueToRGB($m1, $m2, $h - 1/3) * 255; - $out = array('color', $r, $g, $b); + $out = [Type::T_COLOR, $r, $g, $b]; return $out; } // Built in functions - protected static $libIf = array('condition', 'if-true', 'if-false'); + //protected static $libCall = ['name', 'args...']; + protected function libCall($args, $kwargs) + { + $name = $this->compileStringContent($this->coerceString($this->reduce(array_shift($args), true))); + + $posArgs = []; + + foreach ($args as $arg) { + if (empty($arg[0])) { + if ($arg[2] === true) { + $tmp = $this->reduce($arg[1]); + + if ($tmp[0] === Type::T_LIST) { + foreach ($tmp[2] as $item) { + $posArgs[] = [null, $item, false]; + } + } else { + $posArgs[] = [null, $tmp, true]; + } + + continue; + } + + $posArgs[] = [null, $this->reduce($arg), false]; + continue; + } + + $posArgs[] = [null, $arg, false]; + } + + if (count($kwargs)) { + foreach ($kwargs as $key => $value) { + $posArgs[] = [[Type::T_VARIABLE, $key], $value, false]; + } + } + + return $this->reduce([Type::T_FUNCTION_CALL, $name, $posArgs]); + } + + protected static $libIf = ['condition', 'if-true', 'if-false']; protected function libIf($args) { list($cond, $t, $f) = $args; - if (! $this->isTruthy($cond)) { - return $f; + if (! $this->isTruthy($this->reduce($cond, true))) { + return $this->reduce($f, true); } - return $t; + return $this->reduce($t, true); } - protected static $libIndex = array('list', 'value'); + protected static $libIndex = ['list', 'value']; protected function libIndex($args) { list($list, $value) = $args; - if ($value[0] === 'map') { - return self::$null; + if ($value[0] === Type::T_MAP) { + return static::$null; } - if ($list[0] === 'map') { + if ($list[0] === Type::T_MAP || + $list[0] === Type::T_STRING || + $list[0] === Type::T_KEYWORD || + $list[0] === Type::T_INTERPOLATE + ) { $list = $this->coerceList($list, ' '); } - if ($list[0] !== 'list') { - return self::$null; + if ($list[0] !== Type::T_LIST) { + return static::$null; } - $values = array(); + $values = []; foreach ($list[2] as $item) { $values[] = $this->normalizeValue($item); @@ -3476,27 +5003,24 @@ protected function libIndex($args) $key = array_search($this->normalizeValue($value), $values); - return false === $key ? self::$null : $key + 1; + return false === $key ? static::$null : $key + 1; } - protected static $libRgb = array('red', 'green', 'blue'); + protected static $libRgb = ['red', 'green', 'blue']; protected function libRgb($args) { list($r, $g, $b) = $args; - return array('color', $r[1], $g[1], $b[1]); + return [Type::T_COLOR, $r[1], $g[1], $b[1]]; } - protected static $libRgba = array( - array('red', 'color'), - 'green', 'blue', 'alpha'); + protected static $libRgba = [ + ['red', 'color'], + 'green', 'blue', 'alpha']; protected function libRgba($args) { if ($color = $this->coerceColor($args[0])) { - // workaround https://github.com/facebook/hhvm/issues/5457 - reset($args); - - $num = ! isset($args[1]) ? $args[3] : $args[1]; + $num = isset($args[3]) ? $args[3] : $args[1]; $alpha = $this->assertNumber($num); $color[4] = $alpha; @@ -3505,7 +5029,7 @@ protected function libRgba($args) list($r, $g, $b, $a) = $args; - return array('color', $r[1], $g[1], $b[1], $a[1]); + return [Type::T_COLOR, $r[1], $g[1], $b[1], $a[1]]; } // helper function for adjust_color, change_color, and scale_color @@ -3513,10 +5037,7 @@ protected function alterColor($args, $fn) { $color = $this->assertColor($args[0]); - // workaround https://github.com/facebook/hhvm/issues/5457 - reset($args); - - foreach (array(1, 2, 3, 7) as $i) { + foreach ([1, 2, 3, 7] as $i) { if (isset($args[$i])) { $val = $this->assertNumber($args[$i]); $ii = $i === 7 ? 4 : $i; // alpha @@ -3527,7 +5048,7 @@ protected function alterColor($args, $fn) if (isset($args[4]) || isset($args[5]) || isset($args[6])) { $hsl = $this->toHSL($color[1], $color[2], $color[3]); - foreach (array(4, 5, 6) as $i) { + foreach ([4, 5, 6] as $i) { if (isset($args[$i])) { $val = $this->assertNumber($args[$i]); $hsl[$i - 3] = call_user_func($fn, $hsl[$i - 3], $val, $i); @@ -3546,10 +5067,10 @@ protected function alterColor($args, $fn) return $color; } - protected static $libAdjustColor = array( + protected static $libAdjustColor = [ 'color', 'red', 'green', 'blue', 'hue', 'saturation', 'lightness', 'alpha' - ); + ]; protected function libAdjustColor($args) { return $this->alterColor($args, function ($base, $alter, $i) { @@ -3557,10 +5078,10 @@ protected function libAdjustColor($args) }); } - protected static $libChangeColor = array( + protected static $libChangeColor = [ 'color', 'red', 'green', 'blue', 'hue', 'saturation', 'lightness', 'alpha' - ); + ]; protected function libChangeColor($args) { return $this->alterColor($args, function ($base, $alter, $i) { @@ -3568,10 +5089,10 @@ protected function libChangeColor($args) }); } - protected static $libScaleColor = array( + protected static $libScaleColor = [ 'color', 'red', 'green', 'blue', 'hue', 'saturation', 'lightness', 'alpha' - ); + ]; protected function libScaleColor($args) { return $this->alterColor($args, function ($base, $scale, $i) { @@ -3607,16 +5128,16 @@ protected function libScaleColor($args) }); } - protected static $libIeHexStr = array('color'); + protected static $libIeHexStr = ['color']; protected function libIeHexStr($args) { $color = $this->coerceColor($args[0]); - $color[4] = isset($color[4]) ? round(255*$color[4]) : 255; + $color[4] = isset($color[4]) ? round(255 * $color[4]) : 255; return sprintf('#%02X%02X%02X%02X', $color[4], $color[1], $color[2], $color[3]); } - protected static $libRed = array('color'); + protected static $libRed = ['color']; protected function libRed($args) { $color = $this->coerceColor($args[0]); @@ -3624,7 +5145,7 @@ protected function libRed($args) return $color[1]; } - protected static $libGreen = array('color'); + protected static $libGreen = ['color']; protected function libGreen($args) { $color = $this->coerceColor($args[0]); @@ -3632,7 +5153,7 @@ protected function libGreen($args) return $color[2]; } - protected static $libBlue = array('color'); + protected static $libBlue = ['color']; protected function libBlue($args) { $color = $this->coerceColor($args[0]); @@ -3640,7 +5161,7 @@ protected function libBlue($args) return $color[3]; } - protected static $libAlpha = array('color'); + protected static $libAlpha = ['color']; protected function libAlpha($args) { if ($color = $this->coerceColor($args[0])) { @@ -3651,12 +5172,12 @@ protected function libAlpha($args) return null; } - protected static $libOpacity = array('color'); + protected static $libOpacity = ['color']; protected function libOpacity($args) { $value = $args[0]; - if ($value[0] === 'number') { + if ($value[0] === Type::T_NUMBER) { return null; } @@ -3664,7 +5185,7 @@ protected function libOpacity($args) } // mix two colors - protected static $libMix = array('color-1', 'color-2', 'weight'); + protected static $libMix = ['color-1', 'color-2', 'weight']; protected function libMix($args) { list($first, $second, $weight) = $args; @@ -3687,20 +5208,20 @@ protected function libMix($args) $w1 = (($w * $a === -1 ? $w : ($w + $a) / (1 + $w * $a)) + 1) / 2.0; $w2 = 1.0 - $w1; - $new = array('color', + $new = [Type::T_COLOR, $w1 * $first[1] + $w2 * $second[1], $w1 * $first[2] + $w2 * $second[2], $w1 * $first[3] + $w2 * $second[3], - ); + ]; if ($firstAlpha != 1.0 || $secondAlpha != 1.0) { - $new[] = $firstAlpha * $weight + $secondAlpha * ($weight - 1); + $new[] = $firstAlpha * $weight + $secondAlpha * (1 - $weight); } return $this->fixColor($new); } - protected static $libHsl = array('hue', 'saturation', 'lightness'); + protected static $libHsl = ['hue', 'saturation', 'lightness']; protected function libHsl($args) { list($h, $s, $l) = $args; @@ -3708,8 +5229,7 @@ protected function libHsl($args) return $this->toRGB($h[1], $s[1], $l[1]); } - protected static $libHsla = array('hue', 'saturation', - 'lightness', 'alpha'); + protected static $libHsla = ['hue', 'saturation', 'lightness', 'alpha']; protected function libHsla($args) { list($h, $s, $l, $a) = $args; @@ -3720,31 +5240,31 @@ protected function libHsla($args) return $color; } - protected static $libHue = array('color'); + protected static $libHue = ['color']; protected function libHue($args) { $color = $this->assertColor($args[0]); $hsl = $this->toHSL($color[1], $color[2], $color[3]); - return array('number', $hsl[1], 'deg'); + return new Node\Number($hsl[1], 'deg'); } - protected static $libSaturation = array('color'); + protected static $libSaturation = ['color']; protected function libSaturation($args) { $color = $this->assertColor($args[0]); $hsl = $this->toHSL($color[1], $color[2], $color[3]); - return array('number', $hsl[2], '%'); + return new Node\Number($hsl[2], '%'); } - protected static $libLightness = array('color'); + protected static $libLightness = ['color']; protected function libLightness($args) { $color = $this->assertColor($args[0]); $hsl = $this->toHSL($color[1], $color[2], $color[3]); - return array('number', $hsl[3], '%'); + return new Node\Number($hsl[3], '%'); } protected function adjustHsl($color, $idx, $amount) @@ -3760,7 +5280,7 @@ protected function adjustHsl($color, $idx, $amount) return $out; } - protected static $libAdjustHue = array('color', 'degrees'); + protected static $libAdjustHue = ['color', 'degrees']; protected function libAdjustHue($args) { $color = $this->assertColor($args[0]); @@ -3769,7 +5289,7 @@ protected function libAdjustHue($args) return $this->adjustHsl($color, 1, $degrees); } - protected static $libLighten = array('color', 'amount'); + protected static $libLighten = ['color', 'amount']; protected function libLighten($args) { $color = $this->assertColor($args[0]); @@ -3778,7 +5298,7 @@ protected function libLighten($args) return $this->adjustHsl($color, 3, $amount); } - protected static $libDarken = array('color', 'amount'); + protected static $libDarken = ['color', 'amount']; protected function libDarken($args) { $color = $this->assertColor($args[0]); @@ -3787,54 +5307,54 @@ protected function libDarken($args) return $this->adjustHsl($color, 3, -$amount); } - protected static $libSaturate = array('color', 'amount'); + protected static $libSaturate = ['color', 'amount']; protected function libSaturate($args) { $value = $args[0]; - if ($value[0] === 'number') { + if ($value[0] === Type::T_NUMBER) { return null; } $color = $this->assertColor($value); - $amount = 100*$this->coercePercent($args[1]); + $amount = 100 * $this->coercePercent($args[1]); return $this->adjustHsl($color, 2, $amount); } - protected static $libDesaturate = array('color', 'amount'); + protected static $libDesaturate = ['color', 'amount']; protected function libDesaturate($args) { $color = $this->assertColor($args[0]); - $amount = 100*$this->coercePercent($args[1]); + $amount = 100 * $this->coercePercent($args[1]); return $this->adjustHsl($color, 2, -$amount); } - protected static $libGrayscale = array('color'); + protected static $libGrayscale = ['color']; protected function libGrayscale($args) { $value = $args[0]; - if ($value[0] === 'number') { + if ($value[0] === Type::T_NUMBER) { return null; } return $this->adjustHsl($this->assertColor($value), 2, -100); } - protected static $libComplement = array('color'); + protected static $libComplement = ['color']; protected function libComplement($args) { return $this->adjustHsl($this->assertColor($args[0]), 1, 180); } - protected static $libInvert = array('color'); + protected static $libInvert = ['color']; protected function libInvert($args) { $value = $args[0]; - if ($value[0] === 'number') { + if ($value[0] === Type::T_NUMBER) { return null; } @@ -3847,7 +5367,7 @@ protected function libInvert($args) } // increases opacity by amount - protected static $libOpacify = array('color', 'amount'); + protected static $libOpacify = ['color', 'amount']; protected function libOpacify($args) { $color = $this->assertColor($args[0]); @@ -3859,14 +5379,14 @@ protected function libOpacify($args) return $color; } - protected static $libFadeIn = array('color', 'amount'); + protected static $libFadeIn = ['color', 'amount']; protected function libFadeIn($args) { return $this->libOpacify($args); } // decreases opacity by amount - protected static $libTransparentize = array('color', 'amount'); + protected static $libTransparentize = ['color', 'amount']; protected function libTransparentize($args) { $color = $this->assertColor($args[0]); @@ -3878,78 +5398,72 @@ protected function libTransparentize($args) return $color; } - protected static $libFadeOut = array('color', 'amount'); + protected static $libFadeOut = ['color', 'amount']; protected function libFadeOut($args) { return $this->libTransparentize($args); } - protected static $libUnquote = array('string'); + protected static $libUnquote = ['string']; protected function libUnquote($args) { $str = $args[0]; - if ($str[0] === 'string') { + if ($str[0] === Type::T_STRING) { $str[1] = ''; } return $str; } - protected static $libQuote = array('string'); + protected static $libQuote = ['string']; protected function libQuote($args) { $value = $args[0]; - if ($value[0] === 'string' && ! empty($value[1])) { + if ($value[0] === Type::T_STRING && ! empty($value[1])) { return $value; } - return array('string', '"', array($value)); + return [Type::T_STRING, '"', [$value]]; } - protected static $libPercentage = array('value'); + protected static $libPercentage = ['value']; protected function libPercentage($args) { - return array('number', - $this->coercePercent($args[0]) * 100, - '%'); + return new Node\Number($this->coercePercent($args[0]) * 100, '%'); } - protected static $libRound = array('value'); + protected static $libRound = ['value']; protected function libRound($args) { $num = $args[0]; - $num[1] = round($num[1]); - return $num; + return new Node\Number(round($num[1]), $num[2]); } - protected static $libFloor = array('value'); + protected static $libFloor = ['value']; protected function libFloor($args) { $num = $args[0]; - $num[1] = floor($num[1]); - return $num; + return new Node\Number(floor($num[1]), $num[2]); } - protected static $libCeil = array('value'); + protected static $libCeil = ['value']; protected function libCeil($args) { $num = $args[0]; - $num[1] = ceil($num[1]); - return $num; + return new Node\Number(ceil($num[1]), $num[2]); } - protected static $libAbs = array('value'); + protected static $libAbs = ['value']; protected function libAbs($args) { $num = $args[0]; - $num[1] = abs($num[1]); - return $num; + return new Node\Number(abs($num[1]), $num[2]); } protected function libMin($args) @@ -3959,7 +5473,7 @@ protected function libMin($args) foreach ($numbers as $key => $number) { if (null === $min || $number[1] <= $min[1]) { - $min = array($key, $number[1]); + $min = [$key, $number[1]]; } } @@ -3973,7 +5487,7 @@ protected function libMax($args) foreach ($numbers as $key => $number) { if (null === $max || $number[1] >= $max[1]) { - $max = array($key, $number[1]); + $max = [$key, $number[1]]; } } @@ -3991,20 +5505,22 @@ protected function getNormalizedNumbers($args) { $unit = null; $originalUnit = null; - $numbers = array(); + $numbers = []; foreach ($args as $key => $item) { - if ('number' !== $item[0]) { + if ($item[0] !== Type::T_NUMBER) { $this->throwError('%s is not a number', $item[0]); + break; } - $number = $this->normalizeNumber($item); + $number = $item->normalize(); if (null === $unit) { $unit = $number[2]; - $originalUnit = $item[2]; - } elseif ($unit !== $number[2]) { - $this->throwError('Incompatible units: "%s" and "%s".', $originalUnit, $item[2]); + $originalUnit = $item->unitStr(); + } elseif ($number[1] && $unit !== $number[2]) { + $this->throwError('Incompatible units: "%s" and "%s".', $originalUnit, $item->unitStr()); + break; } $numbers[$key] = $number; @@ -4013,7 +5529,7 @@ protected function getNormalizedNumbers($args) return $numbers; } - protected static $libLength = array('list'); + protected static $libLength = ['list']; protected function libLength($args) { $list = $this->coerceList($args[0]); @@ -4021,8 +5537,7 @@ protected function libLength($args) return count($list[2]); } - // TODO: need a way to declare this built-in as varargs - //protected static $libListSeparator = array('list...'); + //protected static $libListSeparator = ['list...']; protected function libListSeparator($args) { if (count($args) > 1) { @@ -4042,23 +5557,37 @@ protected function libListSeparator($args) return 'space'; } - protected static $libNth = array('list', 'n'); + protected static $libNth = ['list', 'n']; protected function libNth($args) { $list = $this->coerceList($args[0]); - $n = $this->assertNumber($args[1]) - 1; + $n = $this->assertNumber($args[1]); - return isset($list[2][$n]) ? $list[2][$n] : self::$defaultValue; + if ($n > 0) { + $n--; + } elseif ($n < 0) { + $n += count($list[2]); + } + + return isset($list[2][$n]) ? $list[2][$n] : static::$defaultValue; } - protected static $libSetNth = array('list', 'n', 'value'); + protected static $libSetNth = ['list', 'n', 'value']; protected function libSetNth($args) { $list = $this->coerceList($args[0]); - $n = $this->assertNumber($args[1]) - 1; + $n = $this->assertNumber($args[1]); + + if ($n > 0) { + $n--; + } elseif ($n < 0) { + $n += count($list[2]); + } if (! isset($list[2][$n])) { $this->throwError('Invalid argument for "n"'); + + return null; } $list[2][$n] = $args[2]; @@ -4066,51 +5595,47 @@ protected function libSetNth($args) return $list; } - protected static $libMapGet = array('map', 'key'); + protected static $libMapGet = ['map', 'key']; protected function libMapGet($args) { $map = $this->assertMap($args[0]); - $key = $this->compileStringContent($this->coerceString($args[1])); for ($i = count($map[1]) - 1; $i >= 0; $i--) { - if ($key === $this->compileValue($map[1][$i])) { + if ($key === $this->compileStringContent($this->coerceString($map[1][$i]))) { return $map[2][$i]; } } - return self::$null; + return static::$null; } - protected static $libMapKeys = array('map'); + protected static $libMapKeys = ['map']; protected function libMapKeys($args) { $map = $this->assertMap($args[0]); - $keys = $map[1]; - return array('list', ',', $keys); + return [Type::T_LIST, ',', $keys]; } - protected static $libMapValues = array('map'); + protected static $libMapValues = ['map']; protected function libMapValues($args) { $map = $this->assertMap($args[0]); - $values = $map[2]; - return array('list', ',', $values); + return [Type::T_LIST, ',', $values]; } - protected static $libMapRemove = array('map', 'key'); + protected static $libMapRemove = ['map', 'key']; protected function libMapRemove($args) { $map = $this->assertMap($args[0]); - $key = $this->compileStringContent($this->coerceString($args[1])); for ($i = count($map[1]) - 1; $i >= 0; $i--) { - if ($key === $this->compileValue($map[1][$i])) { + if ($key === $this->compileStringContent($this->coerceString($map[1][$i]))) { array_splice($map[1], $i, 1); array_splice($map[2], $i, 1); } @@ -4119,29 +5644,58 @@ protected function libMapRemove($args) return $map; } - protected static $libMapHasKey = array('map', 'key'); + protected static $libMapHasKey = ['map', 'key']; protected function libMapHasKey($args) { $map = $this->assertMap($args[0]); - $key = $this->compileStringContent($this->coerceString($args[1])); for ($i = count($map[1]) - 1; $i >= 0; $i--) { - if ($key === $this->compileValue($map[1][$i])) { - return self::$true; + if ($key === $this->compileStringContent($this->coerceString($map[1][$i]))) { + return true; } } - return self::$false; + return false; } - protected static $libMapMerge = array('map-1', 'map-2'); + protected static $libMapMerge = ['map-1', 'map-2']; protected function libMapMerge($args) { $map1 = $this->assertMap($args[0]); $map2 = $this->assertMap($args[1]); - return array('map', array_merge($map1[1], $map2[1]), array_merge($map1[2], $map2[2])); + foreach ($map2[1] as $i2 => $key2) { + $key = $this->compileStringContent($this->coerceString($key2)); + + foreach ($map1[1] as $i1 => $key1) { + if ($key === $this->compileStringContent($this->coerceString($key1))) { + $map1[2][$i1] = $map2[2][$i2]; + continue 2; + } + } + + $map1[1][] = $map2[1][$i2]; + $map1[2][] = $map2[2][$i2]; + } + + return $map1; + } + + protected static $libKeywords = ['args']; + protected function libKeywords($args) + { + $this->assertList($args[0]); + + $keys = []; + $values = []; + + foreach ($args[0][2] as $name => $arg) { + $keys[] = [Type::T_KEYWORD, $name]; + $values[] = $arg; + } + + return [Type::T_MAP, $keys, $values]; } protected function listSeparatorForJoin($list1, $sep) @@ -4162,7 +5716,7 @@ protected function listSeparatorForJoin($list1, $sep) } } - protected static $libJoin = array('list1', 'list2', 'separator'); + protected static $libJoin = ['list1', 'list2', 'separator']; protected function libJoin($args) { list($list1, $list2, $sep) = $args; @@ -4171,10 +5725,10 @@ protected function libJoin($args) $list2 = $this->coerceList($list2, ' '); $sep = $this->listSeparatorForJoin($list1, $sep); - return array('list', $sep, array_merge($list1[2], $list2[2])); + return [Type::T_LIST, $sep, array_merge($list1[2], $list2[2])]; } - protected static $libAppend = array('list', 'val', 'separator'); + protected static $libAppend = ['list', 'val', 'separator']; protected function libAppend($args) { list($list1, $value, $sep) = $args; @@ -4182,7 +5736,7 @@ protected function libAppend($args) $list1 = $this->coerceList($list1, ' '); $sep = $this->listSeparatorForJoin($list1, $sep); - return array('list', $sep, array_merge($list1[2], array($value))); + return [Type::T_LIST, $sep, array_merge($list1[2], [$value])]; } protected function libZip($args) @@ -4191,11 +5745,11 @@ protected function libZip($args) $this->assertList($arg); } - $lists = array(); + $lists = []; $firstList = array_shift($args); foreach ($firstList[2] as $key => $item) { - $list = array('list', '', array($item)); + $list = [Type::T_LIST, '', [$item]]; foreach ($args as $arg) { if (isset($arg[2][$key])) { @@ -4204,20 +5758,21 @@ protected function libZip($args) break 2; } } + $lists[] = $list; } - return array('list', ',', $lists); + return [Type::T_LIST, ',', $lists]; } - protected static $libTypeOf = array('value'); + protected static $libTypeOf = ['value']; protected function libTypeOf($args) { $value = $args[0]; switch ($value[0]) { - case 'keyword': - if ($value === self::$true || $value === self::$false) { + case Type::T_KEYWORD: + if ($value === static::$true || $value === static::$false) { return 'bool'; } @@ -4226,10 +5781,10 @@ protected function libTypeOf($args) } // fall-thru - case 'function': + case Type::T_FUNCTION: return 'string'; - case 'list': + case Type::T_LIST: if (isset($value[3]) && $value[3]) { return 'arglist'; } @@ -4240,42 +5795,46 @@ protected function libTypeOf($args) } } - protected static $libUnit = array('number'); + protected static $libUnit = ['number']; protected function libUnit($args) { $num = $args[0]; - if ($num[0] === 'number') { - return array('string', '"', array($num[2])); + if ($num[0] === Type::T_NUMBER) { + return [Type::T_STRING, '"', [$num->unitStr()]]; } return ''; } - protected static $libUnitless = array('number'); + protected static $libUnitless = ['number']; protected function libUnitless($args) { $value = $args[0]; - return $value[0] === 'number' && empty($value[2]); + return $value[0] === Type::T_NUMBER && $value->unitless(); } - protected static $libComparable = array('number-1', 'number-2'); + protected static $libComparable = ['number-1', 'number-2']; protected function libComparable($args) { list($number1, $number2) = $args; - if (! isset($number1[0]) || $number1[0] !== 'number' || ! isset($number2[0]) || $number2[0] !== 'number') { + if (! isset($number1[0]) || $number1[0] !== Type::T_NUMBER || + ! isset($number2[0]) || $number2[0] !== Type::T_NUMBER + ) { $this->throwError('Invalid argument(s) for "comparable"'); + + return null; } - $number1 = $this->normalizeNumber($number1); - $number2 = $this->normalizeNumber($number2); + $number1 = $number1->normalize(); + $number2 = $number2->normalize(); - return $number1[2] === $number2[2] || $number1[2] === '' || $number2[2] === ''; + return $number1[2] === $number2[2] || $number1->unitless() || $number2->unitless(); } - protected static $libStrIndex = array('string', 'substring'); + protected static $libStrIndex = ['string', 'substring']; protected function libStrIndex($args) { $string = $this->coerceString($args[0]); @@ -4286,10 +5845,10 @@ protected function libStrIndex($args) $result = strpos($stringContent, $substringContent); - return $result === false ? self::$null : array('number', $result + 1, ''); + return $result === false ? static::$null : new Node\Number($result + 1, ''); } - protected static $libStrInsert = array('string', 'insert', 'index'); + protected static $libStrInsert = ['string', 'insert', 'index']; protected function libStrInsert($args) { $string = $this->coerceString($args[0]); @@ -4300,88 +5859,94 @@ protected function libStrInsert($args) list(, $index) = $args[2]; - $string[2] = array(substr_replace($stringContent, $insertContent, $index - 1, 0)); + $string[2] = [substr_replace($stringContent, $insertContent, $index - 1, 0)]; return $string; } - protected static $libStrLength = array('string'); + protected static $libStrLength = ['string']; protected function libStrLength($args) { $string = $this->coerceString($args[0]); $stringContent = $this->compileStringContent($string); - return array('number', strlen($stringContent), ''); + return new Node\Number(strlen($stringContent), ''); } - protected static $libStrSlice = array('string', 'start-at', 'end-at'); + protected static $libStrSlice = ['string', 'start-at', 'end-at']; protected function libStrSlice($args) { - if ($args[2][1] == 0) { - return self::$emptyString; + if (isset($args[2]) && $args[2][1] == 0) { + return static::$nullString; } $string = $this->coerceString($args[0]); $stringContent = $this->compileStringContent($string); - $start = (int) $args[1][1] ?: 1; - $end = (int) $args[2][1]; + $start = (int) $args[1][1]; + + if ($start > 0) { + $start--; + } + + $end = (int) $args[2][1]; + $length = $end < 0 ? $end + 1 : ($end > 0 ? $end - $start : $end); - $string[2] = array(substr($stringContent, $start - 1, $end < 0 ? $end : $end - $start + 1)); + $string[2] = $length + ? [substr($stringContent, $start, $length)] + : [substr($stringContent, $start)]; return $string; } - protected static $libToLowerCase = array('string'); + protected static $libToLowerCase = ['string']; protected function libToLowerCase($args) { $string = $this->coerceString($args[0]); $stringContent = $this->compileStringContent($string); - $string[2] = array(mb_strtolower($stringContent)); + $string[2] = [function_exists('mb_strtolower') ? mb_strtolower($stringContent) : strtolower($stringContent)]; return $string; } - protected static $libToUpperCase = array('string'); + protected static $libToUpperCase = ['string']; protected function libToUpperCase($args) { $string = $this->coerceString($args[0]); $stringContent = $this->compileStringContent($string); - $string[2] = array(mb_strtoupper($stringContent)); + $string[2] = [function_exists('mb_strtoupper') ? mb_strtoupper($stringContent) : strtoupper($stringContent)]; return $string; } - protected static $libFeatureExists = array('feature'); + protected static $libFeatureExists = ['feature']; protected function libFeatureExists($args) { - /* - * The following features not not (yet) supported: - * - global-variable-shadowing - * - extend-selector-pseudoclass - * - units-level-3 - * - at-error - */ - return self::$false; + $string = $this->coerceString($args[0]); + $name = $this->compileStringContent($string); + + return $this->toBool( + array_key_exists($name, $this->registeredFeatures) ? $this->registeredFeatures[$name] : false + ); } - protected static $libFunctionExists = array('name'); + protected static $libFunctionExists = ['name']; protected function libFunctionExists($args) { $string = $this->coerceString($args[0]); $name = $this->compileStringContent($string); // user defined functions - if ($this->has(self::$namespaces['function'] . $name)) { - return self::$true; + if ($this->has(static::$namespaces['function'] . $name)) { + return true; } $name = $this->normalizeName($name); if (isset($this->userFunctions[$name])) { - return self::$true; + return true; } // built-in functions @@ -4390,45 +5955,48 @@ protected function libFunctionExists($args) return $this->toBool(is_callable($f)); } - protected static $libGlobalVariableExists = array('name'); + protected static $libGlobalVariableExists = ['name']; protected function libGlobalVariableExists($args) { $string = $this->coerceString($args[0]); $name = $this->compileStringContent($string); - return $this->has($name, $this->rootEnv) ? self::$true : self::$false; + return $this->has($name, $this->rootEnv); } - protected static $libMixinExists = array('name'); + protected static $libMixinExists = ['name']; protected function libMixinExists($args) { $string = $this->coerceString($args[0]); $name = $this->compileStringContent($string); - return $this->has(self::$namespaces['mixin'] . $name) ? self::$true : self::$false; + return $this->has(static::$namespaces['mixin'] . $name); } - protected static $libVariableExists = array('name'); + protected static $libVariableExists = ['name']; protected function libVariableExists($args) { $string = $this->coerceString($args[0]); $name = $this->compileStringContent($string); - return $this->has($name) ? self::$true : self::$false; + return $this->has($name); } /** * Workaround IE7's content counter bug. * * @param array $args + * + * @return array */ protected function libCounter($args) { - $list = array_map(array($this, 'compileValue'), $args); + $list = array_map([$this, 'compileValue'], $args); - return array('string', '', array('counter(' . implode(',', $list) . ')')); + return [Type::T_STRING, '', ['counter(' . implode(',', $list) . ')']]; } + protected static $libRandom = ['limit']; protected function libRandom($args) { if (isset($args[0])) { @@ -4436,12 +6004,14 @@ protected function libRandom($args) if ($n < 1) { $this->throwError("limit must be greater than or equal to 1"); + + return null; } - return array('number', mt_rand(1, $n), ''); + return new Node\Number(mt_rand(1, $n), ''); } - return array('number', mt_rand(1, mt_getrandmax()), ''); + return new Node\Number(mt_rand(1, mt_getrandmax()), ''); } protected function libUniqueId() @@ -4454,6 +6024,636 @@ protected function libUniqueId() $id += mt_rand(0, 10) + 1; - return array('string', '', array('u' . str_pad(base_convert($id, 10, 36), 8, '0', STR_PAD_LEFT))); + return [Type::T_STRING, '', ['u' . str_pad(base_convert($id, 10, 36), 8, '0', STR_PAD_LEFT)]]; + } + + protected static $libInspect = ['value']; + protected function libInspect($args) + { + if ($args[0] === static::$null) { + return [Type::T_KEYWORD, 'null']; + } + + return $args[0]; + } + + /** + * Preprocess selector args + * + * @param array $arg + * + * @return array|boolean + */ + protected function getSelectorArg($arg) + { + static $parser = null; + + if (is_null($parser)) { + $parser = $this->parserFactory(__METHOD__); + } + + $arg = $this->libUnquote([$arg]); + $arg = $this->compileValue($arg); + + $parsedSelector = []; + + if ($parser->parseSelector($arg, $parsedSelector)) { + $selector = $this->evalSelectors($parsedSelector); + $gluedSelector = $this->glueFunctionSelectors($selector); + + return $gluedSelector; + } + + return false; + } + + /** + * Postprocess selector to output in right format + * + * @param array $selectors + * + * @return string + */ + protected function formatOutputSelector($selectors) + { + $selectors = $this->collapseSelectors($selectors, true); + + return $selectors; + } + + protected static $libIsSuperselector = ['super', 'sub']; + protected function libIsSuperselector($args) + { + list($super, $sub) = $args; + + $super = $this->getSelectorArg($super); + $sub = $this->getSelectorArg($sub); + + return $this->isSuperSelector($super, $sub); + } + + /** + * Test a $super selector again $sub + * + * @param array $super + * @param array $sub + * + * @return boolean + */ + protected function isSuperSelector($super, $sub) + { + // one and only one selector for each arg + if (! $super || count($super) !== 1) { + $this->throwError("Invalid super selector for isSuperSelector()"); + } + + if (! $sub || count($sub) !== 1) { + $this->throwError("Invalid sub selector for isSuperSelector()"); + } + + $super = reset($super); + $sub = reset($sub); + + $i = 0; + $nextMustMatch = false; + + foreach ($super as $node) { + $compound = ''; + + array_walk_recursive( + $node, + function ($value, $key) use (&$compound) { + $compound .= $value; + } + ); + + if ($this->isImmediateRelationshipCombinator($compound)) { + if ($node !== $sub[$i]) { + return false; + } + + $nextMustMatch = true; + $i++; + } else { + while ($i < count($sub) && ! $this->isSuperPart($node, $sub[$i])) { + if ($nextMustMatch) { + return false; + } + + $i++; + } + + if ($i >= count($sub)) { + return false; + } + + $nextMustMatch = false; + $i++; + } + } + + return true; + } + + /** + * Test a part of super selector again a part of sub selector + * + * @param array $superParts + * @param array $subParts + * + * @return boolean + */ + protected function isSuperPart($superParts, $subParts) + { + $i = 0; + + foreach ($superParts as $superPart) { + while ($i < count($subParts) && $subParts[$i] !== $superPart) { + $i++; + } + + if ($i >= count($subParts)) { + return false; + } + + $i++; + } + + return true; + } + + //protected static $libSelectorAppend = ['selector...']; + protected function libSelectorAppend($args) + { + if (count($args) < 1) { + $this->throwError("selector-append() needs at least 1 argument"); + } + + $selectors = array_map([$this, 'getSelectorArg'], $args); + + return $this->formatOutputSelector($this->selectorAppend($selectors)); + } + + /** + * Append parts of the last selector in the list to the previous, recursively + * + * @param array $selectors + * + * @return array + * + * @throws \Leafo\ScssPhp\Exception\CompilerException + */ + protected function selectorAppend($selectors) + { + $lastSelectors = array_pop($selectors); + + if (! $lastSelectors) { + $this->throwError("Invalid selector list in selector-append()"); + } + + while (count($selectors)) { + $previousSelectors = array_pop($selectors); + + if (! $previousSelectors) { + $this->throwError("Invalid selector list in selector-append()"); + } + + // do the trick, happening $lastSelector to $previousSelector + $appended = []; + + foreach ($lastSelectors as $lastSelector) { + $previous = $previousSelectors; + + foreach ($lastSelector as $lastSelectorParts) { + foreach ($lastSelectorParts as $lastSelectorPart) { + foreach ($previous as $i => $previousSelector) { + foreach ($previousSelector as $j => $previousSelectorParts) { + $previous[$i][$j][] = $lastSelectorPart; + } + } + } + } + + foreach ($previous as $ps) { + $appended[] = $ps; + } + } + + $lastSelectors = $appended; + } + + return $lastSelectors; + } + + protected static $libSelectorExtend = ['selectors', 'extendee', 'extender']; + protected function libSelectorExtend($args) + { + list($selectors, $extendee, $extender) = $args; + + $selectors = $this->getSelectorArg($selectors); + $extendee = $this->getSelectorArg($extendee); + $extender = $this->getSelectorArg($extender); + + if (! $selectors || ! $extendee || ! $extender) { + $this->throwError("selector-extend() invalid arguments"); + } + + $extended = $this->extendOrReplaceSelectors($selectors, $extendee, $extender); + + return $this->formatOutputSelector($extended); + } + + protected static $libSelectorReplace = ['selectors', 'original', 'replacement']; + protected function libSelectorReplace($args) + { + list($selectors, $original, $replacement) = $args; + + $selectors = $this->getSelectorArg($selectors); + $original = $this->getSelectorArg($original); + $replacement = $this->getSelectorArg($replacement); + + if (! $selectors || ! $original || ! $replacement) { + $this->throwError("selector-replace() invalid arguments"); + } + + $replaced = $this->extendOrReplaceSelectors($selectors, $original, $replacement, true); + + return $this->formatOutputSelector($replaced); + } + + /** + * Extend/replace in selectors + * used by selector-extend and selector-replace that use the same logic + * + * @param array $selectors + * @param array $extendee + * @param array $extender + * @param boolean $replace + * + * @return array + */ + protected function extendOrReplaceSelectors($selectors, $extendee, $extender, $replace = false) + { + $saveExtends = $this->extends; + $saveExtendsMap = $this->extendsMap; + + $this->extends = []; + $this->extendsMap = []; + + foreach ($extendee as $es) { + // only use the first one + $this->pushExtends(reset($es), $extender, null); + } + + $extended = []; + + foreach ($selectors as $selector) { + if (! $replace) { + $extended[] = $selector; + } + + $n = count($extended); + + $this->matchExtends($selector, $extended); + + // if didnt match, keep the original selector if we are in a replace operation + if ($replace and count($extended) === $n) { + $extended[] = $selector; + } + } + + $this->extends = $saveExtends; + $this->extendsMap = $saveExtendsMap; + + return $extended; + } + + //protected static $libSelectorNest = ['selector...']; + protected function libSelectorNest($args) + { + if (count($args) < 1) { + $this->throwError("selector-nest() needs at least 1 argument"); + } + + $selectorsMap = array_map([$this, 'getSelectorArg'], $args); + + $envs = []; + foreach ($selectorsMap as $selectors) { + $env = new Environment(); + $env->selectors = $selectors; + + $envs[] = $env; + } + + $envs = array_reverse($envs); + $env = $this->extractEnv($envs); + $outputSelectors = $this->multiplySelectors($env); + + return $this->formatOutputSelector($outputSelectors); + } + + protected static $libSelectorParse = ['selectors']; + protected function libSelectorParse($args) + { + $selectors = reset($args); + $selectors = $this->getSelectorArg($selectors); + + return $this->formatOutputSelector($selectors); + } + + protected static $libSelectorUnify = ['selectors1', 'selectors2']; + protected function libSelectorUnify($args) + { + list($selectors1, $selectors2) = $args; + + $selectors1 = $this->getSelectorArg($selectors1); + $selectors2 = $this->getSelectorArg($selectors2); + + if (! $selectors1 || ! $selectors2) { + $this->throwError("selector-unify() invalid arguments"); + } + + // only consider the first compound of each + $compound1 = reset($selectors1); + $compound2 = reset($selectors2); + + // unify them and that's it + $unified = $this->unifyCompoundSelectors($compound1, $compound2); + + return $this->formatOutputSelector($unified); + } + + /** + * The selector-unify magic as its best + * (at least works as expected on test cases) + * + * @param array $compound1 + * @param array $compound2 + * @return array|mixed + */ + protected function unifyCompoundSelectors($compound1, $compound2) + { + if (! count($compound1)) { + return $compound2; + } + + if (! count($compound2)) { + return $compound1; + } + + // check that last part are compatible + $lastPart1 = array_pop($compound1); + $lastPart2 = array_pop($compound2); + $last = $this->mergeParts($lastPart1, $lastPart2); + + if (! $last) { + return [[]]; + } + + $unifiedCompound = [$last]; + $unifiedSelectors = [$unifiedCompound]; + + // do the rest + while (count($compound1) || count($compound2)) { + $part1 = end($compound1); + $part2 = end($compound2); + + if ($part1 && ($match2 = $this->matchPartInCompound($part1, $compound2))) { + list($compound2, $part2, $after2) = $match2; + + if ($after2) { + $unifiedSelectors = $this->prependSelectors($unifiedSelectors, $after2); + } + + $c = $this->mergeParts($part1, $part2); + $unifiedSelectors = $this->prependSelectors($unifiedSelectors, [$c]); + $part1 = $part2 = null; + + array_pop($compound1); + } + + if ($part2 && ($match1 = $this->matchPartInCompound($part2, $compound1))) { + list($compound1, $part1, $after1) = $match1; + + if ($after1) { + $unifiedSelectors = $this->prependSelectors($unifiedSelectors, $after1); + } + + $c = $this->mergeParts($part2, $part1); + $unifiedSelectors = $this->prependSelectors($unifiedSelectors, [$c]); + $part1 = $part2 = null; + + array_pop($compound2); + } + + $new = []; + + if ($part1 && $part2) { + array_pop($compound1); + array_pop($compound2); + + $s = $this->prependSelectors($unifiedSelectors, [$part2]); + $new = array_merge($new, $this->prependSelectors($s, [$part1])); + $s = $this->prependSelectors($unifiedSelectors, [$part1]); + $new = array_merge($new, $this->prependSelectors($s, [$part2])); + } elseif ($part1) { + array_pop($compound1); + + $new = array_merge($new, $this->prependSelectors($unifiedSelectors, [$part1])); + } elseif ($part2) { + array_pop($compound2); + + $new = array_merge($new, $this->prependSelectors($unifiedSelectors, [$part2])); + } + + if ($new) { + $unifiedSelectors = $new; + } + } + + return $unifiedSelectors; + } + + /** + * Prepend each selector from $selectors with $parts + * + * @param array $selectors + * @param array $parts + * + * @return array + */ + protected function prependSelectors($selectors, $parts) + { + $new = []; + + foreach ($selectors as $compoundSelector) { + array_unshift($compoundSelector, $parts); + + $new[] = $compoundSelector; + } + + return $new; + } + + /** + * Try to find a matching part in a compound: + * - with same html tag name + * - with some class or id or something in common + * + * @param array $part + * @param array $compound + * + * @return array|boolean + */ + protected function matchPartInCompound($part, $compound) + { + $partTag = $this->findTagName($part); + $before = $compound; + $after = []; + + // try to find a match by tag name first + while (count($before)) { + $p = array_pop($before); + + if ($partTag && $partTag !== '*' && $partTag == $this->findTagName($p)) { + return [$before, $p, $after]; + } + + $after[] = $p; + } + + // try again matching a non empty intersection and a compatible tagname + $before = $compound; + $after = []; + + while (count($before)) { + $p = array_pop($before); + + if ($this->checkCompatibleTags($partTag, $this->findTagName($p))) { + if (count(array_intersect($part, $p))) { + return [$before, $p, $after]; + } + } + + $after[] = $p; + } + + return false; + } + + /** + * Merge two part list taking care that + * - the html tag is coming first - if any + * - the :something are coming last + * + * @param array $parts1 + * @param array $parts2 + * + * @return array + */ + protected function mergeParts($parts1, $parts2) + { + $tag1 = $this->findTagName($parts1); + $tag2 = $this->findTagName($parts2); + $tag = $this->checkCompatibleTags($tag1, $tag2); + + // not compatible tags + if ($tag === false) { + return []; + } + + if ($tag) { + if ($tag1) { + $parts1 = array_diff($parts1, [$tag1]); + } + + if ($tag2) { + $parts2 = array_diff($parts2, [$tag2]); + } + } + + $mergedParts = array_merge($parts1, $parts2); + $mergedOrderedParts = []; + + foreach ($mergedParts as $part) { + if (strpos($part, ':') === 0) { + $mergedOrderedParts[] = $part; + } + } + + $mergedParts = array_diff($mergedParts, $mergedOrderedParts); + $mergedParts = array_merge($mergedParts, $mergedOrderedParts); + + if ($tag) { + array_unshift($mergedParts, $tag); + } + + return $mergedParts; + } + + /** + * Check the compatibility between two tag names: + * if both are defined they should be identical or one has to be '*' + * + * @param string $tag1 + * @param string $tag2 + * + * @return array|boolean + */ + protected function checkCompatibleTags($tag1, $tag2) + { + $tags = [$tag1, $tag2]; + $tags = array_unique($tags); + $tags = array_filter($tags); + + if (count($tags)>1) { + $tags = array_diff($tags, ['*']); + } + + // not compatible nodes + if (count($tags)>1) { + return false; + } + + return $tags; + } + + /** + * Find the html tag name in a selector parts list + * + * @param array $parts + * + * @return mixed|string + */ + protected function findTagName($parts) + { + foreach ($parts as $part) { + if (! preg_match('/^[\[.:#%_-]/', $part)) { + return $part; + } + } + + return ''; + } + + protected static $libSimpleSelectors = ['selector']; + protected function libSimpleSelectors($args) + { + $selector = reset($args); + $selector = $this->getSelectorArg($selector); + + // remove selectors list layer, keeping the first one + $selector = reset($selector); + + // remove parts list layer, keeping the first part + $part = reset($selector); + + $listParts = []; + + foreach ($part as $p) { + $listParts[] = [Type::T_STRING, '', [$p]]; + } + + return [Type::T_LIST, ',', $listParts]; } } diff --git a/src/Compiler/Environment.php b/src/Compiler/Environment.php new file mode 100644 index 00000000..99231f36 --- /dev/null +++ b/src/Compiler/Environment.php @@ -0,0 +1,45 @@ + + */ +class Environment +{ + /** + * @var \Leafo\ScssPhp\Block + */ + public $block; + + /** + * @var \Leafo\ScssPhp\Compiler\Environment + */ + public $parent; + + /** + * @var array + */ + public $store; + + /** + * @var array + */ + public $storeUnreduced; + + /** + * @var integer + */ + public $depth; +} diff --git a/src/Exception/CompilerException.php b/src/Exception/CompilerException.php new file mode 100644 index 00000000..7ca2e2b3 --- /dev/null +++ b/src/Exception/CompilerException.php @@ -0,0 +1,21 @@ + + */ +class CompilerException extends \Exception +{ +} diff --git a/src/Exception/ParserException.php b/src/Exception/ParserException.php new file mode 100644 index 00000000..6d64335f --- /dev/null +++ b/src/Exception/ParserException.php @@ -0,0 +1,21 @@ + + */ +class ParserException extends \Exception +{ +} diff --git a/src/Exception/RangeException.php b/src/Exception/RangeException.php new file mode 100644 index 00000000..3ba6bf14 --- /dev/null +++ b/src/Exception/RangeException.php @@ -0,0 +1,21 @@ + + */ +class RangeException extends \Exception +{ +} diff --git a/src/Exception/ServerException.php b/src/Exception/ServerException.php new file mode 100644 index 00000000..d0ed0842 --- /dev/null +++ b/src/Exception/ServerException.php @@ -0,0 +1,21 @@ + + */ +class ServerException extends \Exception +{ +} diff --git a/src/Formatter.php b/src/Formatter.php index f08cdfe7..1403859d 100644 --- a/src/Formatter.php +++ b/src/Formatter.php @@ -2,7 +2,7 @@ /** * SCSSPHP * - * @copyright 2012-2015 Leaf Corcoran + * @copyright 2012-2018 Leaf Corcoran * * @license http://opensource.org/licenses/MIT MIT * @@ -11,8 +11,11 @@ namespace Leafo\ScssPhp; +use Leafo\ScssPhp\Formatter\OutputBlock; +use Leafo\ScssPhp\SourceMap\SourceMapGenerator; + /** - * SCSS base formatter + * Base formatter * * @author Leaf Corcoran */ @@ -53,23 +56,53 @@ abstract class Formatter */ public $assignSeparator; + /** + * @var boolean + */ + public $keepSemicolons; + + /** + * @var \Leafo\ScssPhp\Formatter\OutputBlock + */ + protected $currentBlock; + + /** + * @var integer + */ + protected $currentLine; + + /** + * @var integer + */ + protected $currentColumn; + + /** + * @var \Leafo\ScssPhp\SourceMap\SourceMapGenerator + */ + protected $sourceMapGenerator; + + /** + * Initialize formatter + * + * @api + */ abstract public function __construct(); /** * Return indentation (whitespace) * - * @param integer $n - * * @return string */ - protected function indentStr($n = 0) + protected function indentStr() { - return str_repeat($this->indentChar, max($this->indentLevel + $n, 0)); + return ''; } /** * Return property assignment * + * @api + * * @param string $name * @param mixed $value * @@ -83,55 +116,80 @@ public function property($name, $value) /** * Strip semi-colon appended by property(); it's a separator, not a terminator * + * @api + * * @param array $lines */ public function stripSemicolon(&$lines) { + if ($this->keepSemicolons) { + return; + } + + if (($count = count($lines)) + && substr($lines[$count - 1], -1) === ';' + ) { + $lines[$count - 1] = substr($lines[$count - 1], 0, -1); + } } /** * Output lines inside a block * - * @param \stdClass $block + * @param \Leafo\ScssPhp\Formatter\OutputBlock $block */ - protected function blockLines($block) + protected function blockLines(OutputBlock $block) { $inner = $this->indentStr(); $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); } } /** * Output block selectors * - * @param \stdClass $block + * @param \Leafo\ScssPhp\Formatter\OutputBlock $block */ - protected function blockSelectors($block) + 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); + } + + /** + * Output block children + * + * @param \Leafo\ScssPhp\Formatter\OutputBlock $block + */ + protected function blockChildren(OutputBlock $block) + { + foreach ($block->children as $child) { + $this->block($child); + } } /** * Output non-empty block * - * @param \stdClass $block + * @param \Leafo\ScssPhp\Formatter\OutputBlock $block */ - protected function block($block) + protected function block(OutputBlock $block) { if (empty($block->lines) && empty($block->children)) { return; } + $this->currentBlock = $block; + $pre = $this->indentStr(); if (! empty($block->selectors)) { @@ -144,30 +202,41 @@ protected function block($block) $this->blockLines($block); } - foreach ($block->children as $child) { - $this->block($child); + if (! empty($block->children)) { + $this->blockChildren($block); } if (! empty($block->selectors)) { $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); } } /** * Entry point to formatting a block * - * @param \stdClass $block An abstract syntax tree + * @api + * + * @param \Leafo\ScssPhp\Formatter\OutputBlock $block An abstract syntax tree + * @param \Leafo\ScssPhp\SourceMap\SourceMapGenerator|null $sourceMapGenerator Optional source map generator * * @return string */ - public function format($block) + public function format(OutputBlock $block, SourceMapGenerator $sourceMapGenerator = null) { + $this->sourceMapGenerator = null; + + if ($sourceMapGenerator) { + $this->currentLine = 1; + $this->currentColumn = 0; + $this->sourceMapGenerator = $sourceMapGenerator; + } + ob_start(); $this->block($block); @@ -176,4 +245,31 @@ public function format($block) return $out; } + + /** + * @param string $str + */ + protected function write($str) + { + if ($this->sourceMapGenerator) { + $this->sourceMapGenerator->addMapping( + $this->currentLine, + $this->currentColumn, + $this->currentBlock->sourceLine, + //columns from parser are off by one + $this->currentBlock->sourceColumn > 0 ? $this->currentBlock->sourceColumn - 1 : 0, + $this->currentBlock->sourceName + ); + + $lines = explode("\n", $str); + $lineCount = count($lines); + $this->currentLine += $lineCount-1; + + $lastLine = array_pop($lines); + + $this->currentColumn = ($lineCount === 1 ? $this->currentColumn : 0) + strlen($lastLine); + } + + echo $str; + } } diff --git a/src/Formatter/Compact.php b/src/Formatter/Compact.php index 29874c96..4efa1a08 100644 --- a/src/Formatter/Compact.php +++ b/src/Formatter/Compact.php @@ -2,7 +2,7 @@ /** * SCSSPHP * - * @copyright 2012-2015 Leaf Corcoran + * @copyright 2012-2018 Leaf Corcoran * * @license http://opensource.org/licenses/MIT MIT * @@ -14,7 +14,7 @@ use Leafo\ScssPhp\Formatter; /** - * SCSS compact formatter + * Compact formatter * * @author Leaf Corcoran */ @@ -32,12 +32,13 @@ public function __construct() $this->close = "}\n\n"; $this->tagSeparator = ','; $this->assignSeparator = ':'; + $this->keepSemicolons = true; } /** * {@inheritdoc} */ - public function indentStr($n = 0) + public function indentStr() { return ' '; } diff --git a/src/Formatter/Compressed.php b/src/Formatter/Compressed.php index 2ab2eaae..ab38529d 100644 --- a/src/Formatter/Compressed.php +++ b/src/Formatter/Compressed.php @@ -2,7 +2,7 @@ /** * SCSSPHP * - * @copyright 2012-2015 Leaf Corcoran + * @copyright 2012-2018 Leaf Corcoran * * @license http://opensource.org/licenses/MIT MIT * @@ -12,9 +12,10 @@ namespace Leafo\ScssPhp\Formatter; use Leafo\ScssPhp\Formatter; +use Leafo\ScssPhp\Formatter\OutputBlock; /** - * SCSS compressed formatter + * Compressed formatter * * @author Leaf Corcoran */ @@ -32,32 +33,13 @@ public function __construct() $this->close = '}'; $this->tagSeparator = ','; $this->assignSeparator = ':'; + $this->keepSemicolons = false; } /** * {@inheritdoc} */ - public function indentStr($n = 0) - { - return ''; - } - - /** - * {@inheritdoc} - */ - public function stripSemicolon(&$lines) - { - if (($count = count($lines)) - && substr($lines[$count - 1], -1) === ';' - ) { - $lines[$count - 1] = substr($lines[$count - 1], 0, -1); - } - } - - /** - * {@inheritdoc} - */ - public function blockLines($block) + public function blockLines(OutputBlock $block) { $inner = $this->indentStr(); @@ -71,21 +53,29 @@ public function blockLines($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); } } /** - * {@inherit} + * Output block selectors + * + * @param \Leafo\ScssPhp\Formatter\OutputBlock $block */ - public function format($block) + protected function blockSelectors(OutputBlock $block) { - return parent::format($block); + $inner = $this->indentStr(); - // TODO: we need to fix the 2 "compressed" tests where the "close" is applied - return trim(str_replace(';}', '}', parent::format($block))); + $this->write( + $inner + . implode( + $this->tagSeparator, + str_replace([' > ', ' + ', ' ~ '], ['>', '+', '~'], $block->selectors) + ) + . $this->open . $this->break + ); } } diff --git a/src/Formatter/Crunched.php b/src/Formatter/Crunched.php index ad52c464..da740ccd 100644 --- a/src/Formatter/Crunched.php +++ b/src/Formatter/Crunched.php @@ -2,7 +2,7 @@ /** * SCSSPHP * - * @copyright 2012-2015 Leaf Corcoran + * @copyright 2012-2018 Leaf Corcoran * * @license http://opensource.org/licenses/MIT MIT * @@ -12,9 +12,10 @@ namespace Leafo\ScssPhp\Formatter; use Leafo\ScssPhp\Formatter; +use Leafo\ScssPhp\Formatter\OutputBlock; /** - * SCSS crunched formatter + * Crunched formatter * * @author Anthon Pang */ @@ -32,32 +33,13 @@ public function __construct() $this->close = '}'; $this->tagSeparator = ','; $this->assignSeparator = ':'; + $this->keepSemicolons = false; } /** * {@inheritdoc} */ - public function indentStr($n = 0) - { - return ''; - } - - /** - * {@inheritdoc} - */ - public function stripSemicolon(&$lines) - { - if (($count = count($lines)) - && substr($lines[$count - 1], -1) === ';' - ) { - $lines[$count - 1] = substr($lines[$count - 1], 0, -1); - } - } - - /** - * {@inheritdoc} - */ - public function blockLines($block) + public function blockLines(OutputBlock $block) { $inner = $this->indentStr(); @@ -69,10 +51,29 @@ public function blockLines($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); } } + + /** + * Output block selectors + * + * @param \Leafo\ScssPhp\Formatter\OutputBlock $block + */ + protected function blockSelectors(OutputBlock $block) + { + $inner = $this->indentStr(); + + $this->write( + $inner + . implode( + $this->tagSeparator, + str_replace([' > ', ' + ', ' ~ '], ['>', '+', '~'], $block->selectors) + ) + . $this->open . $this->break + ); + } } diff --git a/src/Formatter/Debug.php b/src/Formatter/Debug.php index 7e227b48..bfcbf41a 100644 --- a/src/Formatter/Debug.php +++ b/src/Formatter/Debug.php @@ -2,7 +2,7 @@ /** * SCSSPHP * - * @copyright 2012-2015 Leaf Corcoran + * @copyright 2012-2018 Leaf Corcoran * * @license http://opensource.org/licenses/MIT MIT * @@ -12,9 +12,10 @@ namespace Leafo\ScssPhp\Formatter; use Leafo\ScssPhp\Formatter; +use Leafo\ScssPhp\Formatter\OutputBlock; /** - * SCSS debug formatter + * Debug formatter * * @author Anthon Pang */ @@ -32,46 +33,89 @@ public function __construct() $this->close = ' }'; $this->tagSeparator = ', '; $this->assignSeparator = ': '; + $this->keepSemicolons = true; } /** * {@inheritdoc} */ - protected function blockLines($block) + protected function indentStr() { + return str_repeat(' ', $this->indentLevel); + } + + /** + * {@inheritdoc} + */ + protected function blockLines(OutputBlock $block) + { + $indent = $this->indentStr(); + + if (empty($block->lines)) { + $this->write("{$indent}block->lines: []\n"); + + return; + } + foreach ($block->lines as $index => $line) { - echo "block->lines[{$index}]: $line\n"; + $this->write("{$indent}block->lines[{$index}]: $line\n"); } } /** * {@inheritdoc} */ - protected function blockSelectors($block) + protected function blockSelectors(OutputBlock $block) { + $indent = $this->indentStr(); + + if (empty($block->selectors)) { + $this->write("{$indent}block->selectors: []\n"); + + return; + } + foreach ($block->selectors as $index => $selector) { - echo "block->selectors[{$index}]: $selector\n"; + $this->write("{$indent}block->selectors[{$index}]: $selector\n"); } } /** * {@inheritdoc} */ - protected function block($block) + protected function blockChildren(OutputBlock $block) { - echo "block->type: {$block->type}\n" . - "block->depth: {$block->depth}\n"; + $indent = $this->indentStr(); - if (! empty($block->selectors)) { - $this->blockSelectors($block); - } + if (empty($block->children)) { + $this->write("{$indent}block->children: []\n"); - if (! empty($block->lines)) { - $this->blockLines($block); + return; } + $this->indentLevel++; + foreach ($block->children as $i => $child) { $this->block($child); } + + $this->indentLevel--; + } + + /** + * {@inheritdoc} + */ + protected function block(OutputBlock $block) + { + $indent = $this->indentStr(); + + $this->write("{$indent}block->type: {$block->type}\n" . + "{$indent}block->depth: {$block->depth}\n"); + + $this->currentBlock = $block; + + $this->blockSelectors($block); + $this->blockLines($block); + $this->blockChildren($block); } } diff --git a/src/Formatter/Expanded.php b/src/Formatter/Expanded.php index 89ecfffb..d8c1e887 100644 --- a/src/Formatter/Expanded.php +++ b/src/Formatter/Expanded.php @@ -2,7 +2,7 @@ /** * SCSSPHP * - * @copyright 2012-2015 Leaf Corcoran + * @copyright 2012-2018 Leaf Corcoran * * @license http://opensource.org/licenses/MIT MIT * @@ -12,9 +12,10 @@ namespace Leafo\ScssPhp\Formatter; use Leafo\ScssPhp\Formatter; +use Leafo\ScssPhp\Formatter\OutputBlock; /** - * SCSS expanded formatter + * Expanded formatter * * @author Leaf Corcoran */ @@ -32,12 +33,21 @@ public function __construct() $this->close = '}'; $this->tagSeparator = ', '; $this->assignSeparator = ': '; + $this->keepSemicolons = true; } /** * {@inheritdoc} */ - protected function blockLines($block) + protected function indentStr() + { + return str_repeat($this->indentChar, $this->indentLevel); + } + + /** + * {@inheritdoc} + */ + protected function blockLines(OutputBlock $block) { $inner = $this->indentStr(); @@ -49,10 +59,10 @@ protected function blockLines($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); } } } diff --git a/src/Formatter/Nested.php b/src/Formatter/Nested.php index bf2c4a67..8f72206f 100644 --- a/src/Formatter/Nested.php +++ b/src/Formatter/Nested.php @@ -2,7 +2,7 @@ /** * SCSSPHP * - * @copyright 2012-2015 Leaf Corcoran + * @copyright 2012-2018 Leaf Corcoran * * @license http://opensource.org/licenses/MIT MIT * @@ -12,14 +12,20 @@ namespace Leafo\ScssPhp\Formatter; use Leafo\ScssPhp\Formatter; +use Leafo\ScssPhp\Formatter\OutputBlock; /** - * SCSS nested formatter + * Nested formatter * * @author Leaf Corcoran */ class Nested extends Formatter { + /** + * @var integer + */ + private $depth; + /** * {@inheritdoc} */ @@ -32,14 +38,25 @@ public function __construct() $this->close = ' }'; $this->tagSeparator = ', '; $this->assignSeparator = ': '; + $this->keepSemicolons = true; + } + + /** + * {@inheritdoc} + */ + protected function indentStr() + { + $n = $this->depth - 1; + + return str_repeat($this->indentChar, max($this->indentLevel + $n, 0)); } /** * {@inheritdoc} */ - protected function blockLines($block) + protected function blockLines(OutputBlock $block) { - $inner = $this->indentStr($block->depth - 1); + $inner = $this->indentStr(); $glue = $this->break . $inner; @@ -49,34 +66,65 @@ protected function blockLines($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); } } /** * {@inheritdoc} */ - protected function blockSelectors($block) + protected function blockSelectors(OutputBlock $block) { - $inner = $this->indentStr($block->depth - 1); + $inner = $this->indentStr(); - echo $inner + $this->write($inner . implode($this->tagSeparator, $block->selectors) - . $this->open . $this->break; + . $this->open . $this->break); } /** * {@inheritdoc} */ - protected function block($block) + protected function blockChildren(OutputBlock $block) + { + foreach ($block->children as $i => $child) { + $this->block($child); + + if ($i < count($block->children) - 1) { + $this->write($this->break); + + if (isset($block->children[$i + 1])) { + $next = $block->children[$i + 1]; + + if ($next->depth === max($block->depth, 1) && $child->depth >= $next->depth) { + $this->write($this->break); + } + } + } + } + } + + /** + * {@inheritdoc} + */ + protected function block(OutputBlock $block) { if ($block->type === 'root') { $this->adjustAllChildren($block); } + if (empty($block->lines) && empty($block->children)) { + return; + } + + $this->currentBlock = $block; + + + $this->depth = $block->depth; + if (! empty($block->selectors)) { $this->blockSelectors($block); @@ -87,42 +135,30 @@ protected function block($block) $this->blockLines($block); } - foreach ($block->children as $i => $child) { - $this->block($child); - - if ($i < count($block->children) - 1) { - echo $this->break; - - if (isset($block->children[$i + 1])) { - $next = $block->children[$i + 1]; - - if ($next->depth === max($block->depth, 1) && $child->depth >= $next->depth) { - echo $this->break; - } - } - } + if (! empty($block->children)) { + $this->blockChildren($block); } if (! empty($block->selectors)) { $this->indentLevel--; - echo $this->close; + $this->write($this->close); } if ($block->type === 'root') { - echo $this->break; + $this->write($this->break); } } /** * Adjust the depths of all children, depth first * - * @param \stdClass $block + * @param \Leafo\ScssPhp\Formatter\OutputBlock $block */ - private function adjustAllChildren($block) + private function adjustAllChildren(OutputBlock $block) { // flatten empty nested blocks - $children = array(); + $children = []; foreach ($block->children as $i => $child) { if (empty($child->lines) && empty($child->children)) { diff --git a/src/Formatter/OutputBlock.php b/src/Formatter/OutputBlock.php new file mode 100644 index 00000000..5eb589c9 --- /dev/null +++ b/src/Formatter/OutputBlock.php @@ -0,0 +1,65 @@ + + */ +class OutputBlock +{ + /** + * @var string + */ + public $type; + + /** + * @var integer + */ + public $depth; + + /** + * @var array + */ + public $selectors; + + /** + * @var array + */ + public $lines; + + /** + * @var array + */ + public $children; + + /** + * @var \Leafo\ScssPhp\Formatter\OutputBlock + */ + public $parent; + + /** + * @var string + */ + public $sourceName; + + /** + * @var integer + */ + public $sourceLine; + + /** + * @var integer + */ + public $sourceColumn; +} diff --git a/src/Node.php b/src/Node.php new file mode 100644 index 00000000..b9f7945a --- /dev/null +++ b/src/Node.php @@ -0,0 +1,40 @@ + + */ +abstract class Node +{ + /** + * @var string + */ + public $type; + + /** + * @var integer + */ + public $sourceIndex; + + /** + * @var integer + */ + public $sourceLine; + + /** + * @var integer + */ + public $sourceColumn; +} diff --git a/src/Node/Number.php b/src/Node/Number.php new file mode 100644 index 00000000..42c16803 --- /dev/null +++ b/src/Node/Number.php @@ -0,0 +1,330 @@ + + */ +class Number extends Node implements \ArrayAccess +{ + /** + * @var integer + */ + static public $precision = 10; + + /** + * @see http://www.w3.org/TR/2012/WD-css3-values-20120308/ + * + * @var array + */ + static protected $unitTable = [ + 'in' => [ + 'in' => 1, + 'pc' => 6, + 'pt' => 72, + 'px' => 96, + 'cm' => 2.54, + 'mm' => 25.4, + 'q' => 101.6, + ], + 'turn' => [ + 'deg' => 360, + 'grad' => 400, + 'rad' => 6.28318530717958647692528676, // 2 * M_PI + 'turn' => 1, + ], + 's' => [ + 's' => 1, + 'ms' => 1000, + ], + 'Hz' => [ + 'Hz' => 1, + 'kHz' => 0.001, + ], + 'dpi' => [ + 'dpi' => 1, + 'dpcm' => 2.54, + 'dppx' => 96, + ], + ]; + + /** + * @var integer|float + */ + public $dimension; + + /** + * @var array + */ + public $units; + + /** + * Initialize number + * + * @param mixed $dimension + * @param mixed $initialUnit + */ + public function __construct($dimension, $initialUnit) + { + $this->type = Type::T_NUMBER; + $this->dimension = $dimension; + $this->units = is_array($initialUnit) + ? $initialUnit + : ($initialUnit ? [$initialUnit => 1] + : []); + } + + /** + * Coerce number to target units + * + * @param array $units + * + * @return \Leafo\ScssPhp\Node\Number + */ + public function coerce($units) + { + if ($this->unitless()) { + return new Number($this->dimension, $units); + } + + $dimension = $this->dimension; + + foreach (static::$unitTable['in'] as $unit => $conv) { + $from = isset($this->units[$unit]) ? $this->units[$unit] : 0; + $to = isset($units[$unit]) ? $units[$unit] : 0; + $factor = pow($conv, $from - $to); + $dimension /= $factor; + } + + return new Number($dimension, $units); + } + + /** + * Normalize number + * + * @return \Leafo\ScssPhp\Node\Number + */ + public function normalize() + { + $dimension = $this->dimension; + $units = []; + + $this->normalizeUnits($dimension, $units, 'in'); + + return new Number($dimension, $units); + } + + /** + * {@inheritdoc} + */ + public function offsetExists($offset) + { + if ($offset === -3) { + return $this->sourceColumn !== null; + } + + if ($offset === -2) { + return $this->sourceLine !== null; + } + + if ($offset === -1 + || $offset === 0 + || $offset === 1 + || $offset === 2 + ) { + return true; + } + + return false; + } + + /** + * {@inheritdoc} + */ + public function offsetGet($offset) + { + switch ($offset) { + case -3: + return $this->sourceColumn; + + case -2: + return $this->sourceLine; + + case -1: + return $this->sourceIndex; + + case 0: + return $this->type; + + case 1: + return $this->dimension; + + case 2: + return $this->units; + } + } + + /** + * {@inheritdoc} + */ + public function offsetSet($offset, $value) + { + if ($offset === 1) { + $this->dimension = $value; + } elseif ($offset === 2) { + $this->units = $value; + } elseif ($offset == -1) { + $this->sourceIndex = $value; + } elseif ($offset == -2) { + $this->sourceLine = $value; + } elseif ($offset == -3) { + $this->sourceColumn = $value; + } + } + + /** + * {@inheritdoc} + */ + public function offsetUnset($offset) + { + if ($offset === 1) { + $this->dimension = null; + } elseif ($offset === 2) { + $this->units = null; + } elseif ($offset === -1) { + $this->sourceIndex = null; + } elseif ($offset === -2) { + $this->sourceLine = null; + } elseif ($offset === -3) { + $this->sourceColumn = null; + } + } + + /** + * Returns true if the number is unitless + * + * @return boolean + */ + public function unitless() + { + return ! array_sum($this->units); + } + + /** + * Returns unit(s) as the product of numerator units divided by the product of denominator units + * + * @return string + */ + public function unitStr() + { + $numerators = []; + $denominators = []; + + foreach ($this->units as $unit => $unitSize) { + if ($unitSize > 0) { + $numerators = array_pad($numerators, count($numerators) + $unitSize, $unit); + continue; + } + + if ($unitSize < 0) { + $denominators = array_pad($denominators, count($denominators) + $unitSize, $unit); + continue; + } + } + + return implode('*', $numerators) . (count($denominators) ? '/' . implode('*', $denominators) : ''); + } + + /** + * Output number + * + * @param \Leafo\ScssPhp\Compiler $compiler + * + * @return string + */ + public function output(Compiler $compiler = null) + { + $dimension = round($this->dimension, static::$precision); + + $units = array_filter($this->units, function ($unitSize) { + return $unitSize; + }); + + if (count($units) > 1 && array_sum($units) === 0) { + $dimension = $this->dimension; + $units = []; + + $this->normalizeUnits($dimension, $units, 'in'); + + $dimension = round($dimension, static::$precision); + $units = array_filter($units, function ($unitSize) { + return $unitSize; + }); + } + + $unitSize = array_sum($units); + + if ($compiler && ($unitSize > 1 || $unitSize < 0 || count($units) > 1)) { + $compiler->throwError((string) $dimension . $this->unitStr() . " isn't a valid CSS value."); + } + + reset($units); + $unit = key($units); + $dimension = number_format($dimension, static::$precision, '.', ''); + + return (static::$precision ? rtrim(rtrim($dimension, '0'), '.') : $dimension) . $unit; + } + + /** + * {@inheritdoc} + */ + public function __toString() + { + return $this->output(); + } + + /** + * Normalize units + * + * @param integer|float $dimension + * @param array $units + * @param string $baseUnit + */ + private function normalizeUnits(&$dimension, &$units, $baseUnit = 'in') + { + $dimension = $this->dimension; + $units = []; + + foreach ($this->units as $unit => $exp) { + if (isset(static::$unitTable[$baseUnit][$unit])) { + $factor = pow(static::$unitTable[$baseUnit][$unit], $exp); + + $unit = $baseUnit; + $dimension /= $factor; + } + + $units[$unit] = $exp + (isset($units[$unit]) ? $units[$unit] : 0); + } + } +} diff --git a/src/Parser.php b/src/Parser.php index 8b27a27e..c05e4ee8 100644 --- a/src/Parser.php +++ b/src/Parser.php @@ -2,7 +2,7 @@ /** * SCSSPHP * - * @copyright 2012-2015 Leaf Corcoran + * @copyright 2012-2018 Leaf Corcoran * * @license http://opensource.org/licenses/MIT MIT * @@ -11,133 +11,182 @@ namespace Leafo\ScssPhp; +use Leafo\ScssPhp\Block; +use Leafo\ScssPhp\Cache; use Leafo\ScssPhp\Compiler; +use Leafo\ScssPhp\Exception\ParserException; +use Leafo\ScssPhp\Node; +use Leafo\ScssPhp\Type; /** - * SCSS parser + * Parser * * @author Leaf Corcoran */ class Parser { - const SOURCE_POSITION = -1; - const SOURCE_PARSER = -2; + const SOURCE_INDEX = -1; + const SOURCE_LINE = -2; + const SOURCE_COLUMN = -3; /** * @var array */ - protected static $precedence = array( - '=' => 0, - 'or' => 1, + protected static $precedence = [ + '=' => 0, + 'or' => 1, 'and' => 2, - '==' => 3, - '!=' => 3, - '<=' => 4, - '>=' => 4, - '<' => 4, - '>' => 4, - '+' => 5, - '-' => 5, - '*' => 6, - '/' => 6, - '%' => 6, - ); - - /** - * @var array - */ - protected static $operators = array( - '+', - '-', - '*', - '/', - '%', - '==', - '!=', - '<=', - '>=', - '<', - '>', - 'and', - 'or', - ); - - protected static $operatorStr; + '==' => 3, + '!=' => 3, + '<=>' => 3, + '<=' => 4, + '>=' => 4, + '<' => 4, + '>' => 4, + '+' => 5, + '-' => 5, + '*' => 6, + '/' => 6, + '%' => 6, + ]; + + protected static $commentPattern; + protected static $operatorPattern; protected static $whitePattern; - protected static $commentMulti; - protected static $commentSingle = '//'; - protected static $commentMultiLeft = '/*'; - protected static $commentMultiRight = '*/'; + protected $cache; private $sourceName; - private $rootParser; + private $sourceIndex; + private $sourcePositions; private $charset; private $count; private $env; private $inParens; private $eatWhiteDefault; private $buffer; + private $utf8; + private $encoding; + private $patternModifiers; + private $commentsSeen; /** * Constructor * - * @param string $sourceName - * @param boolean $rootParser + * @api + * + * @param string $sourceName + * @param integer $sourceIndex + * @param string $encoding + * @param \Leafo\ScssPhp\Cache $cache */ - public function __construct($sourceName = null, $rootParser = true) + public function __construct($sourceName, $sourceIndex = 0, $encoding = 'utf-8', $cache = null) { - $this->sourceName = $sourceName; - $this->rootParser = $rootParser; - $this->charset = null; + $this->sourceName = $sourceName ?: '(stdin)'; + $this->sourceIndex = $sourceIndex; + $this->charset = null; + $this->utf8 = ! $encoding || strtolower($encoding) === 'utf-8'; + $this->patternModifiers = $this->utf8 ? 'Aisu' : 'Ais'; + $this->commentsSeen = []; + + if (empty(static::$operatorPattern)) { + static::$operatorPattern = '([*\/%+-]|[!=]\=|\>\=?|\<\=\>|\<\=?|and|or)'; - if (empty(self::$operatorStr)) { - self::$operatorStr = $this->makeOperatorStr(self::$operators); + $commentSingle = '\/\/'; + $commentMultiLeft = '\/\*'; + $commentMultiRight = '\*\/'; + + static::$commentPattern = $commentMultiLeft . '.*?' . $commentMultiRight; + static::$whitePattern = $this->utf8 + ? '/' . $commentSingle . '[^\n]*\s*|(' . static::$commentPattern . ')\s*|\s+/AisuS' + : '/' . $commentSingle . '[^\n]*\s*|(' . static::$commentPattern . ')\s*|\s+/AisS'; + } - $commentSingle = $this->pregQuote(self::$commentSingle); - $commentMultiLeft = $this->pregQuote(self::$commentMultiLeft); - $commentMultiRight = $this->pregQuote(self::$commentMultiRight); - self::$commentMulti = $commentMultiLeft . '.*?' . $commentMultiRight; - self::$whitePattern = '/' . $commentSingle . '[^\n]*\s*|(' . self::$commentMulti . ')\s*|\s+/Ais'; + if ($cache) { + $this->cache = $cache; } } /** - * Make operator regex + * Get source file name * - * @param array $operators + * @api * * @return string */ - protected static function makeOperatorStr($operators) + public function getSourceName() + { + return $this->sourceName; + } + + /** + * Throw parser error + * + * @api + * + * @param string $msg + * + * @throws \Leafo\ScssPhp\Exception\ParserException + */ + public function throwParseError($msg = 'parse error') { - return '(' - . implode('|', array_map(array('Leafo\ScssPhp\Parser', 'pregQuote'), $operators)) - . ')'; + list($line, $column) = $this->getSourcePosition($this->count); + + $loc = empty($this->sourceName) + ? "line: $line, column: $column" + : "$this->sourceName on line $line, at column $column"; + + if ($this->peek("(.*?)(\n|$)", $m, $this->count)) { + throw new ParserException("$msg: failed at `$m[1]` $loc"); + } + + throw new ParserException("$msg: $loc"); } /** * Parser buffer * - * @param string $buffer; + * @api + * + * @param string $buffer * - * @return \stdClass + * @return \Leafo\ScssPhp\Block */ public function parse($buffer) { + if ($this->cache) { + $cacheKey = $this->sourceName . ":" . md5($buffer); + $parseOptions = [ + 'charset' => $this->charset, + 'utf8' => $this->utf8, + ]; + $v = $this->cache->getCache("parse", $cacheKey, $parseOptions); + + if (! is_null($v)) { + return $v; + } + } + + // strip BOM (byte order marker) + if (substr($buffer, 0, 3) === "\xef\xbb\xbf") { + $buffer = substr($buffer, 3); + } + + $this->buffer = rtrim($buffer, "\x00..\x1f"); $this->count = 0; $this->env = null; $this->inParens = false; $this->eatWhiteDefault = true; - $this->buffer = $buffer; - $this->pushBlock(null); // root block + $this->saveEncoding(); + $this->extractLineNumbers($buffer); + $this->pushBlock(null); // root block $this->whitespace(); $this->pushBlock(null); $this->popBlock(); - while (false !== $this->parseChunk()) { + while ($this->parseChunk()) { ; } @@ -153,7 +202,11 @@ public function parse($buffer) array_unshift($this->env->children, $this->charset); } - $this->env->isRoot = true; + $this->restoreEncoding(); + + if ($this->cache) { + $this->cache->setCache("parse", $cacheKey, $this->env, $parseOptions); + } return $this->env; } @@ -161,6 +214,8 @@ public function parse($buffer) /** * Parse a value or value list * + * @api + * * @param string $buffer * @param string $out * @@ -174,12 +229,20 @@ public function parseValue($buffer, &$out) $this->eatWhiteDefault = true; $this->buffer = (string) $buffer; - return $this->valueList($out); + $this->saveEncoding(); + + $list = $this->valueList($out); + + $this->restoreEncoding(); + + return $list; } /** * Parse a selector or selector list * + * @api + * * @param string $buffer * @param string $out * @@ -193,7 +256,13 @@ public function parseSelector($buffer, &$out) $this->eatWhiteDefault = true; $this->buffer = (string) $buffer; - return $this->selectors($out); + $this->saveEncoding(); + + $selector = $this->selectors($out); + + $this->restoreEncoding(); + + return $selector; } /** @@ -229,7 +298,7 @@ public function parseSelector($buffer, &$out) * the buffer position will be left at an invalid state. In order to * avoid this, Compiler::seek() is used to remember and set buffer positions. * - * Before parsing a chain, use $s = $this->seek() to remember the current + * Before parsing a chain, use $s = $this->count to remember the current * position into $s. Then if a chain fails, use $this->seek($s) to * go back where we started. * @@ -237,12 +306,26 @@ public function parseSelector($buffer, &$out) */ protected function parseChunk() { - $s = $this->seek(); + $s = $this->count; // the directives if (isset($this->buffer[$this->count]) && $this->buffer[$this->count] === '@') { - if ($this->literal('@media') && $this->mediaQueryList($mediaQueryList) && $this->literal('{')) { - $media = $this->pushSpecialBlock('media', $s); + if ($this->literal('@at-root', 8) && + ($this->selectors($selector) || true) && + ($this->map($with) || true) && + $this->matchChar('{') + ) { + $atRoot = $this->pushSpecialBlock(Type::T_AT_ROOT, $s); + $atRoot->selector = $selector; + $atRoot->with = $with; + + return true; + } + + $this->seek($s); + + if ($this->literal('@media', 6) && $this->mediaQueryList($mediaQueryList) && $this->matchChar('{')) { + $media = $this->pushSpecialBlock(Type::T_MEDIA, $s); $media->queryList = $mediaQueryList[2]; return true; @@ -250,12 +333,12 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@mixin') && + if ($this->literal('@mixin', 6) && $this->keyword($mixinName) && ($this->argumentDef($args) || true) && - $this->literal('{') + $this->matchChar('{') ) { - $mixin = $this->pushSpecialBlock('mixin', $s); + $mixin = $this->pushSpecialBlock(Type::T_MIXIN, $s); $mixin->name = $mixinName; $mixin->args = $args; @@ -264,19 +347,18 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@include') && + if ($this->literal('@include', 8) && $this->keyword($mixinName) && - ($this->literal('(') && + ($this->matchChar('(') && ($this->argValues($argValues) || true) && - $this->literal(')') || true) && + $this->matchChar(')') || true) && ($this->end() || - $this->literal('{') && $hasBlock = true) + $this->matchChar('{') && $hasBlock = true) ) { - $child = array('include', - $mixinName, isset($argValues) ? $argValues : null, null); + $child = [Type::T_INCLUDE, $mixinName, isset($argValues) ? $argValues : null, null]; if (! empty($hasBlock)) { - $include = $this->pushSpecialBlock('include', $s); + $include = $this->pushSpecialBlock(Type::T_INCLUDE, $s); $include->child = $child; } else { $this->append($child, $s); @@ -287,45 +369,58 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@import') && + if ($this->literal('@scssphp-import-once', 20) && + $this->valueList($importPath) && + $this->end() + ) { + $this->append([Type::T_SCSSPHP_IMPORT_ONCE, $importPath], $s); + + return true; + } + + $this->seek($s); + + if ($this->literal('@import', 7) && $this->valueList($importPath) && $this->end() ) { - $this->append(array('import', $importPath), $s); + $this->append([Type::T_IMPORT, $importPath], $s); return true; } $this->seek($s); - if ($this->literal('@import') && + if ($this->literal('@import', 7) && $this->url($importPath) && $this->end() ) { - $this->append(array('import', $importPath), $s); + $this->append([Type::T_IMPORT, $importPath], $s); return true; } $this->seek($s); - if ($this->literal('@extend') && - $this->selectors($selector) && + if ($this->literal('@extend', 7) && + $this->selectors($selectors) && $this->end() ) { - $this->append(array('extend', $selector), $s); + // check for '!flag' + $optional = $this->stripOptionalFlag($selectors); + $this->append([Type::T_EXTEND, $selectors, $optional], $s); return true; } $this->seek($s); - if ($this->literal('@function') && + if ($this->literal('@function', 9) && $this->keyword($fnName) && $this->argumentDef($args) && - $this->literal('{') + $this->matchChar('{') ) { - $func = $this->pushSpecialBlock('function', $s); + $func = $this->pushSpecialBlock(Type::T_FUNCTION, $s); $func->name = $fnName; $func->args = $args; @@ -334,21 +429,37 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@return') && $this->valueList($retVal) && $this->end()) { - $this->append(array('return', $retVal), $s); + if ($this->literal('@break', 6) && $this->end()) { + $this->append([Type::T_BREAK], $s); + + return true; + } + + $this->seek($s); + + if ($this->literal('@continue', 9) && $this->end()) { + $this->append([Type::T_CONTINUE], $s); + + return true; + } + + $this->seek($s); + + if ($this->literal('@return', 7) && ($this->valueList($retVal) || true) && $this->end()) { + $this->append([Type::T_RETURN, isset($retVal) ? $retVal : [Type::T_NULL]], $s); return true; } $this->seek($s); - if ($this->literal('@each') && + if ($this->literal('@each', 5) && $this->genericList($varNames, 'variable', ',', false) && - $this->literal('in') && + $this->literal('in', 2) && $this->valueList($list) && - $this->literal('{') + $this->matchChar('{') ) { - $each = $this->pushSpecialBlock('each', $s); + $each = $this->pushSpecialBlock(Type::T_EACH, $s); foreach ($varNames[2] as $varName) { $each->vars[] = $varName[1]; @@ -361,11 +472,11 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@while') && + if ($this->literal('@while', 6) && $this->expression($cond) && - $this->literal('{') + $this->matchChar('{') ) { - $while = $this->pushSpecialBlock('while', $s); + $while = $this->pushSpecialBlock(Type::T_WHILE, $s); $while->cond = $cond; return true; @@ -373,16 +484,16 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@for') && + if ($this->literal('@for', 4) && $this->variable($varName) && - $this->literal('from') && + $this->literal('from', 4) && $this->expression($start) && - ($this->literal('through') || - ($forUntil = true && $this->literal('to'))) && + ($this->literal('through', 7) || + ($forUntil = true && $this->literal('to', 2))) && $this->expression($end) && - $this->literal('{') + $this->matchChar('{') ) { - $for = $this->pushSpecialBlock('for', $s); + $for = $this->pushSpecialBlock(Type::T_FOR, $s); $for->var = $varName[1]; $for->start = $start; $for->end = $end; @@ -393,51 +504,51 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@if') && $this->valueList($cond) && $this->literal('{')) { - $if = $this->pushSpecialBlock('if', $s); + if ($this->literal('@if', 3) && $this->valueList($cond) && $this->matchChar('{')) { + $if = $this->pushSpecialBlock(Type::T_IF, $s); $if->cond = $cond; - $if->cases = array(); + $if->cases = []; return true; } $this->seek($s); - if ($this->literal('@debug') && + if ($this->literal('@debug', 6) && $this->valueList($value) && $this->end() ) { - $this->append(array('debug', $value), $s); + $this->append([Type::T_DEBUG, $value], $s); return true; } $this->seek($s); - if ($this->literal('@warn') && + if ($this->literal('@warn', 5) && $this->valueList($value) && $this->end() ) { - $this->append(array('warn', $value), $s); + $this->append([Type::T_WARN, $value], $s); return true; } $this->seek($s); - if ($this->literal('@error') && + if ($this->literal('@error', 6) && $this->valueList($value) && $this->end() ) { - $this->append(array('error', $value), $s); + $this->append([Type::T_ERROR, $value], $s); return true; } $this->seek($s); - if ($this->literal('@content') && $this->end()) { - $this->append(array('mixin_content'), $s); + if ($this->literal('@content', 8) && $this->end()) { + $this->append([Type::T_MIXIN_CONTENT], $s); return true; } @@ -446,14 +557,14 @@ protected function parseChunk() $last = $this->last(); - if (isset($last) && $last[0] === 'if') { + if (isset($last) && $last[0] === Type::T_IF) { list(, $if) = $last; - if ($this->literal('@else')) { - if ($this->literal('{')) { - $else = $this->pushSpecialBlock('else', $s); - } elseif ($this->literal('if') && $this->valueList($cond) && $this->literal('{')) { - $else = $this->pushSpecialBlock('elseif', $s); + if ($this->literal('@else', 5)) { + if ($this->matchChar('{')) { + $else = $this->pushSpecialBlock(Type::T_ELSE, $s); + } elseif ($this->literal('if', 2) && $this->valueList($cond) && $this->matchChar('{')) { + $else = $this->pushSpecialBlock(Type::T_ELSEIF, $s); $else->cond = $cond; } @@ -469,17 +580,18 @@ protected function parseChunk() } // only retain the first @charset directive encountered - if ($this->literal('@charset') && - $this->valueList($charset) && $this->end() + if ($this->literal('@charset', 8) && + $this->valueList($charset) && + $this->end() ) { if (! isset($this->charset)) { - $statement = array('charset', $charset); + $statement = [Type::T_CHARSET, $charset]; - $statement[self::SOURCE_POSITION] = $s; + list($line, $column) = $this->getSourcePosition($s); - if (! $this->rootParser) { - $statement[self::SOURCE_PARSER] = $this; - } + $statement[static::SOURCE_LINE] = $line; + $statement[static::SOURCE_COLUMN] = $column; + $statement[static::SOURCE_INDEX] = $this->sourceIndex; $this->charset = $statement; } @@ -490,12 +602,17 @@ protected function parseChunk() $this->seek($s); // doesn't match built in directive, do generic one - if ($this->literal('@', false) && $this->keyword($dirName) && + if ($this->matchChar('@', false) && + $this->keyword($dirName) && ($this->variable($dirValue) || $this->openString('{', $dirValue) || true) && - $this->literal('{') + $this->matchChar('{') ) { - $directive = $this->pushSpecialBlock('directive', $s); - $directive->name = $dirName; + if ($dirName === 'media') { + $directive = $this->pushSpecialBlock(Type::T_MEDIA, $s); + } else { + $directive = $this->pushSpecialBlock(Type::T_DIRECTIVE, $s); + $directive->name = $dirName; + } if (isset($dirValue)) { $directive->value = $dirValue; @@ -512,12 +629,12 @@ protected function parseChunk() // property shortcut // captures most properties before having to parse a selector if ($this->keyword($name, false) && - $this->literal(': ') && + $this->literal(': ', 2) && $this->valueList($value) && $this->end() ) { - $name = array('string', '', array($name)); - $this->append(array('assign', $name, $value), $s); + $name = [Type::T_STRING, '', [$name]]; + $this->append([Type::T_ASSIGN, $name, $value], $s); return true; } @@ -526,12 +643,13 @@ protected function parseChunk() // variable assigns if ($this->variable($name) && - $this->literal(':') && - $this->valueList($value) && $this->end() + $this->matchChar(':') && + $this->valueList($value) && + $this->end() ) { // check for '!flag' - $assignmentFlag = $this->stripAssignmentFlag($value); - $this->append(array('assign', $name, $value, $assignmentFlag), $s); + $assignmentFlags = $this->stripAssignmentFlags($value); + $this->append([Type::T_ASSIGN, $name, $value, $assignmentFlags], $s); return true; } @@ -539,13 +657,18 @@ protected function parseChunk() $this->seek($s); // misc - if ($this->literal('-->')) { + if ($this->literal('-->', 3)) { return true; } // opening css block - if ($this->selectors($selectors) && $this->literal('{')) { - $b = $this->pushBlock($selectors, $s); + if ($this->selectors($selectors) && $this->matchChar('{', false)) { + $this->pushBlock($selectors, $s); + + if ($this->eatWhiteDefault) { + $this->whitespace(); + $this->append(null); // collect comments at the begining if needed + } return true; } @@ -553,16 +676,20 @@ protected function parseChunk() $this->seek($s); // property assign, or nested assign - if ($this->propertyName($name) && $this->literal(':')) { + if ($this->propertyName($name) && $this->matchChar(':')) { $foundSomething = false; if ($this->valueList($value)) { - $this->append(array('assign', $name, $value), $s); + if (empty($this->env->parent)) { + $this->throwParseError('expected "{"'); + } + + $this->append([Type::T_ASSIGN, $name, $value], $s); $foundSomething = true; } - if ($this->literal('{')) { - $propBlock = $this->pushSpecialBlock('nestedprop', $s); + if ($this->matchChar('{')) { + $propBlock = $this->pushSpecialBlock(Type::T_NESTED_PROPERTY, $s); $propBlock->prefix = $name; $foundSomething = true; } elseif ($foundSomething) { @@ -577,25 +704,25 @@ protected function parseChunk() $this->seek($s); // closing a block - if ($this->literal('}')) { + if ($this->matchChar('}')) { $block = $this->popBlock(); - if (isset($block->type) && $block->type === 'include') { + if (isset($block->type) && $block->type === Type::T_INCLUDE) { $include = $block->child; unset($block->child); $include[3] = $block; $this->append($include, $s); } elseif (empty($block->dontAppend)) { - $type = isset($block->type) ? $block->type : 'block'; - $this->append(array($type, $block), $s); + $type = isset($block->type) ? $block->type : Type::T_BLOCK; + $this->append([$type, $block], $s); } return true; } // extra stuff - if ($this->literal(';') || - $this->literal('