diff --git a/.gitattributes b/.gitattributes index 73d1a258..764b54af 100644 --- a/.gitattributes +++ b/.gitattributes @@ -3,6 +3,5 @@ Makefile export-ignore .gitattributes export-ignore .gitignore export-ignore .travis.yml export-ignore -box.json.dist export-ignore phpunit.xml.dist export-ignore tests/ export-ignore diff --git a/.gitignore b/.gitignore index 999984a4..803824e1 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,4 @@ composer.lock /compass/ /vendor/ /frameworks/ +.phpunit.result.cache diff --git a/.travis.yml b/.travis.yml index ccbbf00b..e7c24358 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,7 +6,9 @@ php: - 7.0 - 7.1 - 7.2 - - nightly + - 7.3 + - 7.4 + - nightly # php 8 install: composer install diff --git a/LICENSE.md b/LICENSE.md index 2f5412f9..afcfdfb2 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,4 +1,4 @@ -Copyright (c) 2015 Leaf Corcoran, http://leafo.github.io/scssphp +Copyright (c) 2015 Leaf Corcoran, http://scssphp.github.io/scssphp Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the diff --git a/Makefile b/Makefile index fb50ffdb..8a2c6a4d 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,15 @@ +install-test: + mkdir -p vendor/sass + cd vendor/sass && git clone https://github.com/sass/sass-spec.git && cd ../.. + test: vendor/bin/phpunit --colors tests compat: - TEST_SCSS_COMPAT=1 vendor/bin/phpunit --colors tests | tail -2 + TEST_SCSS_COMPAT=1 vendor/bin/phpunit --colors tests | tee /tmp/incompatible.log | tail -2 + +sass-spec: + TEST_SASS_SPEC=1 vendor/bin/phpunit --colors tests 2>&1 | tee /tmp/sass-spec.log | tail -2 standard: - vendor/bin/phpcs --standard=PSR2 bin src example tests *.php + vendor/bin/phpcs -s --standard=PSR12 --exclude=PSR12.Properties.ConstantVisibility --extensions=php bin src tests *.php diff --git a/README.md b/README.md index 53a4c7a4..cd5fce1d 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # scssphp -### +### -[![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) +[![Build](https://travis-ci.org/scssphp/scssphp.svg?branch=master)](https://travis-ci.org/scssphp/scssphp) +[![License](https://poser.pugx.org/scssphp/scssphp/license)](https://packagist.org/packages/scssphp/scssphp) `scssphp` is a compiler for SCSS written in PHP. -Checkout the homepage, , for directions on how to use. +Checkout the homepage, , for directions on how to use. ## Running Tests @@ -24,7 +24,6 @@ There are several tests in the `tests/` directory: * `InputTest.php` compiles every `.scss` file in the `tests/inputs` directory then compares to the respective `.css` file in the `tests/outputs` directory. * `ScssTest.php` extracts (ruby) `scss` tests from the `tests/scss_test.rb` file. -* `ServerTest.php` contains functional tests for the `Server` class. When changing any of the tests in `tests/inputs`, the tests will most likely fail because the output has changed. Once you verify that the output is correct @@ -40,8 +39,8 @@ To enable the `scss` compatibility tests: ## Coding Standard -`scssphp` source conforms to [PSR2](http://www.php-fig.org/psr/psr-2/). +`scssphp` source conforms to [PSR12](https://www.php-fig.org/psr/psr-12/). Run the following command from the root directory to check the code for "sniffs". - vendor/bin/phpcs --standard=PSR2 bin src tests + vendor/bin/phpcs --standard=PSR12 --extensions=php bin src tests *.php diff --git a/bin/pscss b/bin/pscss index ce80e6a9..d48af2f8 100755 --- a/bin/pscss +++ b/bin/pscss @@ -1,36 +1,35 @@ #!/usr/bin/env php setLineNumberStyle(Compiler::LINE_COMMENTS); } -if ($ignoreErrors) { - $scss->setIgnoreErrors($ignoreErrors); -} - if ($loadPaths) { $scss->setImportPaths(explode(PATH_SEPARATOR, $loadPaths)); } -if ($precision) { - $scss->setNumberPrecision($precision); -} - if ($style) { - $scss->setFormatter('Leafo\\ScssPhp\\Formatter\\' . ucfirst($style)); + $scss->setFormatter('ScssPhp\\ScssPhp\\Formatter\\' . ucfirst($style)); } if ($sourceMap) { diff --git a/composer.json b/composer.json index 62153e7b..7f420edf 100644 --- a/composer.json +++ b/composer.json @@ -1,34 +1,63 @@ { - "name": "leafo/scssphp", + "name": "scssphp/scssphp", "type": "library", "description": "scssphp is a compiler for SCSS written in PHP.", "keywords": ["css", "stylesheet", "scss", "sass", "less"], - "homepage": "http://leafo.github.io/scssphp/", + "homepage": "http://scssphp.github.io/scssphp/", "license": [ "MIT" ], "authors": [ { - "name": "Leaf Corcoran", - "email": "leafot@gmail.com", - "homepage": "http://leafo.net" + "name": "Anthon Pang", + "email": "apang@softwaredevelopment.ca", + "homepage": "https://github.com/robocoder" + }, + { + "name": "Cédric Morin", + "email": "cedric@yterium.com", + "homepage": "https://github.com/Cerdic" } ], "autoload": { - "psr-4": { "Leafo\\ScssPhp\\": "src/" } + "psr-4": { "ScssPhp\\ScssPhp\\": "src/" } }, "autoload-dev": { - "psr-4": { "Leafo\\ScssPhp\\Test\\": "tests/" } + "psr-4": { "ScssPhp\\ScssPhp\\Tests\\": "tests/" } }, "require": { - "php": "^5.6.0 || ^7" + "php": ">=5.6.0", + "ext-json": "*", + "ext-ctype": "*" }, "require-dev": { - "squizlabs/php_codesniffer": "~2.5", - "phpunit/phpunit": "~4.6", + "sass/sass-spec": "2020.08.10", + "squizlabs/php_codesniffer": "~3.5", + "phpunit/phpunit": "^5.7 || ^6.5 || ^7.5 || ^8.3", "twbs/bootstrap": "~4.3", "zurb/foundation": "~6.5" }, + "repositories": [ + { + "type": "package", + "package": { + "name": "sass/sass-spec", + "version": "2020.08.10", + "source": { + "type": "git", + "url": "https://github.com/sass/sass-spec.git", + "reference": "73222792c42a516d62e2e25c3f5d9e35f5567030" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sass/sass-spec/zipball/73222792c42a516d62e2e25c3f5d9e35f5567030", + "reference": "73222792c42a516d62e2e25c3f5d9e35f5567030", + "shasum": "" + } + } + } + ], + "minimum-stability": "dev", "bin": ["bin/pscss"], "archive": { "exclude": [ diff --git a/example/Server.php b/example/Server.php deleted file mode 100644 index 54060b1a..00000000 --- a/example/Server.php +++ /dev/null @@ -1,515 +0,0 @@ - - */ -class Server -{ - /** - * @var boolean - */ - private $showErrorsAsCSS; - - /** - * @var string - */ - private $dir; - - /** - * @var string - */ - private $cacheDir; - - /** - * @var \Leafo\ScssPhp\Compiler - */ - private $scss; - - /** - * Join path components - * - * @param string $left Path component, left of the directory separator - * @param string $right Path component, right of the directory separator - * - * @return string - */ - protected function join($left, $right) - { - return rtrim($left, '/\\') . DIRECTORY_SEPARATOR . ltrim($right, '/\\'); - } - - /** - * Get name of requested .scss file - * - * @return string|null - */ - protected function inputName() - { - switch (true) { - case isset($_GET['p']): - return $_GET['p']; - case isset($_SERVER['PATH_INFO']): - return $_SERVER['PATH_INFO']; - case isset($_SERVER['DOCUMENT_URI']): - return substr($_SERVER['DOCUMENT_URI'], strlen($_SERVER['SCRIPT_NAME'])); - } - } - - /** - * Get path to requested .scss file - * - * @return string - */ - protected function findInput() - { - if (($input = $this->inputName()) - && strpos($input, '..') === false - && substr($input, -5) === '.scss' - ) { - $name = $this->join($this->dir, $input); - - if (is_file($name) && is_readable($name)) { - return $name; - } - } - - return false; - } - - /** - * Get path to cached .css file - * - * @return string - */ - protected function cacheName($fname) - { - return $this->join($this->cacheDir, md5($fname) . '.css'); - } - - /** - * Get path to meta data - * - * @return string - */ - protected function metadataName($out) - { - return $out . '.meta'; - } - - /** - * Determine whether .scss file needs to be re-compiled. - * - * @param string $out Output path - * @param string $etag ETag - * - * @return boolean True if compile required. - */ - protected function needsCompile($out, &$etag) - { - if (! is_file($out)) { - return true; - } - - $mtime = filemtime($out); - - $metadataName = $this->metadataName($out); - - if (is_readable($metadataName)) { - $metadata = unserialize(file_get_contents($metadataName)); - - 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; - } - - return true; - } - - /** - * Get If-Modified-Since header from client request - * - * @return string|null - */ - protected function getIfModifiedSinceHeader() - { - $modifiedSince = null; - - if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE'])) { - $modifiedSince = $_SERVER['HTTP_IF_MODIFIED_SINCE']; - - if (false !== ($semicolonPos = strpos($modifiedSince, ';'))) { - $modifiedSince = substr($modifiedSince, 0, $semicolonPos); - } - } - - return $modifiedSince; - } - - /** - * Get If-None-Match header from client request - * - * @return string|null - */ - protected function getIfNoneMatchHeader() - { - $noneMatch = null; - - if (isset($_SERVER['HTTP_IF_NONE_MATCH'])) { - $noneMatch = $_SERVER['HTTP_IF_NONE_MATCH']; - } - - return $noneMatch; - } - - /** - * Compile .scss file - * - * @param string $in Input path (.scss) - * @param string $out Output path (.css) - * - * @return array - */ - protected function compile($in, $out) - { - $start = microtime(true); - $css = $this->scss->compile(file_get_contents($in), $in); - $elapsed = round((microtime(true) - $start), 4); - - $v = Version::VERSION; - $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([ - 'etag' => $etag, - 'imports' => $this->scss->getParsedFiles(), - 'vars' => crc32(serialize($this->scss->getVariables())), - ]) - ); - - return [$css, $etag]; - } - - /** - * Format error as a pseudo-element in CSS - * - * @param \Exception $error - * - * @return string - */ - protected function createErrorCSS(\Exception $error) - { - $message = str_replace( - ["'", "\n"], - ["\\'", "\\A"], - $error->getfile() . ":\n\n" . $error->getMessage() - ); - - return "body { display: none !important; } - html:after { - background: white; - color: black; - content: '$message'; - display: block !important; - font-family: mono; - padding: 1em; - white-space: pre; - }"; - } - - /** - * Render errors as a pseudo-element within valid CSS, displaying the errors on any - * page that includes this CSS. - * - * @param boolean $show - */ - public function showErrorsAsCSS($show = true) - { - $this->showErrorsAsCSS = $show; - } - - /** - * Compile .scss file - * - * @param string $in Input file (.scss) - * @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 ServerException('load error: failed to find ' . $in); - } - - $pi = pathinfo($in); - - $this->scss->addImportPath($pi['dirname'] . '/'); - - $compiled = $this->scss->compile(file_get_contents($in), $in); - - if ($out !== null) { - return file_put_contents($out, $compiled); - } - - return $compiled; - } - - /** - * Check if file need compiling - * - * @param string $in Input file (.scss) - * @param string $out Output file (.css) - * - * @return bool - */ - public function checkedCompile($in, $out) - { - if (! is_file($out) || filemtime($in) > filemtime($out)) { - $this->compileFile($in, $out); - - return true; - } - - return false; - } - - /** - * Compile requested scss and serve css. Outputs HTTP response. - * - * @param string $salt Prefix a string to the filename for creating the cache name hash - */ - public function serve($salt = '') - { - $protocol = isset($_SERVER['SERVER_PROTOCOL']) - ? $_SERVER['SERVER_PROTOCOL'] - : 'HTTP/1.0'; - - if ($input = $this->findInput()) { - $output = $this->cacheName($salt . $input); - $etag = $noneMatch = trim($this->getIfNoneMatchHeader(), '"'); - - if ($this->needsCompile($output, $etag)) { - try { - list($css, $etag) = $this->compile($input, $output); - - $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'); - - echo $this->createErrorCSS($e); - } else { - header($protocol . ' 500 Internal Server Error'); - header('Content-type: text/plain'); - - echo 'Parse error: ' . $e->getMessage() . "\n"; - } - } - - return; - } - - header('X-SCSS-Cache: true'); - header('Content-type: text/css'); - header('ETag: "' . $etag . '"'); - - if ($etag === $noneMatch) { - header($protocol . ' 304 Not Modified'); - - return; - } - - $modifiedSince = $this->getIfModifiedSinceHeader(); - $mtime = filemtime($output); - - if (strtotime($modifiedSince) === $mtime) { - header($protocol . ' 304 Not Modified'); - - return; - } - - $lastModified = gmdate('r', $mtime); - header('Last-Modified: ' . $lastModified); - - echo file_get_contents($output); - - return; - } - - header($protocol . ' 404 Not Found'); - header('Content-type: text/plain'); - - $v = Version::VERSION; - echo "/* INPUT NOT FOUND scss $v */\n"; - } - - /** - * Based on explicit input/output files does a full change check on cache before compiling. - * - * @param string $in - * @param string $out - * @param boolean $force - * - * @return string Compiled CSS results - * - * @throws \Leafo\ScssPhp\Exception\ServerException - */ - public function checkedCachedCompile($in, $out, $force = false) - { - if (! is_file($in) || ! is_readable($in)) { - throw new ServerException('Invalid or unreadable input file specified.'); - } - - if (is_dir($out) || ! is_writable(file_exists($out) ? $out : dirname($out))) { - throw new ServerException('Invalid or unwritable output file specified.'); - } - - if ($force || $this->needsCompile($out, $etag)) { - list($css, $etag) = $this->compile($in, $out); - } else { - $css = file_get_contents($out); - } - - 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 - * - * @param string $dir Root directory to .scss files - * @param string $cacheDir Cache directory - * @param \Leafo\ScssPhp\Compiler|null $scss SCSS compiler instance - */ - public function __construct($dir, $cacheDir = null, $scss = null) - { - $this->dir = $dir; - - if (! isset($cacheDir)) { - $cacheDir = $this->join($dir, 'scss_cache'); - } - - $this->cacheDir = $cacheDir; - - if (! is_dir($this->cacheDir)) { - throw new ServerException('Cache directory doesn\'t exist: ' . $cacheDir); - } - - if (! isset($scss)) { - $scss = new Compiler(); - $scss->setImportPaths($this->dir); - } - - $this->scss = $scss; - $this->showErrorsAsCSS = false; - - date_default_timezone_set('UTC'); - } -} diff --git a/phpcs.xml.dist b/phpcs.xml.dist new file mode 100644 index 00000000..b162dbd6 --- /dev/null +++ b/phpcs.xml.dist @@ -0,0 +1,12 @@ + + + + + + + + + + diff --git a/phpunit.xml.dist b/phpunit.xml.dist index c007930c..81e4bc30 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -10,8 +10,7 @@ convertWarningsToExceptions = "true" processIsolation = "false" stopOnFailure = "false" - syntaxCheck = "false" - bootstrap = "scss.inc.php"> + bootstrap = "vendor/autoload.php"> diff --git a/scss.inc.php b/scss.inc.php index 8a3cfb83..abbd9d21 100644 --- a/scss.inc.php +++ b/scss.inc.php @@ -1,15 +1,17 @@ */ class Cache { - const CACHE_VERSION = 0; + const CACHE_VERSION = 1; // directory used for storing data public static $cacheDir = false; @@ -41,12 +41,12 @@ class Cache public static $prefix = 'scssphp_'; // force a refresh : 'once' for refreshing the first hit on a cache only, true to never use the cache in this hit - public static $forceFefresh = false; + public static $forceRefresh = false; // specifies the number of seconds after which data cached will be seen as 'garbage' and potentially cleaned up public static $gcLifetime = 604800; - // array of already refreshed cache if $forceFefresh==='once' + // array of already refreshed cache if $forceRefresh==='once' protected static $refreshed = []; /** @@ -57,12 +57,12 @@ class Cache public function __construct($options) { // check $cacheDir - if (isset($options['cache_dir'])) { - self::$cacheDir = $options['cache_dir']; + if (isset($options['cacheDir'])) { + self::$cacheDir = $options['cacheDir']; } if (empty(self::$cacheDir)) { - throw new Exception('cache_dir not set'); + throw new Exception('cacheDir not set'); } if (isset($options['prefix'])) { @@ -74,7 +74,7 @@ public function __construct($options) } if (isset($options['forceRefresh'])) { - self::$forceFefresh = $options['force_refresh']; + self::$forceRefresh = $options['forceRefresh']; } self::checkCacheDir(); @@ -97,18 +97,20 @@ public function getCache($operation, $what, $options = [], $lastModified = null) { $fileCache = self::$cacheDir . self::cacheName($operation, $what, $options); - if ((! self::$forceRefresh || (self::$forceRefresh === 'once' && isset(self::$refreshed[$fileCache]))) - && file_exists($fileCache) + if ( + ((self::$forceRefresh === false) || (self::$forceRefresh === 'once' && + isset(self::$refreshed[$fileCache]))) && file_exists($fileCache) ) { $cacheTime = filemtime($fileCache); - if ((is_null($lastModified) || $cacheTime > $lastModified) - && $cacheTime + self::$gcLifetime > time() + if ( + (\is_null($lastModified) || $cacheTime > $lastModified) && + $cacheTime + self::$gcLifetime > time() ) { $c = file_get_contents($fileCache); $c = unserialize($c); - if (is_array($c) && isset($c['value'])) { + if (\is_array($c) && isset($c['value'])) { return $c['value']; } } @@ -132,6 +134,7 @@ public function setCache($operation, $what, $value, $options = []) $c = ['value' => $value]; $c = serialize($c); + file_put_contents($fileCache, $c); if (self::$forceRefresh === 'once') { @@ -176,13 +179,11 @@ 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)) { + if (! is_dir(self::$cacheDir)) { throw new Exception('Cache directory doesn\'t exist: ' . self::$cacheDir); - } elseif (! is_writable(self::$cacheDir)) { + } + + if (! is_writable(self::$cacheDir)) { throw new Exception('Cache directory isn\'t writable: ' . self::$cacheDir); } } diff --git a/src/Colors.php b/src/Colors.php index 2314ea58..4b62c361 100644 --- a/src/Colors.php +++ b/src/Colors.php @@ -1,15 +1,16 @@ '240,248,255', 'antiquewhite' => '250,235,215', + 'cyan' => '0,255,255', 'aqua' => '0,255,255', 'aquamarine' => '127,255,212', 'azure' => '240,255,255', @@ -46,13 +48,12 @@ class Colors 'cornflowerblue' => '100,149,237', 'cornsilk' => '255,248,220', 'crimson' => '220,20,60', - 'cyan' => '0,255,255', 'darkblue' => '0,0,139', 'darkcyan' => '0,139,139', 'darkgoldenrod' => '184,134,11', 'darkgray' => '169,169,169', - 'darkgreen' => '0,100,0', 'darkgrey' => '169,169,169', + 'darkgreen' => '0,100,0', 'darkkhaki' => '189,183,107', 'darkmagenta' => '139,0,139', 'darkolivegreen' => '85,107,47', @@ -74,15 +75,16 @@ class Colors 'firebrick' => '178,34,34', 'floralwhite' => '255,250,240', 'forestgreen' => '34,139,34', + 'magenta' => '255,0,255', 'fuchsia' => '255,0,255', 'gainsboro' => '220,220,220', 'ghostwhite' => '248,248,255', 'gold' => '255,215,0', 'goldenrod' => '218,165,32', 'gray' => '128,128,128', + 'grey' => '128,128,128', 'green' => '0,128,0', 'greenyellow' => '173,255,47', - 'grey' => '128,128,128', 'honeydew' => '240,255,240', 'hotpink' => '255,105,180', 'indianred' => '205,92,92', @@ -98,8 +100,8 @@ class Colors 'lightcyan' => '224,255,255', 'lightgoldenrodyellow' => '250,250,210', 'lightgray' => '211,211,211', - 'lightgreen' => '144,238,144', 'lightgrey' => '211,211,211', + 'lightgreen' => '144,238,144', 'lightpink' => '255,182,193', 'lightsalmon' => '255,160,122', 'lightseagreen' => '32,178,170', @@ -111,7 +113,6 @@ class Colors 'lime' => '0,255,0', 'limegreen' => '50,205,50', 'linen' => '250,240,230', - 'magenta' => '255,0,255', 'maroon' => '128,0,0', 'mediumaquamarine' => '102,205,170', 'mediumblue' => '0,0,205', @@ -145,7 +146,6 @@ 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', @@ -167,7 +167,6 @@ class Colors 'teal' => '0,128,128', 'thistle' => '216,191,216', 'tomato' => '255,99,71', - 'transparent' => '0,0,0,0', 'turquoise' => '64,224,208', 'violet' => '238,130,238', 'wheat' => '245,222,179', @@ -175,5 +174,72 @@ class Colors 'whitesmoke' => '245,245,245', 'yellow' => '255,255,0', 'yellowgreen' => '154,205,50', + 'rebeccapurple' => '102,51,153', + 'transparent' => '0,0,0,0', ]; + + /** + * Convert named color in a [r,g,b[,a]] array + * + * @param string $colorName + * + * @return array|null + */ + public static function colorNameToRGBa($colorName) + { + if (\is_string($colorName) && isset(static::$cssColors[$colorName])) { + $rgba = explode(',', static::$cssColors[$colorName]); + + // only case with opacity is transparent, with opacity=0, so we can intval on opacity also + $rgba = array_map('intval', $rgba); + + return $rgba; + } + + return null; + } + + /** + * Reverse conversion : from RGBA to a color name if possible + * + * @param integer $r + * @param integer $g + * @param integer $b + * @param integer $a + * + * @return string|null + */ + public static function RGBaToColorName($r, $g, $b, $a = 1) + { + static $reverseColorTable = null; + + if (! is_numeric($r) || ! is_numeric($g) || ! is_numeric($b) || ! is_numeric($a)) { + return null; + } + + if ($a < 1) { + return null; + } + + if (\is_null($reverseColorTable)) { + $reverseColorTable = []; + + foreach (static::$cssColors as $name => $rgb_str) { + $rgb_str = explode(',', $rgb_str); + + if ( + \count($rgb_str) == 3 && + ! isset($reverseColorTable[\intval($rgb_str[0])][\intval($rgb_str[1])][\intval($rgb_str[2])]) + ) { + $reverseColorTable[\intval($rgb_str[0])][\intval($rgb_str[1])][\intval($rgb_str[2])] = $name; + } + } + } + + if (isset($reverseColorTable[\intval($r)][\intval($g)][\intval($b)])) { + return $reverseColorTable[\intval($r)][\intval($g)][\intval($b)]; + } + + return null; + } } diff --git a/src/Compiler.php b/src/Compiler.php index d22d0a35..be1ef3e0 100644 --- a/src/Compiler.php +++ b/src/Compiler.php @@ -1,28 +1,29 @@ 'add', '-' => 'sub', '*' => 'mul', @@ -93,23 +94,25 @@ class Compiler /** * @var array */ - static protected $namespaces = [ + protected static $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']; + public static $true = [Type::T_KEYWORD, 'true']; + public static $false = [Type::T_KEYWORD, 'false']; + public static $NaN = [Type::T_KEYWORD, 'NaN']; + public static $Infinity = [Type::T_KEYWORD, 'Infinity']; + public static $null = [Type::T_NULL]; + public static $nullString = [Type::T_STRING, '', []]; + public static $defaultValue = [Type::T_KEYWORD, '']; + public static $selfSelector = [Type::T_SELF]; + public static $emptyList = [Type::T_LIST, '', []]; + public static $emptyMap = [Type::T_MAP, [], []]; + public static $emptyString = [Type::T_STRING, '"', []]; + public static $with = [Type::T_KEYWORD, 'with']; + public static $without = [Type::T_KEYWORD, 'without']; protected $importPaths = ['']; protected $importCache = []; @@ -129,16 +132,18 @@ class Compiler protected $sourceMap = self::SOURCE_MAP_NONE; protected $sourceMapOptions = []; + protected $hierarchyTreeCallback; + /** - * @var string|\Leafo\ScssPhp\Formatter + * @var string|\ScssPhp\ScssPhp\Formatter */ - protected $formatter = 'Leafo\ScssPhp\Formatter\Nested'; + protected $formatter = 'ScssPhp\ScssPhp\Formatter\Nested'; protected $rootEnv; protected $rootBlock; /** - * @var \Leafo\ScssPhp\Compiler\Environment + * @var \ScssPhp\ScssPhp\Compiler\Environment */ protected $env; protected $scope; @@ -159,11 +164,14 @@ class Compiler protected $stderr; protected $shouldEvaluate; protected $ignoreErrors; + protected $ignoreCallStackMessage = false; protected $callStack = []; /** * Constructor + * + * @param array|null $cacheOptions */ public function __construct($cacheOptions = null) { @@ -173,8 +181,15 @@ public function __construct($cacheOptions = null) if ($cacheOptions) { $this->cache = new Cache($cacheOptions); } + + $this->stderr = fopen('php://stderr', 'w'); } + /** + * Get compiler options + * + * @return array + */ public function getCompileOptions() { $options = [ @@ -190,6 +205,16 @@ public function getCompileOptions() return $options; } + /** + * Set an alternative error output stream, for testing purpose only + * + * @param resource $handle + */ + public function setErrorOuput($handle) + { + $this->stderr = $handle; + } + /** * Compile scss * @@ -203,19 +228,14 @@ public function getCompileOptions() public function compile($code, $path = null) { if ($this->cache) { - $cacheKey = ($path ? $path : "(stdin)") . ":" . md5($code); + $cacheKey = ($path ? $path : '(stdin)') . ':' . md5($code); $compileOptions = $this->getCompileOptions(); - $cache = $this->cache->getCache("compile", $cacheKey, $compileOptions); + $cache = $this->cache->getCache('compile', $cacheKey, $compileOptions); - if (is_array($cache) - && isset($cache['dependencies']) - && isset($cache['out']) - ) { + 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 - ) { + if (! is_file($file) || filemtime($file) !== $mtime) { unset($cache); break; } @@ -239,10 +259,10 @@ public function compile($code, $path = null) $this->storeEnv = null; $this->charsetSeen = null; $this->shouldEvaluate = null; - $this->stderr = fopen('php://stderr', 'w'); + $this->ignoreCallStackMessage = false; $this->parser = $this->parserFactory($path); - $tree = $this->parser->parse($code); + $tree = $this->parser->parse($code); $this->parser = null; $this->formatter = new $this->formatter(); @@ -256,7 +276,7 @@ public function compile($code, $path = null) $sourceMapGenerator = null; if ($this->sourceMap) { - if (is_object($this->sourceMap) && $this->sourceMap instanceof SourceMapGenerator) { + 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) { @@ -289,7 +309,7 @@ public function compile($code, $path = null) 'out' => &$out, ]; - $this->cache->setCache("compile", $cacheKey, $v, $compileOptions); + $this->cache->setCache('compile', $cacheKey, $v, $compileOptions); } return $out; @@ -300,11 +320,22 @@ public function compile($code, $path = null) * * @param string $path * - * @return \Leafo\ScssPhp\Parser + * @return \ScssPhp\ScssPhp\Parser */ protected function parserFactory($path) { - $parser = new Parser($path, count($this->sourceNames), $this->encoding, $this->cache); + // https://sass-lang.com/documentation/at-rules/import + // CSS files imported by Sass don’t allow any special Sass features. + // In order to make sure authors don’t accidentally write Sass in their CSS, + // all Sass features that aren’t also valid CSS will produce errors. + // Otherwise, the CSS will be rendered as-is. It can even be extended! + $cssOnly = false; + + if (substr($path, '-4') === '.css') { + $cssOnly = true; + } + + $parser = new Parser($path, \count($this->sourceNames), $this->encoding, $this->cache, $cssOnly); $this->sourceNames[] = $path; $this->addParsedFile($path); @@ -323,7 +354,7 @@ protected function parserFactory($path) protected function isSelfExtend($target, $origin) { foreach ($origin as $sel) { - if (in_array($target, $sel)) { + if (\in_array($target, $sel)) { return true; } } @@ -334,17 +365,13 @@ protected function isSelfExtend($target, $origin) /** * Push extends * - * @param array $target - * @param array $origin - * @param \stdClass $block + * @param array $target + * @param array $origin + * @param array|null $block */ protected function pushExtends($target, $origin, $block) { - if ($this->isSelfExtend($target, $origin)) { - return; - } - - $i = count($this->extends); + $i = \count($this->extends); $this->extends[] = [$target, $origin, $block]; foreach ($target as $part) { @@ -362,17 +389,17 @@ protected function pushExtends($target, $origin, $block) * @param string $type * @param array $selectors * - * @return \Leafo\ScssPhp\Formatter\OutputBlock + * @return \ScssPhp\ScssPhp\Formatter\OutputBlock */ protected function makeOutputBlock($type, $selectors = null) { - $out = new OutputBlock; - $out->type = $type; - $out->lines = []; - $out->children = []; - $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; @@ -390,7 +417,7 @@ protected function makeOutputBlock($type, $selectors = null) /** * Compile root * - * @param \Leafo\ScssPhp\Block $rootBlock + * @param \ScssPhp\ScssPhp\Block $rootBlock */ protected function compileRoot(Block $rootBlock) { @@ -422,15 +449,15 @@ protected function missingSelectors() $origin = $this->collapseSelectors($origin); $this->sourceLine = $block[Parser::SOURCE_LINE]; - $this->throwError("\"$origin\" failed to @extend \"$target\". The selector \"$target\" was not found."); + throw $this->error("\"$origin\" failed to @extend \"$target\". The selector \"$target\" was not found."); } } /** * Flatten selectors * - * @param \Leafo\ScssPhp\Formatter\OutputBlock $block - * @param string $parentKey + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $block + * @param string $parentKey */ protected function flattenSelectors(OutputBlock $block, $parentKey = null) { @@ -440,7 +467,7 @@ protected function flattenSelectors(OutputBlock $block, $parentKey = null) foreach ($block->selectors as $s) { $selectors[] = $s; - if (! is_array($s)) { + if (! \is_array($s)) { continue; } @@ -473,7 +500,7 @@ protected function flattenSelectors(OutputBlock $block, $parentKey = null) $block->selectors[] = $this->compileSelector($selector); } - if ($placeholderSelector && 0 === count($block->selectors) && null !== $parentKey) { + if ($placeholderSelector && 0 === \count($block->selectors) && null !== $parentKey) { unset($block->parent->children[$parentKey]); return; @@ -497,16 +524,20 @@ protected function glueFunctionSelectors($parts) $new = []; foreach ($parts as $part) { - if (is_array($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 + if ( + \count($new) && \is_string($new[\count($new) - 1]) && + \strlen($part) && substr($part, -1) === ')' && strpos($part, '(') === false ) { - $new[count($new) - 1] .= $part; + while (\count($new) > 1 && substr($new[\count($new) - 1], -1) !== '(') { + $part = array_pop($new) . $part; + } + $new[\count($new) - 1] .= $part; } else { $new[] = $part; } @@ -527,9 +558,14 @@ protected function glueFunctionSelectors($parts) protected function matchExtends($selector, &$out, $from = 0, $initial = true) { static $partsPile = []; - $selector = $this->glueFunctionSelectors($selector); + if (\count($selector) == 1 && \in_array(reset($selector), $partsPile)) { + return; + } + + $outRecurs = []; + foreach ($selector as $i => $part) { if ($i < $from) { continue; @@ -537,39 +573,43 @@ protected function matchExtends($selector, &$out, $from = 0, $initial = true) // 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) { + if (\count($part) > 1) { foreach ($partsPile as $previousPart) { - if (! count(array_diff($previousPart, $part))) { + if (! \count(array_diff($previousPart, $part))) { continue 2; } } } - if ($this->matchExtendsSingle($part, $origin)) { - $partsPile[] = $part; - $after = array_slice($selector, $i + 1); - $before = array_slice($selector, 0, $i); + $partsPile[] = $part; + if ($this->matchExtendsSingle($part, $origin, $initial)) { + $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 (count($new) > 1) { + if (\count($new) > 1) { while ($k < $i && isset($new[$k]) && $selector[$k] === $new[$k]) { $k++; } } + if (\count($nonBreakableBefore) && $k === \count($new)) { + $k--; + } + $replacement = []; - $tempReplacement = $k > 0 ? array_slice($new, $k) : $new; + $tempReplacement = $k > 0 ? \array_slice($new, $k) : $new; - for ($l = count($tempReplacement) - 1; $l >= 0; $l--) { + for ($l = \count($tempReplacement) - 1; $l >= 0; $l--) { $slice = []; foreach ($tempReplacement[$l] as $chunk) { - if (! in_array($chunk, $slice)) { + if (! \in_array($chunk, $slice)) { $slice[] = $chunk; } } @@ -581,7 +621,7 @@ protected function matchExtends($selector, &$out, $from = 0, $initial = true) } } - $afterBefore = $l != 0 ? array_slice($tempReplacement, 0, $l) : []; + $afterBefore = $l != 0 ? \array_slice($tempReplacement, 0, $l) : []; // Merge shared direct relationships. $mergedBefore = $this->mergeDirectRelationships($afterBefore, $nonBreakableBefore); @@ -597,64 +637,137 @@ protected function matchExtends($selector, &$out, $from = 0, $initial = true) continue; } - $out[] = $result; + $this->pushOrMergeExtentedSelector($out, $result); // recursively check for more matches - $startRecurseFrom = count($before) + min(count($nonBreakableBefore), count($mergedBefore)); - $this->matchExtends($result, $out, $startRecurseFrom, false); + $startRecurseFrom = \count($before) + min(\count($nonBreakableBefore), \count($mergedBefore)); + + if (\count($origin) > 1) { + $this->matchExtends($result, $out, $startRecurseFrom, false); + } else { + $this->matchExtends($result, $outRecurs, $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; + 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); + list($betweenSharedParts, $nonBreakabl2) = $this->extractRelationshipFromFragment($afterBefore); $result2 = array_merge( $preSharedParts, $betweenSharedParts, $postSharedParts, - $nonBreakable2, + $nonBreakabl2, $nonBreakableBefore, $replacement, $after ); - $out[] = $result2; + $this->pushOrMergeExtentedSelector($out, $result2); } } + } + array_pop($partsPile); + } + + while (\count($outRecurs)) { + $result = array_shift($outRecurs); + $this->pushOrMergeExtentedSelector($out, $result); + } + } + + /** + * Test a part for being a pseudo selector + * + * @param string $part + * @param array $matches + * + * @return boolean + */ + protected function isPseudoSelector($part, &$matches) + { + if ( + strpos($part, ':') === 0 && + preg_match(",^::?([\w-]+)\((.+)\)$,", $part, $matches) + ) { + return true; + } - array_pop($partsPile); + return false; + } + + /** + * Push extended selector except if + * - this is a pseudo selector + * - same as previous + * - in a white list + * in this case we merge the pseudo selector content + * + * @param array $out + * @param array $extended + */ + protected function pushOrMergeExtentedSelector(&$out, $extended) + { + if (\count($out) && \count($extended) === 1 && \count(reset($extended)) === 1) { + $single = reset($extended); + $part = reset($single); + + if ( + $this->isPseudoSelector($part, $matchesExtended) && + \in_array($matchesExtended[1], [ 'slotted' ]) + ) { + $prev = end($out); + $prev = $this->glueFunctionSelectors($prev); + + if (\count($prev) === 1 && \count(reset($prev)) === 1) { + $single = reset($prev); + $part = reset($single); + + if ( + $this->isPseudoSelector($part, $matchesPrev) && + $matchesPrev[1] === $matchesExtended[1] + ) { + $extended = explode($matchesExtended[1] . '(', $matchesExtended[0], 2); + $extended[1] = $matchesPrev[2] . ', ' . $extended[1]; + $extended = implode($matchesExtended[1] . '(', $extended); + $extended = [ [ $extended ]]; + array_pop($out); + } + } } } + $out[] = $extended; } /** * Match extends single * - * @param array $rawSingle - * @param array $outOrigin + * @param array $rawSingle + * @param array $outOrigin + * @param boolean $initial * * @return boolean */ - protected function matchExtendsSingle($rawSingle, &$outOrigin) + protected function matchExtendsSingle($rawSingle, &$outOrigin, $initial = true) { $counts = []; $single = []; // simple usual cases, no need to do the whole trick - if (in_array($rawSingle, [['>'],['+'],['~']])) { + if (\in_array($rawSingle, [['>'],['+'],['~']])) { return false; } foreach ($rawSingle as $part) { // matches Number - if (! is_string($part)) { + if (! \is_string($part)) { return false; } - if (! preg_match('/^[\[.:#%]/', $part) && count($single)) { - $single[count($single) - 1] .= $part; + if (! preg_match('/^[\[.:#%]/', $part) && \count($single)) { + $single[\count($single) - 1] .= $part; } else { $single[] = $part; } @@ -662,21 +775,52 @@ protected function matchExtendsSingle($rawSingle, &$outOrigin) $extendingDecoratedTag = false; - if (count($single) > 1) { + if (\count($single) > 1) { $matches = null; $extendingDecoratedTag = preg_match('/^[a-z0-9]+$/i', $single[0], $matches) ? $matches[0] : false; } - foreach ($single as $part) { + $outOrigin = []; + $found = false; + + foreach ($single as $k => $part) { if (isset($this->extendsMap[$part])) { foreach ($this->extendsMap[$part] as $idx) { $counts[$idx] = isset($counts[$idx]) ? $counts[$idx] + 1 : 1; } } - } - $outOrigin = []; - $found = false; + if ( + $initial && + $this->isPseudoSelector($part, $matches) && + ! \in_array($matches[1], [ 'not' ]) + ) { + $buffer = $matches[2]; + $parser = $this->parserFactory(__METHOD__); + + if ($parser->parseSelector($buffer, $subSelectors)) { + foreach ($subSelectors as $ksub => $subSelector) { + $subExtended = []; + $this->matchExtends($subSelector, $subExtended, 0, false); + + if ($subExtended) { + $subSelectorsExtended = $subSelectors; + $subSelectorsExtended[$ksub] = $subExtended; + + foreach ($subSelectorsExtended as $ksse => $sse) { + $subSelectorsExtended[$ksse] = $this->collapseSelectors($sse); + } + + $subSelectorsExtended = implode(', ', $subSelectorsExtended); + $singleExtended = $single; + $singleExtended[$k] = str_replace('(' . $buffer . ')', "($subSelectorsExtended)", $part); + $outOrigin[] = [ $singleExtended ]; + $found = true; + } + } + } + } + } foreach ($counts as $idx => $count) { list($target, $origin, /* $block */) = $this->extends[$idx]; @@ -684,7 +828,7 @@ protected function matchExtendsSingle($rawSingle, &$outOrigin) $origin = $this->glueFunctionSelectors($origin); // check count - if ($count !== count($target)) { + if ($count !== \count($target)) { continue; } @@ -694,14 +838,15 @@ protected function matchExtendsSingle($rawSingle, &$outOrigin) foreach ($origin as $j => $new) { // prevent infinite loop when target extends itself - if ($this->isSelfExtend($single, $origin)) { + if ($this->isSelfExtend($single, $origin) && ! $initial) { return false; } $replacement = end($new); // Extending a decorated tag with another tag is not possible. - if ($extendingDecoratedTag && $replacement[0] != $extendingDecoratedTag && + if ( + $extendingDecoratedTag && $replacement[0] != $extendingDecoratedTag && preg_match('/^[a-z0-9]+$/i', $replacement[0]) ) { unset($origin[$j]); @@ -710,8 +855,8 @@ protected function matchExtendsSingle($rawSingle, &$outOrigin) $combined = $this->combineSelectorSingle($replacement, $rem); - if (count(array_diff($combined, $origin[$j][count($origin[$j]) - 1]))) { - $origin[$j][count($origin[$j]) - 1] = $combined; + if (\count(array_diff($combined, $origin[$j][\count($origin[$j]) - 1]))) { + $origin[$j][\count($origin[$j]) - 1] = $combined; } } @@ -739,12 +884,13 @@ protected function extractRelationshipFromFragment(array $fragment) { $parents = []; $children = []; - $j = $i = count($fragment); + + $j = $i = \count($fragment); for (;;) { - $children = $j != $i ? array_slice($fragment, $j, $i - $j) : []; - $parents = array_slice($fragment, 0, $j); - $slice = end($parents); + $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; @@ -766,37 +912,52 @@ protected function extractRelationshipFromFragment(array $fragment) */ protected function combineSelectorSingle($base, $other) { - $tag = []; - $out = []; - $wasTag = true; + $tag = []; + $out = []; + $wasTag = false; + $pseudo = []; + + while (\count($other) && strpos(end($other), ':') === 0) { + array_unshift($pseudo, array_pop($other)); + } + + foreach ([array_reverse($base), array_reverse($other)] as $single) { + $rang = count($single); - foreach ([$base, $other] as $single) { foreach ($single as $part) { - if (preg_match('/^[\[.:#]/', $part)) { + if (preg_match('/^[\[:]/', $part)) { $out[] = $part; $wasTag = false; - } elseif (preg_match('/^[^_-]/', $part)) { + } elseif (preg_match('/^[\.#]/', $part)) { + array_unshift($out, $part); + $wasTag = false; + } elseif (preg_match('/^[^_-]/', $part) && $rang === 1) { $tag[] = $part; $wasTag = true; } elseif ($wasTag) { - $tag[count($tag) - 1] .= $part; + $tag[\count($tag) - 1] .= $part; } else { - $out[count($out) - 1] .= $part; + array_unshift($out, $part); } + $rang--; } } - if (count($tag)) { + if (\count($tag)) { array_unshift($out, $tag[0]); } + while (\count($pseudo)) { + $out[] = array_shift($pseudo); + } + return $out; } /** * Compile media * - * @param \Leafo\ScssPhp\Block $media + * @param \ScssPhp\ScssPhp\Block $media */ protected function compileMedia(Block $media) { @@ -821,7 +982,8 @@ protected function compileMedia(Block $media) foreach ($media->children as $child) { $type = $child[0]; - if ($type !== Type::T_BLOCK && + if ( + $type !== Type::T_BLOCK && $type !== Type::T_MEDIA && $type !== Type::T_DIRECTIVE && $type !== Type::T_IMPORT @@ -832,17 +994,18 @@ protected function compileMedia(Block $media) } if ($needsWrap) { - $wrapped = new Block; - $wrapped->sourceName = $media->sourceName; - $wrapped->sourceIndex = $media->sourceIndex; - $wrapped->sourceLine = $media->sourceLine; + $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; + $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; @@ -879,9 +1042,9 @@ protected function compileMedia(Block $media) /** * Media parent * - * @param \Leafo\ScssPhp\Formatter\OutputBlock $scope + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $scope * - * @return \Leafo\ScssPhp\Formatter\OutputBlock + * @return \ScssPhp\ScssPhp\Formatter\OutputBlock */ protected function mediaParent(OutputBlock $scope) { @@ -899,37 +1062,75 @@ protected function mediaParent(OutputBlock $scope) /** * Compile directive * - * @param \Leafo\ScssPhp\Block $block + * @param \ScssPhp\ScssPhp\Block|array $block + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $out */ - protected function compileDirective(Block $block) + protected function compileDirective($directive, OutputBlock $out) { - $s = '@' . $block->name; + if (\is_array($directive)) { + $directiveName = $this->compileDirectiveName($directive[0]); + $s = '@' . $directiveName; - if (! empty($block->value)) { - $s .= ' ' . $this->compileValue($block->value); - } + if (! empty($directive[1])) { + $s .= ' ' . $this->compileValue($directive[1]); + } + // sass-spec compliance on newline after directives, a bit tricky :/ + $appendNewLine = (! empty($directive[2]) || strpos($s, "\n")) ? "\n" : ""; + if (\is_array($directive[0]) && empty($directive[1])) { + $appendNewLine = "\n"; + } - if ($block->name === 'keyframes' || substr($block->name, -10) === '-keyframes') { - $this->compileKeyframeBlock($block, [$s]); + if (empty($directive[3])) { + $this->appendRootDirective($s . ';' . $appendNewLine, $out, [Type::T_COMMENT, Type::T_DIRECTIVE]); + } else { + $this->appendOutputLine($out, Type::T_DIRECTIVE, $s . ';'); + } } else { - $this->compileNestedBlock($block, [$s]); + $directive->name = $this->compileDirectiveName($directive->name); + $s = '@' . $directive->name; + + if (! empty($directive->value)) { + $s .= ' ' . $this->compileValue($directive->value); + } + + if ($directive->name === 'keyframes' || substr($directive->name, -10) === '-keyframes') { + $this->compileKeyframeBlock($directive, [$s]); + } else { + $this->compileNestedBlock($directive, [$s]); + } + } + } + + /** + * directive names can include some interpolation + * + * @param string|array $directiveName + * @return array|string + * @throws CompilerException + */ + protected function compileDirectiveName($directiveName) + { + if (is_string($directiveName)) { + return $directiveName; } + + return $this->compileValue($directiveName); } /** * Compile at-root * - * @param \Leafo\ScssPhp\Block $block + * @param \ScssPhp\ScssPhp\Block $block */ protected function compileAtRoot(Block $block) { $env = $this->pushEnv($block); $envs = $this->compactEnv($env); - $without = isset($block->with) ? $this->compileWith($block->with) : static::WITH_RULE; + list($with, $without) = $this->compileWith(isset($block->with) ? $block->with : null); // wrap inline selector if ($block->selector) { - $wrapped = new Block; + $wrapped = new Block(); $wrapped->sourceName = $block->sourceName; $wrapped->sourceIndex = $block->sourceIndex; $wrapped->sourceLine = $block->sourceLine; @@ -946,16 +1147,18 @@ protected function compileAtRoot(Block $block) $selfParent = $block->selfParent; - if (! $block->selfParent->selectors && isset($block->parent) && $block->parent && + 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); + $this->env = $this->filterWithWithout($envs, $with, $without); $saveScope = $this->scope; - $this->scope = $this->filterScopeWithout($saveScope, $without); + $this->scope = $this->filterScopeWithWithout($saveScope, $with, $without); // propagate selfParent to the children where they still can be useful $this->compileChildrenNoReturn($block->children, $this->scope, $selfParent); @@ -970,14 +1173,16 @@ protected function compileAtRoot(Block $block) /** * Filter at-root scope depending of with/without option * - * @param \Leafo\ScssPhp\Formatter\OutputBlock $scope - * @param mixed $without + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $scope + * @param array $with + * @param array $without * * @return mixed */ - protected function filterScopeWithout($scope, $without) + protected function filterScopeWithWithout($scope, $with, $without) { $filteredScopes = []; + $childStash = []; if ($scope->type === TYPE::T_ROOT) { return $scope; @@ -985,6 +1190,7 @@ protected function filterScopeWithout($scope, $without) // start from the root while ($scope->parent && $scope->parent->type !== TYPE::T_ROOT) { + array_unshift($childStash, $scope); $scope = $scope->parent; } @@ -993,11 +1199,11 @@ protected function filterScopeWithout($scope, $without) break; } - if (! $this->isWithout($without, $scope)) { + if ($this->isWith($scope, $with, $without)) { $s = clone $scope; $s->children = []; - $s->lines = []; - $s->parent = null; + $s->lines = []; + $s->parent = null; if ($s->type !== Type::T_MEDIA && $s->type !== Type::T_DIRECTIVE) { $s->selectors = []; @@ -1006,14 +1212,16 @@ protected function filterScopeWithout($scope, $without) $filteredScopes[] = $s; } - if ($scope->children) { + if (\count($childStash)) { + $scope = array_shift($childStash); + } elseif ($scope->children) { $scope = end($scope->children); } else { $scope = null; } } - if (! count($filteredScopes)) { + if (! \count($filteredScopes)) { return $this->rootBlock; } @@ -1024,11 +1232,12 @@ protected function filterScopeWithout($scope, $without) $p = &$newScope; - while (count($filteredScopes)) { + while (\count($filteredScopes)) { $s = array_shift($filteredScopes); $s->parent = $p; - $p->children[] = &$s; - $p = $s; + $p->children[] = $s; + $newScope = &$p->children[0]; + $p = &$p->children[0]; } return $newScope; @@ -1038,14 +1247,14 @@ protected function filterScopeWithout($scope, $without) * 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 \Leafo\ScssPhp\Formatter\OutputBlock $scope - * @param \Leafo\ScssPhp\Formatter\OutputBlock $previousScope + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $scope + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $previousScope * * @return mixed */ protected function completeScope($scope, $previousScope) { - if (! $scope->type && (! $scope->selectors || ! count($scope->selectors)) && count($scope->lines)) { + if (! $scope->type && (! $scope->selectors || ! \count($scope->selectors)) && \count($scope->lines)) { $scope->selectors = $this->findScopeSelectors($previousScope, $scope->depth); } @@ -1061,8 +1270,8 @@ protected function completeScope($scope, $previousScope) /** * Find a selector by the depth node in the scope * - * @param \Leafo\ScssPhp\Formatter\OutputBlock $scope - * @param integer $depth + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $scope + * @param integer $depth * * @return array */ @@ -1084,72 +1293,75 @@ protected function findScopeSelectors($scope, $depth) } /** - * Compile @at-root's with: inclusion / without: exclusion into filter flags + * Compile @at-root's with: inclusion / without: exclusion into 2 lists uses to filter scope/env later * - * @param array $with + * @param array $withCondition * - * @return integer + * @return array */ - protected function compileWith($with) + protected function compileWith($withCondition) { - static $mapping = [ - 'rule' => self::WITH_RULE, - 'media' => self::WITH_MEDIA, - 'supports' => self::WITH_SUPPORTS, - 'all' => self::WITH_ALL, - ]; + // just compile what we have in 2 lists + $with = []; + $without = ['rule' => true]; + + if ($withCondition) { + if ($withCondition[0] === Type::T_INTERPOLATE) { + $w = $this->compileValue($withCondition); - // exclude selectors by default - $without = static::WITH_RULE; + $buffer = "($w)"; + $parser = $this->parserFactory(__METHOD__); - if ($this->libMapHasKey([$with, static::$with])) { - $without = static::WITH_ALL; + if ($parser->parseValue($buffer, $reParsedWith)) { + $withCondition = $reParsedWith; + } + } - $list = $this->coerceList($this->libMapGet([$with, static::$with])); + if ($this->libMapHasKey([$withCondition, static::$with])) { + $without = []; // cancel the default + $list = $this->coerceList($this->libMapGet([$withCondition, static::$with])); - foreach ($list[2] as $item) { - $keyword = $this->compileStringContent($this->coerceString($item)); + foreach ($list[2] as $item) { + $keyword = $this->compileStringContent($this->coerceString($item)); - if (array_key_exists($keyword, $mapping)) { - $without &= ~($mapping[$keyword]); + $with[$keyword] = true; } } - } - if ($this->libMapHasKey([$with, static::$without])) { - $without = 0; + if ($this->libMapHasKey([$withCondition, static::$without])) { + $without = []; // cancel the default + $list = $this->coerceList($this->libMapGet([$withCondition, static::$without])); - $list = $this->coerceList($this->libMapGet([$with, static::$without])); - - foreach ($list[2] as $item) { - $keyword = $this->compileStringContent($this->coerceString($item)); + foreach ($list[2] as $item) { + $keyword = $this->compileStringContent($this->coerceString($item)); - if (array_key_exists($keyword, $mapping)) { - $without |= $mapping[$keyword]; + $without[$keyword] = true; } } } - return $without; + return [$with, $without]; } /** * Filter env stack * - * @param array $envs - * @param integer $without + * @param array $envs + * @param array $with + * @param array $without * - * @return \Leafo\ScssPhp\Compiler\Environment + * @return \ScssPhp\ScssPhp\Compiler\Environment */ - protected function filterWithout($envs, $without) + protected function filterWithWithout($envs, $with, $without) { $filtered = []; foreach ($envs as $e) { - if ($e->block && $this->isWithout($without, $e->block)) { + if ($e->block && ! $this->isWith($e->block, $with, $without)) { $ec = clone $e; - $ec->block = null; + $ec->block = null; $ec->selectors = []; + $filtered[] = $ec; } else { $filtered[] = $e; @@ -1162,41 +1374,75 @@ protected function filterWithout($envs, $without) /** * Filter WITH rules * - * @param integer $without - * @param \Leafo\ScssPhp\Block|\Leafo\ScssPhp\Formatter\OutputBlock $block + * @param \ScssPhp\ScssPhp\Block|\ScssPhp\ScssPhp\Formatter\OutputBlock $block + * @param array $with + * @param array $without * * @return boolean */ - protected function isWithout($without, $block) + protected function isWith($block, $with, $without) { if (isset($block->type)) { if ($block->type === Type::T_MEDIA) { - return ($without & static::WITH_MEDIA) ? true : false; + return $this->testWithWithout('media', $with, $without); } if ($block->type === Type::T_DIRECTIVE) { - if (isset($block->name) && $block->name === 'supports') { - return ($without & static::WITH_SUPPORTS) ? true : false; + if (isset($block->name)) { + return $this->testWithWithout($this->compileDirectiveName($block->name), $with, $without); + } elseif (isset($block->selectors) && preg_match(',@(\w+),ims', json_encode($block->selectors), $m)) { + return $this->testWithWithout($m[1], $with, $without); + } else { + return $this->testWithWithout('???', $with, $without); + } + } + } elseif (isset($block->selectors)) { + // a selector starting with number is a keyframe rule + if (\count($block->selectors)) { + $s = reset($block->selectors); + + while (\is_array($s)) { + $s = reset($s); } - if (isset($block->selectors) && strpos(serialize($block->selectors), '@supports') !== false) { - return ($without & static::WITH_SUPPORTS) ? true : false; + if (\is_object($s) && $s instanceof Node\Number) { + return $this->testWithWithout('keyframes', $with, $without); } } + + return $this->testWithWithout('rule', $with, $without); } - if ((($without & static::WITH_RULE) && isset($block->selectors))) { - return true; + return true; + } + + /** + * Test a single type of block against with/without lists + * + * @param string $what + * @param array $with + * @param array $without + * + * @return boolean + * true if the block should be kept, false to reject + */ + protected function testWithWithout($what, $with, $without) + { + // if without, reject only if in the list (or 'all' is in the list) + if (\count($without)) { + return (isset($without[$what]) || isset($without['all'])) ? false : true; } - return false; + // otherwise reject all what is not in the with list + return (isset($with[$what]) || isset($with['all'])) ? true : false; } + /** * Compile keyframe block * - * @param \Leafo\ScssPhp\Block $block - * @param array $selectors + * @param \ScssPhp\ScssPhp\Block $block + * @param array $selectors */ protected function compileKeyframeBlock(Block $block, $selectors) { @@ -1220,11 +1466,45 @@ protected function compileKeyframeBlock(Block $block, $selectors) $this->popEnv(); } + /** + * Compile nested properties lines + * + * @param \ScssPhp\ScssPhp\Block $block + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $out + */ + protected function compileNestedPropertiesBlock(Block $block, OutputBlock $out) + { + $prefix = $this->compileValue($block->prefix) . '-'; + + $nested = $this->makeOutputBlock($block->type); + $nested->parent = $out; + + if ($block->hasValue) { + $nested->depth = $out->depth + 1; + } + + $out->children[] = $nested; + + foreach ($block->children as $child) { + 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; + } + + $this->compileChild($child, $nested); + } + } + /** * Compile nested block * - * @param \Leafo\ScssPhp\Block $block - * @param array $selectors + * @param \ScssPhp\ScssPhp\Block $block + * @param array $selectors */ protected function compileNestedBlock(Block $block, $selectors) { @@ -1235,7 +1515,7 @@ protected function compileNestedBlock(Block $block, $selectors) // wrap assign children in a block // except for @font-face - if ($block->type !== Type::T_DIRECTIVE || $block->name !== "font-face") { + if ($block->type !== Type::T_DIRECTIVE || $this->compileDirectiveName($block->name) !== 'font-face') { // need wrapping? $needWrapping = false; @@ -1247,16 +1527,16 @@ protected function compileNestedBlock(Block $block, $selectors) } if ($needWrapping) { - $wrapped = new Block; - $wrapped->sourceName = $block->sourceName; - $wrapped->sourceIndex = $block->sourceIndex; - $wrapped->sourceLine = $block->sourceLine; + $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; + $wrapped->selectors = []; + $wrapped->comments = []; + $wrapped->parent = $block; + $wrapped->children = $block->children; + $wrapped->selfParent = $block->selfParent; $block->children = [[Type::T_BLOCK, $wrapped]]; } @@ -1285,7 +1565,7 @@ protected function compileNestedBlock(Block $block, $selectors) * * @see Compiler::compileChild() * - * @param \Leafo\ScssPhp\Block $block + * @param \ScssPhp\ScssPhp\Block $block */ protected function compileBlock(Block $block) { @@ -1294,7 +1574,7 @@ protected function compileBlock(Block $block) $out = $this->makeOutputBlock(null); - if (isset($this->lineNumberStyle) && count($env->selectors) && count($block->children)) { + if (isset($this->lineNumberStyle) && \count($env->selectors) && \count($block->children)) { $annotation = $this->makeOutputBlock(Type::T_COMMENT); $annotation->depth = 0; @@ -1320,7 +1600,7 @@ protected function compileBlock(Block $block) $this->scope->children[] = $out; - if (count($block->children)) { + if (\count($block->children)) { $out->selectors = $this->multiplySelectors($env, $block->selfParent); // propagate selfParent to the children where they still can be useful @@ -1333,17 +1613,52 @@ protected function compileBlock(Block $block) $this->compileChildrenNoReturn($block->children, $out, $block->selfParent); - // and revert for the following childs of the same block + // and revert for the following children of the same block if ($selfParentSelectors) { $block->selfParent->selectors = $selfParentSelectors; } } - $this->formatter->stripSemicolon($out->lines); - $this->popEnv(); } + + /** + * Compile the value of a comment that can have interpolation + * + * @param array $value + * @param boolean $pushEnv + * + * @return array|mixed|string + */ + protected function compileCommentValue($value, $pushEnv = false) + { + $c = $value[1]; + + if (isset($value[2])) { + if ($pushEnv) { + $this->pushEnv(); + } + + $ignoreCallStackMessage = $this->ignoreCallStackMessage; + $this->ignoreCallStackMessage = true; + + try { + $c = $this->compileValue($value[2]); + } catch (\Exception $e) { + // ignore error in comment compilation which are only interpolation + } + + $this->ignoreCallStackMessage = $ignoreCallStackMessage; + + if ($pushEnv) { + $this->popEnv(); + } + } + + return $c; + } + /** * Compile root level comment * @@ -1352,7 +1667,7 @@ protected function compileBlock(Block $block) protected function compileComment($block) { $out = $this->makeOutputBlock(Type::T_COMMENT); - $out->lines[] = is_string($block[1]) ? $block[1] : $this->compileValue($block[1]); + $out->lines[] = $this->compileCommentValue($block, true); $this->scope->children[] = $out; } @@ -1372,9 +1687,9 @@ protected function evalSelectors($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__); + $selectors = $this->replaceSelfSelector($selectors, '&'); + $buffer = $this->collapseSelectors($selectors); + $parser = $this->parserFactory(__METHOD__); if ($parser->parseSelector($buffer, $newSelectors)) { $selectors = array_map([$this, 'evalSelector'], $newSelectors); @@ -1406,14 +1721,15 @@ protected function evalSelector($selector) protected function evalSelectorPart($part) { foreach ($part as &$p) { - if (is_array($p) && ($p[0] === Type::T_INTERPOLATE || $p[0] === Type::T_STRING)) { + if (\is_array($p) && ($p[0] === Type::T_INTERPOLATE || $p[0] === Type::T_STRING)) { $p = $this->compileValue($p); // force re-evaluation if (strpos($p, '&') !== false || strpos($p, ',') !== false) { $this->shouldEvaluate = true; } - } elseif (is_string($p) && strlen($p) >= 2 && + } elseif ( + \is_string($p) && \strlen($p) >= 2 && ($first = $p[0]) && ($first === '"' || $first === "'") && substr($p, -1) === $first ) { @@ -1453,14 +1769,15 @@ function ($value, $key) use (&$compound) { ); if ($selectorFormat && $this->isImmediateRelationshipCombinator($compound)) { - if (count($output)) { - $output[count($output) - 1] .= ' ' . $compound; + if (\count($output)) { + $output[\count($output) - 1] .= ' ' . $compound; } else { $output[] = $compound; } + $glueNext = true; } elseif ($glueNext) { - $output[count($output) - 1] .= ' ' . $compound; + $output[\count($output) - 1] .= ' ' . $compound; $glueNext = false; } else { $output[] = $compound; @@ -1471,6 +1788,7 @@ function ($value, $key) use (&$compound) { foreach ($output as &$o) { $o = [Type::T_STRING, '', [$o]]; } + $output = [Type::T_LIST, ' ', $output]; } else { $output = implode(' ', $output); @@ -1495,14 +1813,18 @@ function ($value, $key) use (&$compound) { * * @return array */ - protected function revertSelfSelector($selectors) + protected function replaceSelfSelector($selectors, $replace = null) { foreach ($selectors as &$part) { - if (is_array($part)) { + if (\is_array($part)) { if ($part === [Type::T_SELF]) { - $part = '&'; + if (\is_null($replace)) { + $replace = $this->reduce([Type::T_SELF]); + $replace = $this->compileValue($replace); + } + $part = $replace; } else { - $part = $this->revertSelfSelector($part); + $part = $this->replaceSelfSelector($part, $replace); } } } @@ -1522,18 +1844,19 @@ protected function flattenSelectorSingle($single) $joined = []; foreach ($single as $part) { - if (empty($joined) || - ! is_string($part) || + if ( + empty($joined) || + ! \is_string($part) || preg_match('/[\[.:#%]/', $part) ) { $joined[] = $part; continue; } - if (is_array(end($joined))) { + if (\is_array(end($joined))) { $joined[] = $part; } else { - $joined[count($joined) - 1] .= $part; + $joined[\count($joined) - 1] .= $part; } } @@ -1549,7 +1872,7 @@ protected function flattenSelectorSingle($single) */ protected function compileSelector($selector) { - if (! is_array($selector)) { + if (! \is_array($selector)) { return $selector; // media and the like } @@ -1572,7 +1895,7 @@ protected function compileSelector($selector) protected function compileSelectorPart($piece) { foreach ($piece as &$p) { - if (! is_array($p)) { + if (! \is_array($p)) { continue; } @@ -1599,13 +1922,13 @@ protected function compileSelectorPart($piece) */ protected function hasSelectorPlaceholder($selector) { - if (! is_array($selector)) { + if (! \is_array($selector)) { return false; } foreach ($selector as $parts) { foreach ($parts as $part) { - if (strlen($part) && '%' === $part[0]) { + if (\strlen($part) && '%' === $part[0]) { return true; } } @@ -1624,11 +1947,12 @@ protected function pushCallStack($name = '') ]; // infinite calling loop - if (count($this->callStack) > 25000) { + 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); + $msg = 'Infinite calling loop'; + + throw $this->error($msg); } } @@ -1640,9 +1964,9 @@ protected function popCallStack() /** * Compile children and return result * - * @param array $stms - * @param \Leafo\ScssPhp\Formatter\OutputBlock $out - * @param string $traceName + * @param array $stms + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $out + * @param string $traceName * * @return array|null */ @@ -1654,6 +1978,8 @@ protected function compileChildren($stms, OutputBlock $out, $traceName = '') $ret = $this->compileChild($stm, $out); if (isset($ret)) { + $this->popCallStack(); + return $ret; } } @@ -1666,10 +1992,10 @@ protected function compileChildren($stms, OutputBlock $out, $traceName = '') /** * Compile children and throw exception if unexpected @return * - * @param array $stms - * @param \Leafo\ScssPhp\Formatter\OutputBlock $out - * @param \Leafo\ScssPhp\Block $selfParent - * @param string $traceName + * @param array $stms + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $out + * @param \ScssPhp\ScssPhp\Block $selfParent + * @param string $traceName * * @throws \Exception */ @@ -1678,11 +2004,11 @@ protected function compileChildrenNoReturn($stms, OutputBlock $out, $selfParent $this->pushCallStack($traceName); foreach ($stms as $stm) { - if ($selfParent && isset($stm[1]) && is_object($stm[1]) && $stm[1] instanceof Block) { + 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) { + } elseif ($selfParent && \in_array($stm[0], [TYPE::T_INCLUDE, TYPE::T_EXTEND])) { $stm['selfParent'] = $selfParent; $ret = $this->compileChild($stm, $out); unset($stm['selfParent']); @@ -1691,9 +2017,7 @@ protected function compileChildrenNoReturn($stms, OutputBlock $out, $selfParent } if (isset($ret)) { - $this->throwError('@return may only be used within a function'); - - return; + throw $this->error('@return may only be used within a function'); } } @@ -1710,52 +2034,61 @@ protected function compileChildrenNoReturn($stms, OutputBlock $out, $selfParent */ protected function evaluateMediaQuery($queryList) { + static $parser = null; + + $outQueryList = []; + foreach ($queryList as $kql => $query) { + $shouldReparse = false; + foreach ($query as $kq => $q) { - for ($i = 1; $i < count($q); $i++) { + 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 && + // so you need to reparse if the T_MEDIA_TYPE looks like anything else a media type + if ( + $q[0] == Type::T_MEDIA_TYPE && (strpos($value, '(') !== false || strpos($value, ')') !== false || - strpos($value, ':') !== false) + strpos($value, ':') !== false || + strpos($value, ',') !== false) ) { - $queryList[$kql][$kq][0] = Type::T_MEDIA_EXPRESSION; + $shouldReparse = true; + } + + $queryList[$kql][$kq][$i] = [Type::T_KEYWORD, $value]; + } + } - if (strpos($value, 'and') !== false) { - $values = explode('and', $value); - $value = trim(array_pop($values)); + if ($shouldReparse) { + if (\is_null($parser)) { + $parser = $this->parserFactory(__METHOD__); + } - while ($v = trim(array_pop($values))) { - $type = Type::T_MEDIA_EXPRESSION; + $queryString = $this->compileMediaQuery([$queryList[$kql]]); + $queryString = reset($queryString); - if (strpos($v, '(') === false && - strpos($v, ')') === false && - strpos($v, ':') === false - ) { - $type = Type::T_MEDIA_TYPE; - } + if (strpos($queryString, '@media ') === 0) { + $queryString = substr($queryString, 7); + $queries = []; - if (substr($v, 0, 1) === '(' && substr($v, -1) === ')') { - $v = substr($v, 1, -1); - } + if ($parser->parseMediaQueryList($queryString, $queries)) { + $queries = $this->evaluateMediaQuery($queries[2]); - $queryList[$kql][] = [$type,[Type::T_KEYWORD, $v]]; - } + while (\count($queries)) { + $outQueryList[] = array_shift($queries); } - if (substr($value, 0, 1) === '(' && substr($value, -1) === ')') { - $value = substr($value, 1, -1); - } + continue; } - - $queryList[$kql][$kq][$i] = [Type::T_KEYWORD, $value]; } } + + $outQueryList[] = $queryList[$kql]; } - return $queryList; + return $outQueryList; } /** @@ -1767,10 +2100,10 @@ protected function evaluateMediaQuery($queryList) */ protected function compileMediaQuery($queryList) { - $start = '@media '; + $start = '@media '; $default = trim($start); - $out = []; - $current = ""; + $out = []; + $current = ''; foreach ($queryList as $query) { $type = null; @@ -1788,16 +2121,17 @@ protected function compileMediaQuery($queryList) foreach ($query as $q) { switch ($q[0]) { case Type::T_MEDIA_TYPE: - $newType = array_map([$this, 'compileValue'], array_slice($q, 1)); + $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 (\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)) { + if (\strlen($current)) { $current .= $this->formatter->tagSeparator; } @@ -1808,9 +2142,9 @@ protected function compileMediaQuery($queryList) $out[] = $start . $current; } - $current = ""; - $type = null; - $parts = []; + $current = ''; + $type = null; + $parts = []; } } @@ -1860,7 +2194,7 @@ protected function compileMediaQuery($queryList) } if (! empty($parts)) { - if (strlen($current)) { + if (\strlen($current)) { $current .= $this->formatter->tagSeparator; } @@ -1942,23 +2276,19 @@ protected function mergeMediaTypes($type1, $type2) return $type1; } - $m1 = ''; - $t1 = ''; - - if (count($type1) > 1) { - $m1= strtolower($type1[0]); - $t1= strtolower($type1[1]); + if (\count($type1) > 1) { + $m1 = strtolower($type1[0]); + $t1 = strtolower($type1[1]); } else { + $m1 = ''; $t1 = strtolower($type1[0]); } - $m2 = ''; - $t2 = ''; - - if (count($type2) > 1) { + if (\count($type2) > 1) { $m2 = strtolower($type2[0]); $t2 = strtolower($type2[1]); } else { + $m2 = ''; $t2 = strtolower($type2[0]); } @@ -1987,15 +2317,15 @@ protected function mergeMediaTypes($type1, $type2) } // t1 == t2, neither m1 nor m2 are "not" - return [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 \Leafo\ScssPhp\Formatter\OutputBlock $out - * @param boolean $once + * @param array $rawPath + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $out + * @param boolean $once * * @return boolean */ @@ -2004,8 +2334,8 @@ protected function compileImport($rawPath, OutputBlock $out, $once = false) if ($rawPath[0] === Type::T_STRING) { $path = $this->compileStringContent($rawPath); - if ($path = $this->findImport($path)) { - if (! $once || ! in_array($path, $this->importedFiles)) { + if (strpos($path, 'url(') !== 0 && $path = $this->findImport($path)) { + if (! $once || ! \in_array($path, $this->importedFiles)) { $this->importFile($path, $out); $this->importedFiles[] = $path; } @@ -2013,106 +2343,263 @@ protected function compileImport($rawPath, OutputBlock $out, $once = false) return true; } + $this->appendRootDirective('@import ' . $this->compileImportPath($rawPath) . ';', $out); + return false; } if ($rawPath[0] === Type::T_LIST) { // handle a list of strings - if (count($rawPath[2]) === 0) { + if (\count($rawPath[2]) === 0) { return false; } foreach ($rawPath[2] as $path) { if ($path[0] !== Type::T_STRING) { + $this->appendRootDirective('@import ' . $this->compileImportPath($rawPath) . ';', $out); + return false; } } foreach ($rawPath[2] as $path) { - $this->compileImport($path, $out); + $this->compileImport($path, $out, $once); } return true; } + $this->appendRootDirective('@import ' . $this->compileImportPath($rawPath) . ';', $out); + return false; } /** - * Compile child; returns a value to halt execution - * - * @param array $child - * @param \Leafo\ScssPhp\Formatter\OutputBlock $out - * - * @return array + * @param $rawPath + * @return string + * @throws CompilerException */ - protected function compileChild($child, OutputBlock $out) + protected function compileImportPath($rawPath) { - 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); + $path = $this->compileValue($rawPath); - if ($this->sourceIndex === false) { - $this->sourceIndex = null; - } + // case url() without quotes : supress \r \n remaining in the path + // if this is a real string there can not be CR or LF char + if (strpos($path, 'url(') === 0) { + $path = str_replace(array("\r", "\n"), array('', ' '), $path); + } else { + // if this is a file name in a string, spaces shoudl be escaped + $path = $this->reduce($rawPath); + $path = $this->escapeImportPathString($path); + $path = $this->compileValue($path); } - switch ($child[0]) { - case Type::T_SCSSPHP_IMPORT_ONCE: - $rawPath = $this->reduce($child[1]); + return $path; + } - if (! $this->compileImport($rawPath, $out, true)) { - $out->lines[] = '@import ' . $this->compileValue($rawPath) . ';'; + /** + * @param array $path + * @return array + * @throws CompilerException + */ + protected function escapeImportPathString($path) + { + switch ($path[0]) { + case Type::T_LIST: + foreach ($path[2] as $k => $v) { + $path[2][$k] = $this->escapeImportPathString($v); } break; - - case Type::T_IMPORT: - $rawPath = $this->reduce($child[1]); - - if (! $this->compileImport($rawPath, $out)) { - $out->lines[] = '@import ' . $this->compileValue($rawPath) . ';'; + case Type::T_STRING: + if ($path[1]) { + $path = $this->compileValue($path); + $path = str_replace(' ', '\\ ', $path); + $path = [Type::T_KEYWORD, $path]; } break; + } - case Type::T_DIRECTIVE: - $this->compileDirective($child[1]); - break; + return $path; + } - case Type::T_AT_ROOT: - $this->compileAtRoot($child[1]); - break; + /** + * Append a root directive like @import or @charset as near as the possible from the source code + * (keeping before comments, @import and @charset coming before in the source code) + * + * @param string $line + * @param @param \ScssPhp\ScssPhp\Formatter\OutputBlock $out + * @param array $allowed + */ + protected function appendRootDirective($line, $out, $allowed = [Type::T_COMMENT]) + { + $root = $out; - case Type::T_MEDIA: - $this->compileMedia($child[1]); - break; + while ($root->parent) { + $root = $root->parent; + } - case Type::T_BLOCK: - $this->compileBlock($child[1]); + $i = 0; + + while ($i < \count($root->children)) { + if (! isset($root->children[$i]->type) || ! \in_array($root->children[$i]->type, $allowed)) { + break; + } + + $i++; + } + + // remove incompatible children from the bottom of the list + $saveChildren = []; + + while ($i < \count($root->children)) { + $saveChildren[] = array_pop($root->children); + } + + // insert the directive as a comment + $child = $this->makeOutputBlock(Type::T_COMMENT); + $child->lines[] = $line; + $child->sourceName = $this->sourceNames[$this->sourceIndex]; + $child->sourceLine = $this->sourceLine; + $child->sourceColumn = $this->sourceColumn; + + $root->children[] = $child; + + // repush children + while (\count($saveChildren)) { + $root->children[] = array_pop($saveChildren); + } + } + + /** + * Append lines to the current output block: + * directly to the block or through a child if necessary + * + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $out + * @param string $type + * @param string|mixed $line + */ + protected function appendOutputLine(OutputBlock $out, $type, $line) + { + $outWrite = &$out; + + // check if it's a flat output or not + if (\count($out->children)) { + $lastChild = &$out->children[\count($out->children) - 1]; + + if ( + $lastChild->depth === $out->depth && + \is_null($lastChild->selectors) && + ! \count($lastChild->children) + ) { + $outWrite = $lastChild; + } else { + $nextLines = $this->makeOutputBlock($type); + $nextLines->parent = $out; + $nextLines->depth = $out->depth; + + $out->children[] = $nextLines; + $outWrite = &$nextLines; + } + } + + $outWrite->lines[] = $line; + } + + /** + * Compile child; returns a value to halt execution + * + * @param array $child + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $out + * + * @return array + */ + 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); + $this->sourceColumn = $out->sourceColumn; + + if ($this->sourceIndex === false) { + $this->sourceIndex = null; + } + } + + switch ($child[0]) { + case Type::T_SCSSPHP_IMPORT_ONCE: + $rawPath = $this->reduce($child[1]); + + $this->compileImport($rawPath, $out, true); + break; + + case Type::T_IMPORT: + $rawPath = $this->reduce($child[1]); + + $this->compileImport($rawPath, $out); + break; + + case Type::T_DIRECTIVE: + $this->compileDirective($child[1], $out); + break; + + case Type::T_AT_ROOT: + $this->compileAtRoot($child[1]); + break; + + case Type::T_MEDIA: + $this->compileMedia($child[1]); + break; + + case Type::T_BLOCK: + $this->compileBlock($child[1]); break; case Type::T_CHARSET: if (! $this->charsetSeen) { $this->charsetSeen = true; + $this->appendRootDirective('@charset ' . $this->compileValue($child[1]) . ';', $out); + } + break; + + case Type::T_CUSTOM_PROPERTY: + list(, $name, $value) = $child; + $compiledName = $this->compileValue($name); + + // if the value reduces to null from something else then + // the property should be discarded + if ($value[0] !== Type::T_NULL) { + $value = $this->reduce($value); - $out->lines[] = '@charset ' . $this->compileValue($child[1]) . ';'; + if ($value[0] === Type::T_NULL || $value === static::$nullString) { + break; + } } + + $compiledValue = $this->compileValue($value); + + $line = $this->formatter->customProperty( + $compiledName, + $compiledValue + ); + + $this->appendOutputLine($out, Type::T_ASSIGN, $line); break; case Type::T_ASSIGN: list(, $name, $value) = $child; if ($name[0] === Type::T_VARIABLE) { - $flags = isset($child[3]) ? $child[3] : []; - $isDefault = in_array('!default', $flags); - $isGlobal = in_array('!global', $flags); + $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, $value); @@ -2120,8 +2607,8 @@ protected function compileChild($child, OutputBlock $out) } $shouldSet = $isDefault && - (($result = $this->get($name[1], false)) === null - || $result === static::$null); + (\is_null($result = $this->get($name[1], false)) || + $result === static::$null); if (! $isDefault || $shouldSet) { $this->set($name[1], $this->reduce($value), true, null, $value); @@ -2131,28 +2618,78 @@ protected function compileChild($child, OutputBlock $out) $compiledName = $this->compileValue($name); - // handle shorthand syntax: size / line-height - if ($compiledName === 'font' || $compiledName === 'grid-row' || $compiledName === 'grid-column') { + // handle shorthand syntaxes : size / line-height... + if (\in_array($compiledName, ['font', 'grid-row', 'grid-column', 'border-radius'])) { 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; + $shorthandValue=&$value; + + $shorthandDividerNeedsUnit = false; + $maxListElements = null; + $maxShorthandDividers = 1; + + switch ($compiledName) { + case 'border-radius': + $maxListElements = 4; + $shorthandDividerNeedsUnit = true; + break; + } - if ($value[0] === Type::T_LIST && $value[1]==',') { + if ($compiledName === 'font' && $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]; + $shorthandValue=&$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 ($shorthandValue[0] === Type::T_EXPRESSION && $shorthandValue[1] === '/') { + $revert = true; + + if ($shorthandDividerNeedsUnit) { + $divider = $shorthandValue[3]; + + if (\is_array($divider)) { + $divider = $this->reduce($divider, true); + } + + if (\intval($divider->dimension) && ! \count($divider->units)) { + $revert = false; + } + } + + if ($revert) { + $shorthandValue = $this->expToString($shorthandValue); + } + } elseif ($shorthandValue[0] === Type::T_LIST) { + foreach ($shorthandValue[2] as &$item) { if ($item[0] === Type::T_EXPRESSION && $item[1] === '/') { - $item = $this->expToString($item); + if ($maxShorthandDividers > 0) { + $revert = true; + + // if the list of values is too long, this has to be a shorthand, + // otherwise it could be a real division + if (\is_null($maxListElements) || \count($shorthandValue[2]) <= $maxListElements) { + if ($shorthandDividerNeedsUnit) { + $divider = $item[3]; + + if (\is_array($divider)) { + $divider = $this->reduce($divider, true); + } + + if (\intval($divider->dimension) && ! \count($divider->units)) { + $revert = false; + } + } + } + + if ($revert) { + $item = $this->expToString($item); + $maxShorthandDividers--; + } + } } } } @@ -2170,10 +2707,14 @@ protected function compileChild($child, OutputBlock $out) $compiledValue = $this->compileValue($value); - $out->lines[] = $this->formatter->property( - $compiledName, - $compiledValue - ); + // ignore empty value + if (\strlen($compiledValue)) { + $line = $this->formatter->property( + $compiledName, + $compiledValue + ); + $this->appendOutputLine($out, Type::T_ASSIGN, $line); + } break; case Type::T_COMMENT: @@ -2182,25 +2723,33 @@ protected function compileChild($child, OutputBlock $out) break; } - $out->lines[] = $child[1]; + $line = $this->compileCommentValue($child, true); + $this->appendOutputLine($out, Type::T_COMMENT, $line); break; case Type::T_MIXIN: case Type::T_FUNCTION: list(, $block) = $child; - - $this->set(static::$namespaces[$block->type] . $block->name, $block); + // the block need to be able to go up to it's parent env to resolve vars + $block->parentEnv = $this->getStoreEnv(); + $this->set(static::$namespaces[$block->type] . $block->name, $block, true); break; case Type::T_EXTEND: foreach ($child[1] as $sel) { + $sel = $this->replaceSelfSelector($sel); $results = $this->evalSelectors([$sel]); foreach ($results as $result) { // only use the first one $result = current($result); + $selectors = $out->selectors; + + if (! $selectors && isset($child['selfParent'])) { + $selectors = $this->multiplySelectors($this->env, $child['selfParent']); + } - $this->pushExtends($result, $out->selectors, $child); + $this->pushExtends($result, $selectors, $child); } } break; @@ -2213,7 +2762,8 @@ protected function compileChild($child, OutputBlock $out) } foreach ($if->cases as $case) { - if ($case->type === Type::T_ELSE || + if ( + $case->type === Type::T_ELSE || $case->type === Type::T_ELSEIF && $this->isTruthy($this->reduce($case->cond)) ) { return $this->compileChildren($case->children, $out); @@ -2224,12 +2774,12 @@ protected function compileChild($child, OutputBlock $out) case Type::T_EACH: list(, $each) = $child; - $list = $this->coerceList($this->reduce($each->list)); + $list = $this->coerceList($this->reduce($each->list), ',', true); $this->pushEnv(); foreach ($list[2] as $item) { - if (count($each->vars) === 1) { + if (\count($each->vars) === 1) { $this->set($each->vars[0], $item, true); } else { list(,, $values) = $this->coerceList($item); @@ -2243,7 +2793,9 @@ protected function compileChild($child, OutputBlock $out) if ($ret) { if ($ret[0] !== Type::T_CONTROL) { + $store = $this->env->store; $this->popEnv(); + $this->backPropagateEnv($store, $each->vars); return $ret; } @@ -2253,8 +2805,10 @@ protected function compileChild($child, OutputBlock $out) } } } - + $store = $this->env->store; $this->popEnv(); + $this->backPropagateEnv($store, $each->vars); + break; case Type::T_WHILE: @@ -2281,10 +2835,16 @@ protected function compileChild($child, OutputBlock $out) $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()); + if (! $start instanceof Node\Number) { + throw $this->error('%s is not a number', $start[0]); + } - break; + if (! $end instanceof Node\Number) { + throw $this->error('%s is not a number', $end[0]); + } + + if (! ($start[2] == $end[2] || $end->unitless())) { + throw $this->error('Incompatible units: "%s" && "%s".', $start->unitStr(), $end->unitStr()); } $unit = $start[2]; @@ -2293,8 +2853,11 @@ protected function compileChild($child, OutputBlock $out) $d = $start < $end ? 1 : -1; + $this->pushEnv(); + for (;;) { - if ((! $for->until && $start - $d == $end) || + if ( + (! $for->until && $start - $d == $end) || ($for->until && $start == $end) ) { break; @@ -2307,6 +2870,10 @@ protected function compileChild($child, OutputBlock $out) if ($ret) { if ($ret[0] !== Type::T_CONTROL) { + $store = $this->env->store; + $this->popEnv(); + $this->backPropagateEnv($store, [$for->var]); + return $ret; } @@ -2315,6 +2882,11 @@ protected function compileChild($child, OutputBlock $out) } } } + + $store = $this->env->store; + $this->popEnv(); + $this->backPropagateEnv($store, [$for->var]); + break; case Type::T_BREAK: @@ -2327,37 +2899,17 @@ protected function compileChild($child, OutputBlock $out) return $this->reduce($child[1], true); case Type::T_NESTED_PROPERTY: - list(, $prop) = $child; - - $prefixed = []; - $prefix = $this->compileValue($prop->prefix) . '-'; - - foreach ($prop->children as $child) { - 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->compileChildrenNoReturn($prefixed, $out); + $this->compileNestedPropertiesBlock($child[1], $out); break; case Type::T_INCLUDE: // including a mixin - list(, $name, $argValues, $content) = $child; + list(, $name, $argValues, $content, $argUsing) = $child; $mixin = $this->get(static::$namespaces['mixin'] . $name, false); if (! $mixin) { - $this->throwError("Undefined mixin $name"); - break; + throw $this->error("Undefined mixin $name"); } $callingScope = $this->getStoreEnv(); @@ -2366,9 +2918,6 @@ protected function compileChild($child, OutputBlock $out) $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; @@ -2383,7 +2932,7 @@ protected function compileChild($child, OutputBlock $out) $parent->selectors = $parentSelectors; foreach ($mixin->children as $k => $child) { - if (isset($child[1]) && is_object($child[1]) && $child[1] instanceof Block) { + if (isset($child[1]) && \is_object($child[1]) && $child[1] instanceof Block) { $mixin->children[$k][1]->parent = $parent; } } @@ -2394,9 +2943,18 @@ protected function compileChild($child, OutputBlock $out) // i.e., recursive @include of the same mixin if (isset($content)) { $copyContent = clone $content; - $copyContent->scope = $callingScope; + $copyContent->scope = clone $callingScope; $this->setRaw(static::$namespaces['special'] . 'content', $copyContent, $this->env); + } else { + $this->setRaw(static::$namespaces['special'] . 'content', null, $this->env); + } + + // save the "using" argument list for applying it to when "@content" is invoked + if (isset($argUsing)) { + $this->setRaw(static::$namespaces['special'] . 'using', $argUsing, $this->env); + } else { + $this->setRaw(static::$namespaces['special'] . 'using', null, $this->env); } if (isset($mixin->args)) { @@ -2405,26 +2963,44 @@ protected function compileChild($child, OutputBlock $out) $this->env->marker = 'mixin'; - $this->compileChildrenNoReturn($mixin->children, $out, $selfParent, $this->env->marker . " " . $name); + if (! empty($mixin->parentEnv)) { + $this->env->declarationScopeParent = $mixin->parentEnv; + } else { + throw $this->error("@mixin $name() without parentEnv"); + } - $this->storeEnv = $storeEnv; + $this->compileChildrenNoReturn($mixin->children, $out, $selfParent, $this->env->marker . ' ' . $name); $this->popEnv(); break; case Type::T_MIXIN_CONTENT: - $env = isset($this->storeEnv) ? $this->storeEnv : $this->env; - $content = $this->get(static::$namespaces['special'] . 'content', false, $env); + $env = isset($this->storeEnv) ? $this->storeEnv : $this->env; + $content = $this->get(static::$namespaces['special'] . 'content', false, $env); + $argUsing = $this->get(static::$namespaces['special'] . 'using', false, $env); + $argContent = $child[1]; if (! $content) { - $content = new \stdClass(); - $content->scope = new \stdClass(); - $content->children = $this->storeEnv->parent->block->children; break; } $storeEnv = $this->storeEnv; + $varsUsing = []; + + if (isset($argUsing) && isset($argContent)) { + // Get the arguments provided for the content with the names provided in the "using" argument list + $this->storeEnv = null; + $varsUsing = $this->applyArguments($argUsing, $argContent, false); + } + + // restore the scope from the @content $this->storeEnv = $content->scope; + + // append the vars from using if any + foreach ($varsUsing as $name => $val) { + $this->set($name, $val, true, $this->storeEnv); + } + $this->compileChildrenNoReturn($content->children, $out); $this->storeEnv = $storeEnv; @@ -2434,35 +3010,36 @@ protected function compileChild($child, OutputBlock $out) list(, $value) = $child; $fname = $this->sourceNames[$this->sourceIndex]; - $line = $this->sourceLine; - $value = $this->compileValue($this->reduce($value, true)); - fwrite($this->stderr, "File $fname on line $line DEBUG: $value\n"); + $line = $this->sourceLine; + $value = $this->compileDebugValue($value); + + fwrite($this->stderr, "$fname:$line DEBUG: $value\n"); break; case Type::T_WARN: list(, $value) = $child; $fname = $this->sourceNames[$this->sourceIndex]; - $line = $this->sourceLine; - $value = $this->compileValue($this->reduce($value, true)); - fwrite($this->stderr, "File $fname on line $line WARN: $value\n"); + $line = $this->sourceLine; + $value = $this->compileDebugValue($value); + + fwrite($this->stderr, "WARNING: $value\n on line $line of $fname\n\n"); break; case Type::T_ERROR: list(, $value) = $child; $fname = $this->sourceNames[$this->sourceIndex]; - $line = $this->sourceLine; + $line = $this->sourceLine; $value = $this->compileValue($this->reduce($value, true)); - $this->throwError("File $fname on line $line ERROR: $value\n"); - break; + + throw $this->error("File $fname on line $line ERROR: $value\n"); case Type::T_CONTROL: - $this->throwError('@break/@continue not permitted in this scope'); - break; + throw $this->error('@break/@continue not permitted in this scope'); default: - $this->throwError("unknown child type: $child[0]"); + throw $this->error("unknown child type: $child[0]"); } } @@ -2470,14 +3047,21 @@ protected function compileChild($child, OutputBlock $out) * Reduce expression to string * * @param array $exp + * @param true $keepParens * * @return array */ - protected function expToString($exp) + protected function expToString($exp, $keepParens = false) { - list(, $op, $left, $right, /* $inParens */, $whiteLeft, $whiteRight) = $exp; + list(, $op, $left, $right, $inParens, $whiteLeft, $whiteRight) = $exp; + + $content = []; - $content = [$this->reduce($left)]; + if ($keepParens && $inParens) { + $content[] = '('; + } + + $content[] = $this->reduce($left); if ($whiteLeft) { $content[] = ' '; @@ -2491,6 +3075,10 @@ protected function expToString($exp) $content[] = $this->reduce($right); + if ($keepParens && $inParens) { + $content[] = ')'; + } + return [Type::T_STRING, '', $content]; } @@ -2548,10 +3136,13 @@ protected function shouldEval($value) * @param array $value * @param boolean $inExp * - * @return array|\Leafo\ScssPhp\Node\Number + * @return null|string|array|\ScssPhp\ScssPhp\Node\Number */ protected function reduce($value, $inExp = false) { + if (\is_null($value)) { + return null; + } switch ($value[0]) { case Type::T_EXPRESSION: @@ -2567,16 +3158,16 @@ protected function reduce($value, $inExp = false) } // 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())) + 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); } - $left = $this->coerceForExpression($left); + $left = $this->coerceForExpression($left); $right = $this->coerceForExpression($right); - $ltype = $left[0]; $rtype = $right[0]; @@ -2590,17 +3181,19 @@ protected function reduce($value, $inExp = false) // 3. op[op name] $fn = "op${ucOpName}${ucLType}${ucRType}"; - if (is_callable([$this, $fn]) || + if ( + \is_callable([$this, $fn]) || (($fn = "op${ucLType}${ucRType}") && - is_callable([$this, $fn]) && + \is_callable([$this, $fn]) && $passOp = true) || (($fn = "op${ucOpName}") && - is_callable([$this, $fn]) && + \is_callable([$this, $fn]) && $genOp = true) ) { $coerceUnit = false; - if (! isset($genOp) && + if ( + ! isset($genOp) && $left[0] === Type::T_NUMBER && $right[0] === Type::T_NUMBER ) { $coerceUnit = true; @@ -2630,9 +3223,14 @@ protected function reduce($value, $inExp = false) $targetUnit = $left->unitless() ? $right[2] : $left[2]; } - if (! $left->unitless() && ! $right->unitless()) { + $baseUnitLeft = $left->isNormalizable(); + $baseUnitRight = $right->isNormalizable(); + + if ($baseUnitLeft && $baseUnitRight && $baseUnitLeft === $baseUnitRight) { $left = $left->normalize(); $right = $right->normalize(); + } elseif ($coerceUnit) { + $left = new Node\Number($left[1], []); } } @@ -2708,7 +3306,7 @@ protected function reduce($value, $inExp = false) case Type::T_STRING: foreach ($value[2] as &$item) { - if (is_array($item) || $item instanceof \ArrayAccess) { + if (\is_array($item) || $item instanceof \ArrayAccess) { $item = $this->reduce($item); } } @@ -2717,6 +3315,7 @@ protected function reduce($value, $inExp = false) case Type::T_INTERPOLATE: $value[1] = $this->reduce($value[1]); + if ($inExp) { return $value[1]; } @@ -2727,8 +3326,10 @@ protected function reduce($value, $inExp = false) return $this->fncall($value[1], $value[2]); case Type::T_SELF: - $selfSelector = $this->multiplySelectors($this->env); + $selfParent = ! empty($this->env->block->selfParent) ? $this->env->block->selfParent : null; + $selfSelector = $this->multiplySelectors($this->env, $selfParent); $selfSelector = $this->collapseSelectors($selfSelector, true); + return $selfSelector; default: @@ -2744,114 +3345,321 @@ protected function reduce($value, $inExp = false) * * @return array|null */ - protected function fncall($name, $argValues) + protected function fncall($functionReference, $argValues) { - // SCSS @function - if ($this->callScssFunction($name, $argValues, $returnValue)) { - return $returnValue; - } + // a string means this is a static hard reference coming from the parsing + if (is_string($functionReference)) { + $name = $functionReference; - // native PHP functions - if ($this->callNativeFunction($name, $argValues, $returnValue)) { - return $returnValue; + $functionReference = $this->getFunctionReference($name); + if ($functionReference === static::$null || $functionReference[0] !== Type::T_FUNCTION_REFERENCE) { + $functionReference = [Type::T_FUNCTION, $name, [Type::T_LIST, ',', []]]; + } } - // for CSS functions, simply flatten the arguments into a list - $listArgs = []; + // a function type means we just want a plain css function call + if ($functionReference[0] === Type::T_FUNCTION) { + // for CSS functions, simply flatten the arguments into a list + $listArgs = []; - foreach ((array) $argValues as $arg) { - if (empty($arg[0])) { - $listArgs[] = $this->reduce($arg[1]); + foreach ((array) $argValues as $arg) { + if (empty($arg[0]) || count($argValues) === 1) { + $listArgs[] = $this->reduce($this->stringifyFncallArgs($arg[1])); + } } + + return [Type::T_FUNCTION, $functionReference[1], [Type::T_LIST, ',', $listArgs]]; } - return [Type::T_FUNCTION, $name, [Type::T_LIST, ',', $listArgs]]; - } + if ($functionReference === static::$null || $functionReference[0] !== Type::T_FUNCTION_REFERENCE) { + return static::$defaultValue; + } - /** - * Normalize name - * - * @param string $name - * - * @return string - */ - protected function normalizeName($name) - { - return str_replace('-', '_', $name); - } - /** - * Normalize value - * - * @param array $value - * - * @return array - */ - public function normalizeValue($value) - { - $value = $this->coerceForExpression($this->reduce($value)); + switch ($functionReference[1]) { + // SCSS @function + case 'scss': + return $this->callScssFunction($functionReference[3], $argValues); - switch ($value[0]) { - case Type::T_LIST: - $value = $this->extractInterpolation($value); + // native PHP functions + case 'user': + case 'native': + list(,,$name, $fn, $prototype) = $functionReference; - if ($value[0] !== Type::T_LIST) { - return [Type::T_KEYWORD, $this->compileValue($value)]; + // special cases of css valid functions min/max + $name = strtolower($name); + if (\in_array($name, ['min', 'max'])) { + $cssFunction = $this->cssValidArg( + [Type::T_FUNCTION_CALL, $name, $argValues], + ['min', 'max', 'calc', 'env', 'var'] + ); + if ($cssFunction !== false) { + return $cssFunction; + } } + $returnValue = $this->callNativeFunction($name, $fn, $prototype, $argValues); - foreach ($value[2] as $key => $item) { - $value[2][$key] = $this->normalizeValue($item); + if (! isset($returnValue)) { + return $this->fncall([Type::T_FUNCTION, $name, [Type::T_LIST, ',', []]], $argValues); } - return $value; - - case Type::T_STRING: - return [$value[0], '"', [$this->compileStringContent($value)]]; - - case Type::T_NUMBER: - return $value->normalize(); - - case Type::T_INTERPOLATE: - return [Type::T_KEYWORD, $this->compileValue($value)]; + return $returnValue; default: - return $value; + return static::$defaultValue; } } - /** - * Add numbers - * - * @param array $left - * @param array $right - * - * @return \Leafo\ScssPhp\Node\Number - */ - protected function opAddNumberNumber($left, $right) + protected function cssValidArg($arg, $allowed_function = [], $inFunction = false) { - return new Node\Number($left[1] + $right[1], $left[2]); - } + switch ($arg[0]) { + case Type::T_INTERPOLATE: + return [Type::T_KEYWORD, $this->CompileValue($arg)]; - /** - * Multiply numbers - * - * @param array $left - * @param array $right - * - * @return \Leafo\ScssPhp\Node\Number - */ - protected function opMulNumberNumber($left, $right) - { - return new Node\Number($left[1] * $right[1], $left[2]); - } + case Type::T_FUNCTION: + if (! \in_array($arg[1], $allowed_function)) { + return false; + } + if ($arg[2][0] === Type::T_LIST) { + foreach ($arg[2][2] as $k => $subarg) { + $arg[2][2][$k] = $this->cssValidArg($subarg, $allowed_function, $arg[1]); + if ($arg[2][2][$k] === false) { + return false; + } + } + } + return $arg; - /** - * Subtract numbers - * - * @param array $left + case Type::T_FUNCTION_CALL: + if (! \in_array($arg[1], $allowed_function)) { + return false; + } + $cssArgs = []; + foreach ($arg[2] as $argValue) { + if ($argValue === static::$null) { + return false; + } + $cssArg = $this->cssValidArg($argValue[1], $allowed_function, $arg[1]); + if (empty($argValue[0]) && $cssArg !== false) { + $cssArgs[] = [$argValue[0], $cssArg]; + } else { + return false; + } + } + + return $this->fncall([Type::T_FUNCTION, $arg[1], [Type::T_LIST, ',', []]], $cssArgs); + + case Type::T_STRING: + case Type::T_KEYWORD: + if (!$inFunction or !\in_array($inFunction, ['calc', 'env', 'var'])) { + return false; + } + return $this->stringifyFncallArgs($arg); + + case Type::T_NUMBER: + return $this->stringifyFncallArgs($arg); + + case Type::T_LIST: + if (!$inFunction) { + return false; + } + if (empty($arg['enclosing']) and $arg[1] === '') { + foreach ($arg[2] as $k => $subarg) { + $arg[2][$k] = $this->cssValidArg($subarg, $allowed_function, $inFunction); + if ($arg[2][$k] === false) { + return false; + } + } + $arg[0] = Type::T_STRING; + return $arg; + } + return false; + + case Type::T_EXPRESSION: + if (! \in_array($arg[1], ['+', '-', '/', '*'])) { + return false; + } + $arg[2] = $this->cssValidArg($arg[2], $allowed_function, $inFunction); + $arg[3] = $this->cssValidArg($arg[3], $allowed_function, $inFunction); + if ($arg[2] === false || $arg[3] === false) { + return false; + } + return $this->expToString($arg, true); + + case Type::T_VARIABLE: + case Type::T_SELF: + default: + return false; + } + } + + + /** + * Reformat fncall arguments to proper css function output + * @param $arg + * @return array|\ArrayAccess|Node\Number|string|null + */ + protected function stringifyFncallArgs($arg) + { + + switch ($arg[0]) { + case Type::T_LIST: + foreach ($arg[2] as $k => $v) { + $arg[2][$k] = $this->stringifyFncallArgs($v); + } + break; + + case Type::T_EXPRESSION: + if ($arg[1] === '/') { + $arg[2] = $this->stringifyFncallArgs($arg[2]); + $arg[3] = $this->stringifyFncallArgs($arg[3]); + $arg[5] = $arg[6] = false; // no space around / + $arg = $this->expToString($arg); + } + break; + + case Type::T_FUNCTION_CALL: + $name = strtolower($arg[1]); + + if (in_array($name, ['max', 'min', 'calc'])) { + $args = $arg[2]; + $arg = $this->fncall([Type::T_FUNCTION, $name, [Type::T_LIST, ',', []]], $args); + } + break; + } + + return $arg; + } + + /** + * Find a function reference + * @param string $name + * @param bool $safeCopy + * @return array + */ + protected function getFunctionReference($name, $safeCopy = false) + { + // SCSS @function + if ($func = $this->get(static::$namespaces['function'] . $name, false)) { + if ($safeCopy) { + $func = clone $func; + } + + return [Type::T_FUNCTION_REFERENCE, 'scss', $name, $func]; + } + + // native PHP functions + + // try to find a native lib function + $normalizedName = $this->normalizeName($name); + $libName = null; + + if (isset($this->userFunctions[$normalizedName])) { + // see if we can find a user function + list($f, $prototype) = $this->userFunctions[$normalizedName]; + + return [Type::T_FUNCTION_REFERENCE, 'user', $name, $f, $prototype]; + } + + if (($f = $this->getBuiltinFunction($normalizedName)) && \is_callable($f)) { + $libName = $f[1]; + $prototype = isset(static::$$libName) ? static::$$libName : null; + + return [Type::T_FUNCTION_REFERENCE, 'native', $name, $f, $prototype]; + } + + return static::$null; + } + + + /** + * Normalize name + * + * @param string $name + * + * @return string + */ + protected function normalizeName($name) + { + return str_replace('-', '_', $name); + } + + /** + * Normalize value + * + * @param array $value + * + * @return array + */ + public function normalizeValue($value) + { + $value = $this->coerceForExpression($this->reduce($value)); + + switch ($value[0]) { + case Type::T_LIST: + $value = $this->extractInterpolation($value); + + if ($value[0] !== Type::T_LIST) { + return [Type::T_KEYWORD, $this->compileValue($value)]; + } + + foreach ($value[2] as $key => $item) { + $value[2][$key] = $this->normalizeValue($item); + } + + if (! empty($value['enclosing'])) { + unset($value['enclosing']); + } + + return $value; + + case Type::T_STRING: + return [$value[0], '"', [$this->compileStringContent($value)]]; + + case Type::T_NUMBER: + return $value->normalize(); + + case Type::T_INTERPOLATE: + return [Type::T_KEYWORD, $this->compileValue($value)]; + + default: + return $value; + } + } + + /** + * Add numbers + * + * @param array $left + * @param array $right + * + * @return \ScssPhp\ScssPhp\Node\Number + */ + protected function opAddNumberNumber($left, $right) + { + return new Node\Number($left[1] + $right[1], $left[2]); + } + + /** + * Multiply numbers + * + * @param array $left + * @param array $right + * + * @return \ScssPhp\ScssPhp\Node\Number + */ + protected function opMulNumberNumber($left, $right) + { + return new Node\Number($left[1] * $right[1], $left[2]); + } + + /** + * Subtract numbers + * + * @param array $left * @param array $right * - * @return \Leafo\ScssPhp\Node\Number + * @return \ScssPhp\ScssPhp\Node\Number */ protected function opSubNumberNumber($left, $right) { @@ -2864,12 +3672,12 @@ protected function opSubNumberNumber($left, $right) * @param array $left * @param array $right * - * @return array|\Leafo\ScssPhp\Node\Number + * @return array|\ScssPhp\ScssPhp\Node\Number */ protected function opDivNumberNumber($left, $right) { if ($right[1] == 0) { - return [Type::T_STRING, '', [$left[1] . $left[2] . '/' . $right[1] . $right[2]]]; + return ($left[1] == 0) ? static::$NaN : static::$Infinity; } return new Node\Number($left[1] / $right[1], $left[2]); @@ -2881,10 +3689,14 @@ protected function opDivNumberNumber($left, $right) * @param array $left * @param array $right * - * @return \Leafo\ScssPhp\Node\Number + * @return \ScssPhp\ScssPhp\Node\Number */ protected function opModNumberNumber($left, $right) { + if ($right[1] == 0) { + return static::$NaN; + } + return new Node\Number($left[1] % $right[1], $left[2]); } @@ -3008,13 +3820,16 @@ protected function opColorColor($op, $left, $right) break; case '%': + if ($rval == 0) { + throw $this->error("color: Can't take modulo by zero"); + } + $out[] = $lval % $rval; break; case '/': if ($rval == 0) { - $this->throwError("color: Can't divide by zero"); - break 2; + throw $this->error("color: Can't divide by zero"); } $out[] = (int) ($lval / $rval); @@ -3027,8 +3842,7 @@ protected function opColorColor($op, $left, $right) return $this->opNeq($left, $right); default: - $this->throwError("color: unknown op $op"); - break 2; + throw $this->error("color: unknown op $op"); } } @@ -3181,7 +3995,7 @@ protected function opLtNumberNumber($left, $right) * @param array $left * @param array $right * - * @return \Leafo\ScssPhp\Node\Number + * @return \ScssPhp\ScssPhp\Node\Number */ protected function opCmpNumberNumber($left, $right) { @@ -3219,7 +4033,7 @@ public function toBool($thing) * * @param array $value * - * @return string + * @return string|array */ public function compileValue($value) { @@ -3236,14 +4050,38 @@ public function compileValue($value) // [4] - optional alpha component list(, $r, $g, $b) = $value; - $r = round($r); - $g = round($g); - $b = round($b); + $r = $this->compileRGBAValue($r); + $g = $this->compileRGBAValue($g); + $b = $this->compileRGBAValue($b); - if (count($value) === 5 && $value[4] !== 1) { // rgba - $a = new Node\Number($value[4], ''); + if (\count($value) === 5) { + $alpha = $this->compileRGBAValue($value[4], true); - return 'rgba(' . $r . ', ' . $g . ', ' . $b . ', ' . $a . ')'; + if (! is_numeric($alpha) || $alpha < 1) { + $colorName = Colors::RGBaToColorName($r, $g, $b, $alpha); + + if (! \is_null($colorName)) { + return $colorName; + } + + if (is_numeric($alpha)) { + $a = new Node\Number($alpha, ''); + } else { + $a = $alpha; + } + + return 'rgba(' . $r . ', ' . $g . ', ' . $b . ', ' . $a . ')'; + } + } + + if (! is_numeric($r) || ! is_numeric($g) || ! is_numeric($b)) { + return 'rgb(' . $r . ', ' . $g . ', ' . $b . ')'; + } + + $colorName = Colors::RGBaToColorName($r, $g, $b); + + if (! \is_null($colorName)) { + return $colorName; } $h = sprintf('#%02x%02x%02x', $r, $g, $b); @@ -3259,13 +4097,36 @@ public function compileValue($value) return $value->output($this); case Type::T_STRING: - return $value[1] . $this->compileStringContent($value) . $value[1]; + $content = $this->compileStringContent($value); + + if ($value[1]) { + // force double quote as string quote for the output in certain cases + if ( + $value[1] === "'" && + strpos($content, '"') === false && + strpbrk($content, '{}') !== false + ) { + $value[1] = '"'; + } + $content = str_replace( + array('\\a', "\n", "\f" , '\\' , "\r" , $value[1]), + array("\r" , ' ' , '\\f', '\\\\', '\\a', '\\' . $value[1]), + $content + ); + } + + return $value[1] . $content . $value[1]; case Type::T_FUNCTION: $args = ! empty($value[2]) ? $this->compileValue($value[2]) : ''; return "$value[1]($args)"; + case Type::T_FUNCTION_REFERENCE: + $name = ! empty($value[2]) ? $value[2] : ''; + + return "get-function(\"$name\")"; + case Type::T_LIST: $value = $this->extractInterpolation($value); @@ -3274,9 +4135,30 @@ public function compileValue($value) } list(, $delim, $items) = $value; + $pre = $post = ''; + + if (! empty($value['enclosing'])) { + switch ($value['enclosing']) { + case 'parent': + //$pre = '('; + //$post = ')'; + break; + case 'forced_parent': + $pre = '('; + $post = ')'; + break; + case 'bracket': + case 'forced_bracket': + $pre = '['; + $post = ']'; + break; + } + } + + $prefix_value = ''; if ($delim !== ' ') { - $delim .= ' '; + $prefix_value = ' '; } $filtered = []; @@ -3286,17 +4168,23 @@ public function compileValue($value) continue; } - $filtered[] = $this->compileValue($item); + $compiled = $this->compileValue($item); + + if ($prefix_value && \strlen($compiled)) { + $compiled = $prefix_value . $compiled; + } + + $filtered[] = $compiled; } - return implode("$delim", $filtered); + return $pre . substr(implode("$delim", $filtered), \strlen($prefix_value)) . $post; case Type::T_MAP: - $keys = $value[1]; - $values = $value[2]; + $keys = $value[1]; + $values = $value[2]; $filtered = []; - for ($i = 0, $s = count($keys); $i < $s; $i++) { + for ($i = 0, $s = \count($keys); $i < $s; $i++) { $filtered[$this->compileValue($keys[$i])] = $this->compileValue($values[$i]); } @@ -3311,11 +4199,24 @@ public function compileValue($value) list(, $interpolate, $left, $right) = $value; list(,, $whiteLeft, $whiteRight) = $interpolate; - $left = count($left[2]) > 0 ? - $this->compileValue($left) . $whiteLeft : ''; + $delim = $left[1]; + + if ($delim && $delim !== ' ' && ! $whiteLeft) { + $delim .= ' '; + } + + $left = \count($left[2]) > 0 + ? $this->compileValue($left) . $delim . $whiteLeft + : ''; + + $delim = $right[1]; + + if ($delim && $delim !== ' ') { + $delim .= ' '; + } - $right = count($right[2]) > 0 ? - $whiteRight . $this->compileValue($right) : ''; + $right = \count($right[2]) > 0 ? + $whiteRight . $delim . $this->compileValue($right) : ''; return $left . $this->compileValue($interpolate) . $right; @@ -3345,6 +4246,7 @@ public function compileValue($value) } $temp = $this->compileValue([Type::T_KEYWORD, $item]); + if ($temp[0] === Type::T_STRING) { $filtered[] = $this->compileStringContent($temp); } elseif ($temp[0] === Type::T_KEYWORD) { @@ -3370,8 +4272,29 @@ public function compileValue($value) case Type::T_NULL: return 'null'; + case Type::T_COMMENT: + return $this->compileCommentValue($value); + + default: + throw $this->error('unknown value type: ' . json_encode($value)); + } + } + + /** + * @param array $value + * + * @return array|string + */ + protected function compileDebugValue($value) + { + $value = $this->reduce($value, true); + + switch ($value[0]) { + case Type::T_STRING: + return $this->compileStringContent($value); + default: - $this->throwError("unknown value type: $value[0]"); + return $this->compileValue($value); } } @@ -3399,7 +4322,7 @@ protected function compileStringContent($string) $parts = []; foreach ($string[2] as $part) { - if (is_array($part) || $part instanceof \ArrayAccess) { + if (\is_array($part) || $part instanceof \ArrayAccess) { $parts[] = $this->compileValue($part); } else { $parts[] = $part; @@ -3422,8 +4345,8 @@ protected function extractInterpolation($list) foreach ($items as $i => $item) { 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)]; + $before = [Type::T_LIST, $list[1], \array_slice($items, 0, $i)]; + $after = [Type::T_LIST, $list[1], \array_slice($items, $i + 1)]; return [Type::T_INTERPOLATED, $item, $before, $after]; } @@ -3435,8 +4358,8 @@ protected function extractInterpolation($list) /** * Find the final set of selectors * - * @param \Leafo\ScssPhp\Compiler\Environment $env - * @param \Leafo\ScssPhp\Block $selfParent + * @param \ScssPhp\ScssPhp\Compiler\Environment $env + * @param \ScssPhp\ScssPhp\Block $selfParent * * @return array */ @@ -3448,7 +4371,7 @@ protected function multiplySelectors(Environment $env, $selfParent = null) $selfParentSelectors = null; - if (! is_null($selfParent) && $selfParent->selectors) { + if (! \is_null($selfParent) && $selfParent->selectors) { $selfParentSelectors = $this->evalSelectors($selfParent->selectors); } @@ -3460,12 +4383,12 @@ protected function multiplySelectors(Environment $env, $selfParent = null) $selectors = $env->selectors; do { - $stillHasSelf = false; + $stillHasSelf = false; $prevSelectors = $selectors; - $selectors = []; + $selectors = []; - foreach ($prevSelectors as $selector) { - foreach ($parentSelectors as $parent) { + foreach ($parentSelectors as $parent) { + foreach ($prevSelectors as $selector) { if ($selfParentSelectors) { foreach ($selfParentSelectors as $selfParent) { // if no '&' in the selector, each call will give same result, only add once @@ -3485,6 +4408,11 @@ protected function multiplySelectors(Environment $env, $selfParent = null) $selectors = array_values($selectors); + // case we are just starting a at-root : nothing to multiply but parentSelectors + if (! $selectors && $selfParentSelectors) { + $selectors = $selfParentSelectors; + } + return $selectors; } @@ -3493,7 +4421,7 @@ protected function multiplySelectors(Environment $env, $selfParent = null) * * @param array $parent * @param array $child - * @param boolean &$stillHasSelf + * @param boolean $stillHasSelf * @param array $selfParentSelectors * @return array @@ -3515,7 +4443,7 @@ protected function joinSelectors($parent, $child, &$stillHasSelf, $selfParentSel if ($p === static::$selfSelector && ! $setSelf) { $setSelf = true; - if (is_null($selfParentSelectors)) { + if (\is_null($selfParentSelectors)) { $selfParentSelectors = $parent; } @@ -3526,11 +4454,13 @@ protected function joinSelectors($parent, $child, &$stillHasSelf, $selfParentSel } foreach ($parentPart as $pp) { - if (is_array($pp)) { + if (\is_array($pp)) { $flatten = []; + array_walk_recursive($pp, function ($a) use (&$flatten) { $flatten[] = $a; }); + $pp = implode($flatten); } @@ -3551,14 +4481,15 @@ protected function joinSelectors($parent, $child, &$stillHasSelf, $selfParentSel /** * Multiply media * - * @param \Leafo\ScssPhp\Compiler\Environment $env - * @param array $childQueries + * @param \ScssPhp\ScssPhp\Compiler\Environment $env + * @param array $childQueries * * @return array */ protected function multiplyMedia(Environment $env = null, $childQueries = null) { - if (! isset($env) || + if ( + ! isset($env) || ! empty($env->block->type) && $env->block->type !== Type::T_MEDIA ) { return $childQueries; @@ -3574,12 +4505,14 @@ protected function multiplyMedia(Environment $env = null, $childQueries = null) : [[[Type::T_MEDIA_VALUE, $env->block->value]]]; $store = [$this->env, $this->storeEnv]; - $this->env = $env; + + $this->env = $env; $this->storeEnv = null; - $parentQueries = $this->evaluateMediaQuery($parentQueries); + $parentQueries = $this->evaluateMediaQuery($parentQueries); + list($this->env, $this->storeEnv) = $store; - if ($childQueries === null) { + if (\is_null($childQueries)) { $childQueries = $parentQueries; } else { $originalQueries = $childQueries; @@ -3602,7 +4535,7 @@ protected function multiplyMedia(Environment $env = null, $childQueries = null) /** * Convert env linked list to stack * - * @param \Leafo\ScssPhp\Compiler\Environment $env + * @param \ScssPhp\ScssPhp\Compiler\Environment $env * * @return array */ @@ -3620,7 +4553,7 @@ protected function compactEnv(Environment $env) * * @param array $envs * - * @return \Leafo\ScssPhp\Compiler\Environment + * @return \ScssPhp\ScssPhp\Compiler\Environment */ protected function extractEnv($envs) { @@ -3635,19 +4568,21 @@ protected function extractEnv($envs) /** * Push environment * - * @param \Leafo\ScssPhp\Block $block + * @param \ScssPhp\ScssPhp\Block $block * - * @return \Leafo\ScssPhp\Compiler\Environment + * @return \ScssPhp\ScssPhp\Compiler\Environment */ protected function pushEnv(Block $block = null) { - $env = new Environment; + $env = new Environment(); $env->parent = $this->env; + $env->parentStore = $this->storeEnv; $env->store = []; $env->block = $block; $env->depth = isset($this->env->depth) ? $this->env->depth + 1 : 0; $this->env = $env; + $this->storeEnv = null; return $env; } @@ -3657,13 +4592,29 @@ protected function pushEnv(Block $block = null) */ protected function popEnv() { + $this->storeEnv = $this->env->parentStore; $this->env = $this->env->parent; } + /** + * Propagate vars from a just poped Env (used in @each and @for) + * + * @param array $store + * @param null|array $excludedVars + */ + protected function backPropagateEnv($store, $excludedVars = null) + { + foreach ($store as $key => $value) { + if (empty($excludedVars) || ! \in_array($key, $excludedVars)) { + $this->set($key, $value, true); + } + } + } + /** * Get store environment * - * @return \Leafo\ScssPhp\Compiler\Environment + * @return \ScssPhp\ScssPhp\Compiler\Environment */ protected function getStoreEnv() { @@ -3673,11 +4624,11 @@ protected function getStoreEnv() /** * Set variable * - * @param string $name - * @param mixed $value - * @param boolean $shadow - * @param \Leafo\ScssPhp\Compiler\Environment $env - * @param mixed $valueUnreduced + * @param string $name + * @param mixed $value + * @param boolean $shadow + * @param \ScssPhp\ScssPhp\Compiler\Environment $env + * @param mixed $valueUnreduced */ protected function set($name, $value, $shadow = false, Environment $env = null, $valueUnreduced = null) { @@ -3697,33 +4648,52 @@ protected function set($name, $value, $shadow = false, Environment $env = null, /** * Set existing variable * - * @param string $name - * @param mixed $value - * @param \Leafo\ScssPhp\Compiler\Environment $env - * @param mixed $valueUnreduced + * @param string $name + * @param mixed $value + * @param \ScssPhp\ScssPhp\Compiler\Environment $env + * @param mixed $valueUnreduced */ protected function setExisting($name, $value, Environment $env, $valueUnreduced = null) { $storeEnv = $env; + $specialContentKey = static::$namespaces['special'] . 'content'; $hasNamespace = $name[0] === '^' || $name[0] === '@' || $name[0] === '%'; - for (;;) { - if (array_key_exists($name, $env->store)) { - break; - } + $maxDepth = 10000; - if (! $hasNamespace && isset($env->marker)) { - $env = $storeEnv; + for (;;) { + if ($maxDepth-- <= 0) { break; } - if (! isset($env->parent)) { - $env = $storeEnv; + if (\array_key_exists($name, $env->store)) { break; } - $env = $env->parent; + if (! $hasNamespace && isset($env->marker)) { + if (! empty($env->store[$specialContentKey])) { + $env = $env->store[$specialContentKey]->scope; + continue; + } + + if (! empty($env->declarationScopeParent)) { + $env = $env->declarationScopeParent; + continue; + } else { + $env = $storeEnv; + break; + } + } + + if (isset($env->parentStore)) { + $env = $env->parentStore; + } elseif (isset($env->parent)) { + $env = $env->parent; + } else { + $env = $storeEnv; + break; + } } $env->store[$name] = $value; @@ -3736,10 +4706,10 @@ protected function setExisting($name, $value, Environment $env, $valueUnreduced /** * Set raw variable * - * @param string $name - * @param mixed $value - * @param \Leafo\ScssPhp\Compiler\Environment $env - * @param mixed $valueUnreduced + * @param string $name + * @param mixed $value + * @param \ScssPhp\ScssPhp\Compiler\Environment $env + * @param mixed $valueUnreduced */ protected function setRaw($name, $value, Environment $env, $valueUnreduced = null) { @@ -3755,10 +4725,10 @@ protected function setRaw($name, $value, Environment $env, $valueUnreduced = nul * * @api * - * @param string $name - * @param boolean $shouldThrow - * @param \Leafo\ScssPhp\Compiler\Environment $env - * @param boolean $unreduced + * @param string $name + * @param boolean $shouldThrow + * @param \ScssPhp\ScssPhp\Compiler\Environment $env + * @param boolean $unreduced * * @return mixed|null */ @@ -3771,7 +4741,6 @@ public function get($name, $shouldThrow = true, Environment $env = null, $unredu $env = $this->getStoreEnv(); } - $nextIsRoot = false; $hasNamespace = $normalizedName[0] === '^' || $normalizedName[0] === '@' || $normalizedName[0] === '%'; $maxDepth = 10000; @@ -3781,7 +4750,7 @@ public function get($name, $shouldThrow = true, Environment $env = null, $unredu break; } - if (array_key_exists($normalizedName, $env->store)) { + if (\array_key_exists($normalizedName, $env->store)) { if ($unreduced && isset($env->storeUnreduced[$normalizedName])) { return $env->storeUnreduced[$normalizedName]; } @@ -3790,24 +4759,30 @@ public function get($name, $shouldThrow = true, Environment $env = null, $unredu } if (! $hasNamespace && isset($env->marker)) { - if (! $nextIsRoot && ! empty($env->store[$specialContentKey])) { + if (! empty($env->store[$specialContentKey])) { $env = $env->store[$specialContentKey]->scope; continue; } - $env = $this->rootEnv; + if (! empty($env->declarationScopeParent)) { + $env = $env->declarationScopeParent; + } else { + $env = $this->rootEnv; + } continue; } - if (! isset($env->parent)) { + if (isset($env->parentStore)) { + $env = $env->parentStore; + } elseif (isset($env->parent)) { + $env = $env->parent; + } else { break; } - - $env = $env->parent; } if ($shouldThrow) { - $this->throwError("Undefined variable \$$name" . ($maxDepth<=0 ? " (infinite recursion)" : "")); + throw $this->error("Undefined variable \$$name" . ($maxDepth <= 0 ? ' (infinite recursion)' : '')); } // found nothing @@ -3817,14 +4792,14 @@ public function get($name, $shouldThrow = true, Environment $env = null, $unredu /** * Has variable? * - * @param string $name - * @param \Leafo\ScssPhp\Compiler\Environment $env + * @param string $name + * @param \ScssPhp\ScssPhp\Compiler\Environment $env * * @return boolean */ protected function has($name, Environment $env = null) { - return $this->get($name, false, $env) !== null; + return ! \is_null($this->get($name, false, $env)); } /** @@ -3898,7 +4873,7 @@ public function getVariables() */ public function addParsedFile($path) { - if (isset($path) && file_exists($path)) { + if (isset($path) && is_file($path)) { $this->parsedFiles[realpath($path)] = filemtime($path); } } @@ -3924,7 +4899,7 @@ public function getParsedFiles() */ public function addImportPath($path) { - if (! in_array($path, $this->importPaths)) { + if (! \in_array($path, $this->importPaths)) { $this->importPaths[] = $path; } } @@ -3947,10 +4922,13 @@ public function setImportPaths($path) * @api * * @param integer $numberPrecision + * + * @deprecated The number precision is not configurable anymore. The default is enough for all browsers. */ public function setNumberPrecision($numberPrecision) { - Node\Number::$precision = $numberPrecision; + @trigger_error('The number precision is not configurable anymore. ' + . 'The default is enough for all browsers.', E_USER_DEPRECATED); } /** @@ -4001,6 +4979,16 @@ public function setSourceMapOptions($sourceMapOptions) $this->sourceMapOptions = $sourceMapOptions; } + /** + * set hierarchy tree callback + * callback used to transform a single path into multiple paths to search through for hierarchy tree support + * e.g. parent -> child templates + */ + public function setHierarchyTreeCallback(callable $callback) + { + $this->hierarchyTreeCallback = $callback; + } + /** * Register function * @@ -4042,11 +5030,12 @@ public function addFeature($name) /** * Import file * - * @param string $path - * @param \Leafo\ScssPhp\Formatter\OutputBlock $out + * @param string $path + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $out */ protected function importFile($path, OutputBlock $out) { + $this->pushCallStack('import ' . $path); // see if tree is cached $realPath = realpath($path); @@ -4062,10 +5051,31 @@ protected function importFile($path, OutputBlock $out) $this->importCache[$realPath] = $tree; } + // temp add current path to import paths so child templates can be imported in current path scope $pi = pathinfo($path); - array_unshift($this->importPaths, $pi['dirname']); + + // check for hierarchyTreeCallback which allows multi level folder checking for files + $hierarchyTree = null; + if (is_callable($this->hierarchyTreeCallback)) { + $hierarchyTree = array_reverse(($this->hierarchyTreeCallback)($pi['dirname'])); + foreach ($hierarchyTree as $p) { + array_unshift($this->importPaths, $p); + } + } else { + array_unshift($this->importPaths, $pi['dirname']); + } + $this->compileChildrenNoReturn($tree->children, $out); - array_shift($this->importPaths); + + if (! empty($hierarchyTree)) { + foreach ($hierarchyTree as $p) { + array_shift($this->importPaths); + } + } else { + array_shift($this->importPaths); + } + + $this->popCallStack(); } /** @@ -4081,18 +5091,31 @@ public function findImport($url) { $urls = []; + $hasExtension = preg_match('/[.]s?css$/', $url); + // for "normal" scss imports (ignore vanilla css and external requests) - if (! preg_match('/\.css$|^https?:\/\//', $url)) { + if (! preg_match('~\.css$|^https?://|^//~', $url)) { + $isPartial = (strpos(basename($url), '_') === 0); + // try both normal and the _partial filename - $urls = [$url, preg_replace('/[^\/]+$/', '_\0', $url)]; - } + $urls = [$url . ($hasExtension ? '' : '.scss')]; - $hasExtension = preg_match('/[.]s?css$/', $url); + if (! $isPartial) { + $urls[] = preg_replace('~[^/]+$~', '_\0', $url) . ($hasExtension ? '' : '.scss'); + } + + if (! $hasExtension) { + $urls[] = "$url/index.scss"; + // allow to find a plain css file, *if* no scss or partial scss is found + $urls[] .= $url . '.css'; + } + } foreach ($this->importPaths as $dir) { - if (is_string($dir)) { + if (\is_string($dir)) { // check urls for normal import paths foreach ($urls as $full) { + $found = []; $separator = ( ! empty($dir) && substr($dir, -1) !== '/' && @@ -4100,22 +5123,42 @@ public function findImport($url) ) ? '/' : ''; $full = $dir . $separator . $full; - if ($this->fileExists($file = $full . '.scss') || - ($hasExtension && $this->fileExists($file = $full)) - ) { - return $file; + if (is_file($file = $full)) { + $found[] = $file; + } + if (! $isPartial) { + $full = dirname($full) . '/_' . basename($full); + if (is_file($file = $full)) { + $found[] = $file; + } + } + if ($found) { + if (\count($found) === 1) { + return reset($found); + } + if (\count($found) > 1) { + throw $this->error( + "Error: It's not clear which file to import. Found: " . implode(', ', $found) + ); + } } } - } elseif (is_callable($dir)) { + } elseif (\is_callable($dir)) { // check custom callback for import path - $file = call_user_func($dir, $url); + $file = \call_user_func($dir, $url); - if ($file !== null) { + if (! \is_null($file)) { return $file; } } } + if ($urls) { + if (! $hasExtension || preg_match('/[.]scss$/', $url)) { + throw $this->error("`$url` file not found for @import"); + } + } + return null; } @@ -4138,15 +5181,31 @@ public function setEncoding($encoding) * * @param boolean $ignoreErrors * - * @return \Leafo\ScssPhp\Compiler + * @return \ScssPhp\ScssPhp\Compiler + * + * @deprecated Ignoring Sass errors is not longer supported. */ public function setIgnoreErrors($ignoreErrors) { - $this->ignoreErrors = $ignoreErrors; + @trigger_error('Ignoring Sass errors is not longer supported.', E_USER_DEPRECATED); return $this; } + /** + * Get source position + * + * @api + * + * @return array + */ + public function getSourcePosition() + { + $sourceFile = isset($this->sourceNames[$this->sourceIndex]) ? $this->sourceNames[$this->sourceIndex] : ''; + + return [$sourceFile, $this->sourceLine, $this->sourceColumn]; + } + /** * Throw error (exception) * @@ -4154,34 +5213,86 @@ public function setIgnoreErrors($ignoreErrors) * * @param string $msg Message with optional sprintf()-style vararg parameters * - * @throws \Leafo\ScssPhp\Exception\CompilerException + * @throws \ScssPhp\ScssPhp\Exception\CompilerException + * + * @deprecated use "error" and throw the exception in the caller instead. */ public function throwError($msg) { - if ($this->ignoreErrors) { - return; + @trigger_error( + 'The method "throwError" is deprecated. Use "error" and throw the exception in the caller instead', + E_USER_DEPRECATED + ); + + throw $this->error(...func_get_args()); + } + + /** + * Build an error (exception) + * + * @api + * + * @param string $msg Message with optional sprintf()-style vararg parameters + * + * @return CompilerException + */ + public function error($msg, ...$args) + { + if ($args) { + $msg = sprintf($msg, ...$args); } - $line = $this->sourceLine; - $column = $this->sourceColumn; + if (! $this->ignoreCallStackMessage) { + $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"; + + $msg = "$msg: $loc"; - $loc = isset($this->sourceNames[$this->sourceIndex]) - ? $this->sourceNames[$this->sourceIndex] . " on line $line, at column $column" - : "line: $line, column: $column"; + $callStackMsg = $this->callStackMessage(); - if (func_num_args() > 1) { - $msg = call_user_func_array('sprintf', func_get_args()); + if ($callStackMsg) { + $msg .= "\nCall Stack:\n" . $callStackMsg; + } } - $msg = "$msg: $loc"; + return new CompilerException($msg); + } + + /** + * @param string $functionName + * @param array $ExpectedArgs + * @param int $nbActual + * @return CompilerException + */ + public function errorArgsNumber($functionName, $ExpectedArgs, $nbActual) + { + $nbExpected = \count($ExpectedArgs); - $callStackMsg = $this->callStackMessage(); + if ($nbActual > $nbExpected) { + return $this->error( + 'Error: Only %d arguments allowed in %s(), but %d were passed.', + $nbExpected, + $functionName, + $nbActual + ); + } else { + $missing = []; - if ($callStackMsg) { - $msg .= "\nCall Stack:\n" . $callStackMsg; - } + while (count($ExpectedArgs) && count($ExpectedArgs) > $nbActual) { + array_unshift($missing, array_pop($ExpectedArgs)); + } - throw new CompilerException($msg); + return $this->error( + 'Error: %s() argument%s %s missing.', + $functionName, + count($missing) > 1 ? 's' : '', + implode(', ', $missing) + ); + } } /** @@ -4200,14 +5311,15 @@ protected function callStackMessage($all = false, $limit = null) if ($this->callStack) { foreach (array_reverse($this->callStack) as $call) { if ($all || (isset($call['n']) && $call['n'])) { - $msg = "#" . $ncall++ . " " . $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]; + $msg .= ' on line ' . $call[Parser::SOURCE_LINE]; + $callStackMsg[] = $msg; - if (! is_null($limit) && $ncall>$limit) { + if (! \is_null($limit) && $ncall > $limit) { break; } } @@ -4227,113 +5339,99 @@ protected function callStackMessage($all = false, $limit = null) protected function handleImportLoop($name) { for ($env = $this->env; $env; $env = $env->parent) { + if (! $env->block) { + continue; + } + $file = $this->sourceNames[$env->block->sourceIndex]; if (realpath($file) === $name) { - $this->throwError('An @import loop has been found: %s imports %s', $file, basename($file)); - break; + throw $this->error('An @import loop has been found: %s imports %s', $file, basename($file)); } } } - /** - * Does file exist? - * - * @param string $name - * - * @return boolean - */ - protected function fileExists($name) - { - return file_exists($name) && is_file($name); - } - /** * Call SCSS @function * - * @param string $name + * @param Object $func * @param array $argValues - * @param array $returnValue * - * @return boolean Returns true if returnValue is set; otherwise, false + * @return array $returnValue */ - protected function callScssFunction($name, $argValues, &$returnValue) + protected function callScssFunction($func, $argValues) { - $func = $this->get(static::$namespaces['function'] . $name, false); - if (! $func) { - return false; + return static::$defaultValue; } + $name = $func->name; $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 = new OutputBlock(); $tmp->lines = []; $tmp->children = []; $this->env->marker = 'function'; - $ret = $this->compileChildren($func->children, $tmp, $this->env->marker . " " . $name); + if (! empty($func->parentEnv)) { + $this->env->declarationScopeParent = $func->parentEnv; + } else { + throw $this->error("@function $name() without parentEnv"); + } - $this->storeEnv = $storeEnv; + $ret = $this->compileChildren($func->children, $tmp, $this->env->marker . ' ' . $name); $this->popEnv(); - $returnValue = ! isset($ret) ? static::$defaultValue : $ret; - - return true; + return ! isset($ret) ? static::$defaultValue : $ret; } /** * Call built-in and registered (PHP) functions * * @param string $name + * @param string|array $function + * @param array $prototype * @param array $args - * @param array $returnValue * - * @return boolean Returns true if returnValue is set; otherwise, false + * @return array */ - protected function callNativeFunction($name, $args, &$returnValue) + protected function callNativeFunction($name, $function, $prototype, $args) { - // try a lib function - $name = $this->normalizeName($name); + $libName = (is_array($function) ? end($function) : null); + $sorted_kwargs = $this->sortNativeFunctionArgs($libName, $prototype, $args); - if (isset($this->userFunctions[$name])) { - // see if we can find a user function - 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 { - return false; + if (\is_null($sorted_kwargs)) { + return null; } - - @list($sorted, $kwargs) = $this->sortArgs($prototype, $args); + @list($sorted, $kwargs) = $sorted_kwargs; if ($name !== 'if' && $name !== 'call') { + $inExp = true; + + if ($name === 'join') { + $inExp = false; + } + foreach ($sorted as &$val) { - $val = $this->reduce($val, true); + $val = $this->reduce($val, $inExp); } } - $returnValue = call_user_func($f, $sorted, $kwargs); + $returnValue = \call_user_func($function, $sorted, $kwargs); if (! isset($returnValue)) { - return false; + return null; } - $returnValue = $this->coerceValue($returnValue); - - return true; + return $this->coerceValue($returnValue); } /** @@ -4345,6 +5443,18 @@ protected function callNativeFunction($name, $args, &$returnValue) */ protected function getBuiltinFunction($name) { + $libName = self::normalizeNativeFunctionName($name); + return [$this, $libName]; + } + + /** + * Normalize native function name + * @param $name + * @return string + */ + public static function normalizeNativeFunctionName($name) + { + $name = str_replace("-", "_", $name); $libName = 'lib' . preg_replace_callback( '/_(.)/', function ($m) { @@ -4352,69 +5462,210 @@ function ($m) { }, ucfirst($name) ); + return $libName; + } - return [$this, $libName]; + /** + * Check if a function is a native built-in scss function, for css parsing + * @param $name + * @return bool + */ + public static function isNativeFunction($name) + { + return method_exists(Compiler::class, self::normalizeNativeFunctionName($name)); } /** * Sorts keyword arguments * - * @param array $prototype - * @param array $args + * @param string $functionName + * @param array $prototypes + * @param array $args * - * @return array + * @return array|null */ - protected function sortArgs($prototype, $args) + protected function sortNativeFunctionArgs($functionName, $prototypes, $args) { - $keyArgs = []; - $posArgs = []; + static $parser = null; - // separate positional and keyword arguments - foreach ($args as $arg) { - list($key, $value) = $arg; + if (! isset($prototypes)) { + $keyArgs = []; + $posArgs = []; - $key = $key[1]; + if (\is_array($args) && \count($args) && \end($args) === static::$null) { + array_pop($args); + } - if (empty($key)) { - $posArgs[] = empty($arg[2]) ? $value : $arg; - } else { - $keyArgs[$key] = $value; + // separate positional and keyword arguments + foreach ($args as $arg) { + list($key, $value) = $arg; + + if (empty($key) or empty($key[1])) { + $posArgs[] = empty($arg[2]) ? $value : $arg; + } else { + $keyArgs[$key[1]] = $value; + } } - } - if (! isset($prototype)) { return [$posArgs, $keyArgs]; } - // copy positional args - $finalArgs = array_pad($posArgs, count($prototype), null); + // specific cases ? + if (\in_array($functionName, ['libRgb', 'libRgba', 'libHsl', 'libHsla'])) { + // notation 100 127 255 / 0 is in fact a simple list of 4 values + foreach ($args as $k => $arg) { + if ($arg[1][0] === Type::T_LIST && \count($arg[1][2]) === 3) { + $last = end($arg[1][2]); - // overwrite positional args with keyword args - foreach ($prototype as $i => $names) { - foreach ((array) $names as $name) { - if (isset($keyArgs[$name])) { - $finalArgs[$i] = $keyArgs[$name]; + if ($last[0] === Type::T_EXPRESSION && $last[1] === '/') { + array_pop($arg[1][2]); + $arg[1][2][] = $last[2]; + $arg[1][2][] = $last[3]; + $args[$k] = $arg; + } } } } + $finalArgs = []; + + if (! \is_array(reset($prototypes))) { + $prototypes = [$prototypes]; + } + + $keyArgs = []; + + // trying each prototypes + $prototypeHasMatch = false; + $exceptionMessage = ''; + + foreach ($prototypes as $prototype) { + $argDef = []; + + foreach ($prototype as $i => $p) { + $default = null; + $p = explode(':', $p, 2); + $name = array_shift($p); + + if (\count($p)) { + $p = trim(reset($p)); + + if ($p === 'null') { + // differentiate this null from the static::$null + $default = [Type::T_KEYWORD, 'null']; + } else { + if (\is_null($parser)) { + $parser = $this->parserFactory(__METHOD__); + } + + $parser->parseValue($p, $default); + } + } + + $isVariable = false; + + if (substr($name, -3) === '...') { + $isVariable = true; + $name = substr($name, 0, -3); + } + + $argDef[] = [$name, $default, $isVariable]; + } + + $ignoreCallStackMessage = $this->ignoreCallStackMessage; + $this->ignoreCallStackMessage = true; + + try { + if (\count($args) > \count($argDef)) { + $lastDef = end($argDef); + + // check that last arg is not a ... + if (empty($lastDef[2])) { + throw $this->errorArgsNumber($functionName, $argDef, \count($args)); + } + } + $vars = $this->applyArguments($argDef, $args, false, false); + + // ensure all args are populated + foreach ($prototype as $i => $p) { + $name = explode(':', $p)[0]; + + if (! isset($finalArgs[$i])) { + $finalArgs[$i] = null; + } + } + + // apply positional args + foreach (array_values($vars) as $i => $val) { + $finalArgs[$i] = $val; + } + + $keyArgs = array_merge($keyArgs, $vars); + $prototypeHasMatch = true; + + // overwrite positional args with keyword args + foreach ($prototype as $i => $p) { + $name = explode(':', $p)[0]; + + if (isset($keyArgs[$name])) { + $finalArgs[$i] = $keyArgs[$name]; + } + + // special null value as default: translate to real null here + if ($finalArgs[$i] === [Type::T_KEYWORD, 'null']) { + $finalArgs[$i] = null; + } + } + // should we break if this prototype seems fulfilled? + } catch (CompilerException $e) { + $exceptionMessage = $e->getMessage(); + } + $this->ignoreCallStackMessage = $ignoreCallStackMessage; + } + + if ($exceptionMessage && ! $prototypeHasMatch) { + if (\in_array($functionName, ['libRgb', 'libRgba', 'libHsl', 'libHsla'])) { + // if var() or calc() is used as an argument, return as a css function + foreach ($args as $arg) { + if ($arg[1][0] === Type::T_FUNCTION_CALL && in_array($arg[1][1], ['var'])) { + return null; + } + } + } + + throw $this->error($exceptionMessage); + } + return [$finalArgs, $keyArgs]; } /** * Apply argument values per definition * - * @param array $argDef - * @param array $argValues + * @param array $argDef + * @param array $argValues + * @param boolean $storeInEnv + * @param boolean $reduce + * only used if $storeInEnv = false + * + * @return array * * @throws \Exception */ - protected function applyArguments($argDef, $argValues) + protected function applyArguments($argDef, $argValues, $storeInEnv = true, $reduce = true) { - $storeEnv = $this->getStoreEnv(); + $output = []; + + if (\is_array($argValues) && \count($argValues) && end($argValues) === static::$null) { + array_pop($argValues); + } + + if ($storeInEnv) { + $storeEnv = $this->getStoreEnv(); - $env = new Environment; - $env->store = $storeEnv->store; + $env = new Environment(); + $env->store = $storeEnv->store; + } $hasVariable = false; $args = []; @@ -4426,37 +5677,66 @@ protected function applyArguments($argDef, $argValues) $hasVariable |= $isVariable; } - $keywordArgs = []; + $splatSeparator = null; + $keywordArgs = []; $deferredKeywordArgs = []; - $remaining = []; + $deferredNamedKeywordArgs = []; + $remaining = []; + $hasKeywordArgument = false; // assign the keyword args foreach ((array) $argValues as $arg) { if (! empty($arg[0])) { - if (! isset($args[$arg[0][1]])) { + $hasKeywordArgument = true; + + $name = $arg[0][1]; + + if (! isset($args[$name])) { + foreach (array_keys($args) as $an) { + if (str_replace('_', '-', $an) === str_replace('_', '-', $name)) { + $name = $an; + break; + } + } + } + + if (! isset($args[$name]) || $args[$name][3]) { if ($hasVariable) { - $deferredKeywordArgs[$arg[0][1]] = $arg[1]; + $deferredNamedKeywordArgs[$name] = $arg[1]; } else { - $this->throwError("Mixin or function doesn't have an argument named $%s.", $arg[0][1]); - break; + throw $this->error("Mixin or function doesn't have an argument named $%s.", $arg[0][1]); } - } 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; + } elseif ($args[$name][0] < \count($remaining)) { + throw $this->error("The argument $%s was passed both by position and by name.", $arg[0][1]); } else { - $keywordArgs[$arg[0][1]] = $arg[1]; + $keywordArgs[$name] = $arg[1]; } - } elseif (count($keywordArgs)) { - $this->throwError('Positional arguments must come before keyword arguments.'); - break; - } elseif ($arg[2] === true) { + } elseif (! empty($arg[2])) { + // $arg[2] means a var followed by ... in the arg ($list... ) $val = $this->reduce($arg[1], true); if ($val[0] === Type::T_LIST) { foreach ($val[2] as $name => $item) { if (! is_numeric($name)) { - $keywordArgs[$name] = $item; + if (! isset($args[$name])) { + foreach (array_keys($args) as $an) { + if (str_replace('_', '-', $an) === str_replace('_', '-', $name)) { + $name = $an; + break; + } + } + } + + if ($hasVariable) { + $deferredKeywordArgs[$name] = $item; + } else { + $keywordArgs[$name] = $item; + } } else { + if (\is_null($splatSeparator)) { + $splatSeparator = $val[1]; + } + $remaining[] = $item; } } @@ -4466,14 +5746,33 @@ protected function applyArguments($argDef, $argValues) $item = $val[2][$i]; if (! is_numeric($name)) { - $keywordArgs[$name] = $item; + if (! isset($args[$name])) { + foreach (array_keys($args) as $an) { + if (str_replace('_', '-', $an) === str_replace('_', '-', $name)) { + $name = $an; + break; + } + } + } + + if ($hasVariable) { + $deferredKeywordArgs[$name] = $item; + } else { + $keywordArgs[$name] = $item; + } } else { + if (\is_null($splatSeparator)) { + $splatSeparator = $val[1]; + } + $remaining[] = $item; } } } else { $remaining[] = $val; } + } elseif ($hasKeywordArgument) { + throw $this->error('Positional arguments must come before keyword arguments.'); } else { $remaining[] = $arg[1]; } @@ -4483,15 +5782,27 @@ protected function applyArguments($argDef, $argValues) list($i, $name, $default, $isVariable) = $arg; if ($isVariable) { - $val = [Type::T_LIST, ',', [], $isVariable]; + // only if more than one arg : can not be passed as position and value + // see https://github.com/sass/libsass/issues/2927 + if (count($args) > 1) { + if (isset($remaining[$i]) && isset($deferredNamedKeywordArgs[$name])) { + throw $this->error("The argument $%s was passed both by position and by name.", $name); + } + } - for ($count = count($remaining); $i < $count; $i++) { + $val = [Type::T_LIST, \is_null($splatSeparator) ? ',' : $splatSeparator , [], $isVariable]; + + for ($count = \count($remaining); $i < $count; $i++) { $val[2][] = $remaining[$i]; } foreach ($deferredKeywordArgs as $itemName => $item) { $val[2][$itemName] = $item; } + + foreach ($deferredNamedKeywordArgs as $itemName => $item) { + $val[2][$itemName] = $item; + } } elseif (isset($remaining[$i])) { $val = $remaining[$i]; } elseif (isset($keywordArgs[$name])) { @@ -4499,14 +5810,19 @@ protected function applyArguments($argDef, $argValues) } elseif (! empty($default)) { continue; } else { - $this->throwError("Missing argument $name"); - break; + throw $this->error("Missing argument $name"); } - $this->set($name, $this->reduce($val, true), true, $env); + if ($storeInEnv) { + $this->set($name, $this->reduce($val, true), true, $env); + } else { + $output[$name] = ($reduce ? $this->reduce($val, true) : $val); + } } - $storeEnv->store = $env->store; + if ($storeInEnv) { + $storeEnv->store = $env->store; + } foreach ($args as $arg) { list($i, $name, $default, $isVariable) = $arg; @@ -4515,8 +5831,14 @@ protected function applyArguments($argDef, $argValues) continue; } - $this->set($name, $this->reduce($default, true), true); + if ($storeInEnv) { + $this->set($name, $this->reduce($default, true), true); + } else { + $output[$name] = ($reduce ? $this->reduce($default, true) : $default); + } } + + return $output; } /** @@ -4524,19 +5846,19 @@ protected function applyArguments($argDef, $argValues) * * @param mixed $value * - * @return array|\Leafo\ScssPhp\Node\Number + * @return array|\ScssPhp\ScssPhp\Node\Number */ protected function coerceValue($value) { - if (is_array($value) || $value instanceof \ArrayAccess) { + if (\is_array($value) || $value instanceof \ArrayAccess) { return $value; } - if (is_bool($value)) { + if (\is_bool($value)) { return $this->toBool($value); } - if ($value === null) { + if (\is_null($value)) { return static::$null; } @@ -4548,30 +5870,14 @@ protected function coerceValue($value) 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; - } - } + $value = [Type::T_KEYWORD, $value]; + $color = $this->coerceColor($value); + if ($color) { return $color; } - return [Type::T_KEYWORD, $value]; + return $value; } /** @@ -4587,24 +5893,34 @@ protected function coerceMap($item) return $item; } - if ($item === static::$emptyList) { + if ( + $item[0] === static::$emptyList[0] && + $item[1] === static::$emptyList[1] && + $item[2] === static::$emptyList[2] + ) { return static::$emptyMap; } - return [Type::T_MAP, [$item], [static::$null]]; + return $item; } /** * Coerce something to list * - * @param array $item - * @param string $delim + * @param array $item + * @param string $delim + * @param boolean $removeTrailingNull * * @return array */ - protected function coerceList($item, $delim = ',') + protected function coerceList($item, $delim = ',', $removeTrailingNull = false) { if (isset($item) && $item[0] === Type::T_LIST) { + // remove trailing null from the list + if ($removeTrailingNull && end($item[2]) === static::$null) { + array_pop($item[2]); + } + return $item; } @@ -4613,21 +5929,33 @@ protected function coerceList($item, $delim = ',') $values = $item[2]; $list = []; - for ($i = 0, $s = count($keys); $i < $s; $i++) { + for ($i = 0, $s = \count($keys); $i < $s; $i++) { $key = $keys[$i]; $value = $values[$i]; + switch ($key[0]) { + case Type::T_LIST: + case Type::T_MAP: + case Type::T_STRING: + case Type::T_NULL: + break; + + default: + $key = [Type::T_KEYWORD, $this->compileStringContent($this->coerceString($key))]; + break; + } + $list[] = [ Type::T_LIST, '', - [[Type::T_KEYWORD, $this->compileStringContent($this->coerceString($key))], $value] + [$key, $value] ]; } return [Type::T_LIST, ',', $list]; } - return [Type::T_LIST, $delim, ! isset($item) ? []: [$item]]; + return [Type::T_LIST, $delim, ! isset($item) ? [] : [$item]]; } /** @@ -4653,21 +5981,107 @@ protected function coerceForExpression($value) * * @return array|null */ - protected function coerceColor($value) + protected function coerceColor($value, $inRGBFunction = false) { switch ($value[0]) { case Type::T_COLOR: + for ($i = 1; $i <= 3; $i++) { + if (! is_numeric($value[$i])) { + $cv = $this->compileRGBAValue($value[$i]); + + if (! is_numeric($cv)) { + return null; + } + + $value[$i] = $cv; + } + + if (isset($value[4])) { + if (! is_numeric($value[4])) { + $cv = $this->compileRGBAValue($value[4], true); + + if (! is_numeric($cv)) { + return null; + } + + $value[4] = $cv; + } + } + } + return $value; + case Type::T_LIST: + if ($inRGBFunction) { + if (\count($value[2]) == 3 || \count($value[2]) == 4) { + $color = $value[2]; + array_unshift($color, Type::T_COLOR); + + return $this->coerceColor($color); + } + } + + return null; + case Type::T_KEYWORD: + if (! \is_string($value[1])) { + return null; + } + $name = strtolower($value[1]); - if (isset(Colors::$cssColors[$name])) { - $rgba = explode(',', Colors::$cssColors[$name]); + // hexa color? + if (preg_match('/^#([0-9a-f]+)$/i', $name, $m)) { + $nofValues = \strlen($m[1]); + + if (\in_array($nofValues, [3, 4, 6, 8])) { + $nbChannels = 3; + $color = []; + $num = hexdec($m[1]); + + switch ($nofValues) { + case 4: + $nbChannels = 4; + // then continuing with the case 3: + case 3: + for ($i = 0; $i < $nbChannels; $i++) { + $t = $num & 0xf; + array_unshift($color, $t << 4 | $t); + $num >>= 4; + } + + break; + + case 8: + $nbChannels = 4; + // then continuing with the case 6: + case 6: + for ($i = 0; $i < $nbChannels; $i++) { + array_unshift($color, $num & 0xff); + $num >>= 8; + } + + break; + } + + if ($nbChannels === 4) { + if ($color[3] === 255) { + $color[3] = 1; // fully opaque + } else { + $color[3] = round($color[3] / 255, Node\Number::PRECISION); + } + } + + array_unshift($color, Type::T_COLOR); + + return $color; + } + } + if ($rgba = Colors::colorNameToRGBa($name)) { return isset($rgba[3]) - ? [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]]; + ? [Type::T_COLOR, $rgba[0], $rgba[1], $rgba[2], $rgba[3]] + : [Type::T_COLOR, $rgba[0], $rgba[1], $rgba[2]]; } return null; @@ -4676,6 +6090,88 @@ protected function coerceColor($value) return null; } + /** + * @param integer|\ScssPhp\ScssPhp\Node\Number $value + * @param boolean $isAlpha + * + * @return integer|mixed + */ + protected function compileRGBAValue($value, $isAlpha = false) + { + if ($isAlpha) { + return $this->compileColorPartValue($value, 0, 1, false); + } + + return $this->compileColorPartValue($value, 0, 255, true); + } + + /** + * @param mixed $value + * @param integer|float $min + * @param integer|float $max + * @param boolean $isInt + * @param boolean $clamp + * @param boolean $modulo + * + * @return integer|mixed + */ + protected function compileColorPartValue($value, $min, $max, $isInt = true, $clamp = true, $modulo = false) + { + if (! is_numeric($value)) { + if (\is_array($value)) { + $reduced = $this->reduce($value); + + if (\is_object($reduced) && $value->type === Type::T_NUMBER) { + $value = $reduced; + } + } + + if (\is_object($value) && $value->type === Type::T_NUMBER) { + $num = $value->dimension; + + if (\count($value->units)) { + $unit = array_keys($value->units); + $unit = reset($unit); + + switch ($unit) { + case '%': + $num *= $max / 100; + break; + default: + break; + } + } + + $value = $num; + } elseif (\is_array($value)) { + $value = $this->compileValue($value); + } + } + + if (is_numeric($value)) { + if ($isInt) { + $value = round($value); + } + + if ($clamp) { + $value = min($max, max($min, $value)); + } + + if ($modulo) { + $value = $value % $max; + + // still negative? + while ($value < $min) { + $value += $max; + } + } + + return $value; + } + + return $value; + } + /** * Coerce value to string * @@ -4692,6 +6188,36 @@ protected function coerceString($value) return [Type::T_STRING, '', [$this->compileValue($value)]]; } + /** + * Assert value is a string (or keyword) + * + * @api + * + * @param array $value + * @param string $varName + * + * @return array + * + * @throws \Exception + */ + public function assertString($value, $varName = null) + { + // case of url(...) parsed a a function + if ($value[0] === Type::T_FUNCTION) { + $value = $this->coerceString($value); + } + + if (! \in_array($value[0], [Type::T_STRING, Type::T_KEYWORD])) { + $value = $this->compileValue($value); + $var_display = ($varName ? " \${$varName}:" : ''); + throw $this->error("Error:{$var_display} $value is not a string."); + } + + $value = $this->coerceString($value); + + return $value; + } + /** * Coerce value to a percentage * @@ -4728,7 +6254,7 @@ public function assertMap($value) $value = $this->coerceMap($value); if ($value[0] !== Type::T_MAP) { - $this->throwError('expecting map, %s received', $value[0]); + throw $this->error('expecting map, %s received', $value[0]); } return $value; @@ -4748,7 +6274,7 @@ public function assertMap($value) public function assertList($value) { if ($value[0] !== Type::T_LIST) { - $this->throwError('expecting list, %s received', $value[0]); + throw $this->error('expecting list, %s received', $value[0]); } return $value; @@ -4771,7 +6297,7 @@ public function assertColor($value) return $color; } - $this->throwError('expecting color, %s received', $value[0]); + throw $this->error('expecting color, %s received', $value[0]); } /** @@ -4780,20 +6306,48 @@ public function assertColor($value) * @api * * @param array $value + * @param string $varName * * @return integer|float * * @throws \Exception */ - public function assertNumber($value) + public function assertNumber($value, $varName = null) { if ($value[0] !== Type::T_NUMBER) { - $this->throwError('expecting number, %s received', $value[0]); + $value = $this->compileValue($value); + $var_display = ($varName ? " \${$varName}:" : ''); + throw $this->error("Error:{$var_display} $value is not a number."); } return $value[1]; } + /** + * Assert value is a integer + * + * @api + * + * @param array $value + * @param string $varName + * + * @return integer|float + * + * @throws \Exception + */ + public function assertInteger($value, $varName = null) + { + + $value = $this->assertNumber($value, $varName); + if (round($value - \intval($value), Node\Number::PRECISION) > 0) { + $var_display = ($varName ? " \${$varName}:" : ''); + throw $this->error("Error:{$var_display} $value is not an integer."); + } + + return intval($value); + } + + /** * Make sure a color's components don't go out of bounds * @@ -4882,7 +6436,7 @@ protected function hueToRGB($m1, $m2, $h) } if ($h * 3 < 2) { - return $m1 + ($m2 - $m1) * (2/3 - $h) * 6; + return $m1 + ($m2 - $m1) * (2 / 3 - $h) * 6; } return $m1; @@ -4912,9 +6466,9 @@ public function toRGB($hue, $saturation, $lightness) $m2 = $l <= 0.5 ? $l * ($s + 1) : $l + $s - $l * $s; $m1 = $l * 2 - $m2; - $r = $this->hueToRGB($m1, $m2, $h + 1/3) * 255; + $r = $this->hueToRGB($m1, $m2, $h + 1 / 3) * 255; $g = $this->hueToRGB($m1, $m2, $h) * 255; - $b = $this->hueToRGB($m1, $m2, $h - 1/3) * 255; + $b = $this->hueToRGB($m1, $m2, $h - 1 / 3) * 255; $out = [Type::T_COLOR, $r, $g, $b]; @@ -4923,46 +6477,66 @@ public function toRGB($hue, $saturation, $lightness) // Built in functions - //protected static $libCall = ['name', 'args...']; + protected static $libCall = ['function', 'args...']; protected function libCall($args, $kwargs) { - $name = $this->compileStringContent($this->coerceString($this->reduce(array_shift($args), true))); + $functionReference = $this->reduce(array_shift($args), true); - $posArgs = []; + if (in_array($functionReference[0], [Type::T_STRING, Type::T_KEYWORD])) { + $name = $this->compileStringContent($this->coerceString($this->reduce($functionReference, true))); + $warning = "DEPRECATION WARNING: Passing a string to call() is deprecated and will be illegal\n" + . "in Sass 4.0. Use call(function-reference($name)) instead."; + fwrite($this->stderr, "$warning\n\n"); + $functionReference = $this->libGetFunction([$functionReference]); + } - foreach ($args as $arg) { - if (empty($arg[0])) { - if ($arg[2] === true) { - $tmp = $this->reduce($arg[1]); + if ($functionReference === static::$null) { + return static::$null; + } - if ($tmp[0] === Type::T_LIST) { - foreach ($tmp[2] as $item) { - $posArgs[] = [null, $item, false]; - } - } else { - $posArgs[] = [null, $tmp, true]; - } + if (! in_array($functionReference[0], [Type::T_FUNCTION_REFERENCE, Type::T_FUNCTION])) { + throw $this->error('Function reference expected, got ' . $functionReference[0]); + } - continue; - } + $callArgs = []; - $posArgs[] = [null, $this->reduce($arg), false]; - continue; + // $kwargs['args'] is [Type::T_LIST, ',', [..]] + foreach ($kwargs['args'][2] as $varname => $arg) { + if (is_numeric($varname)) { + $varname = null; + } else { + $varname = [ 'var', $varname]; } - $posArgs[] = [null, $arg, false]; + $callArgs[] = [$varname, $arg, false]; } - if (count($kwargs)) { - foreach ($kwargs as $key => $value) { - $posArgs[] = [[Type::T_VARIABLE, $key], $value, false]; - } + return $this->reduce([Type::T_FUNCTION_CALL, $functionReference, $callArgs]); + } + + + protected static $libGetFunction = [ + ['name'], + ['name', 'css'] + ]; + protected function libGetFunction($args) + { + $name = $this->compileStringContent($this->coerceString($this->reduce(array_shift($args), true))); + $isCss = false; + + if (count($args)) { + $isCss = $this->reduce(array_shift($args), true); + $isCss = (($isCss === static::$true) ? true : false); + } + + if ($isCss) { + return [Type::T_FUNCTION, $name, [Type::T_LIST, ',', []]]; } - return $this->reduce([Type::T_FUNCTION_CALL, $name, $posArgs]); + return $this->getFunctionReference($name, true); } - protected static $libIf = ['condition', 'if-true', 'if-false']; + protected static $libIf = ['condition', 'if-true', 'if-false:']; protected function libIf($args) { list($cond, $t, $f) = $args; @@ -4979,11 +6553,8 @@ protected function libIndex($args) { list($list, $value) = $args; - if ($value[0] === Type::T_MAP) { - return static::$null; - } - - if ($list[0] === Type::T_MAP || + if ( + $list[0] === Type::T_MAP || $list[0] === Type::T_STRING || $list[0] === Type::T_KEYWORD || $list[0] === Type::T_INTERPOLATE @@ -5006,30 +6577,68 @@ protected function libIndex($args) return false === $key ? static::$null : $key + 1; } - protected static $libRgb = ['red', 'green', 'blue']; - protected function libRgb($args) + protected static $libRgb = [ + ['color'], + ['color', 'alpha'], + ['channels'], + ['red', 'green', 'blue'], + ['red', 'green', 'blue', 'alpha'] ]; + protected function libRgb($args, $kwargs, $funcName = 'rgb') { - list($r, $g, $b) = $args; + switch (\count($args)) { + case 1: + if (! $color = $this->coerceColor($args[0], true)) { + $color = [Type::T_STRING, '', [$funcName . '(', $args[0], ')']]; + } + break; - return [Type::T_COLOR, $r[1], $g[1], $b[1]]; - } + case 3: + $color = [Type::T_COLOR, $args[0], $args[1], $args[2]]; - protected static $libRgba = [ - ['red', 'color'], - 'green', 'blue', 'alpha']; - protected function libRgba($args) - { - if ($color = $this->coerceColor($args[0])) { - $num = isset($args[3]) ? $args[3] : $args[1]; - $alpha = $this->assertNumber($num); - $color[4] = $alpha; + if (! $color = $this->coerceColor($color)) { + $color = [Type::T_STRING, '', [$funcName . '(', $args[0], ', ', $args[1], ', ', $args[2], ')']]; + } - return $color; + return $color; + + case 2: + if ($color = $this->coerceColor($args[0], true)) { + $alpha = $this->compileRGBAValue($args[1], true); + + if (is_numeric($alpha)) { + $color[4] = $alpha; + } else { + $color = [Type::T_STRING, '', + [$funcName . '(', $color[1], ', ', $color[2], ', ', $color[3], ', ', $alpha, ')']]; + } + } else { + $color = [Type::T_STRING, '', [$funcName . '(', $args[0], ')']]; + } + break; + + case 4: + default: + $color = [Type::T_COLOR, $args[0], $args[1], $args[2], $args[3]]; + + if (! $color = $this->coerceColor($color)) { + $color = [Type::T_STRING, '', + [$funcName . '(', $args[0], ', ', $args[1], ', ', $args[2], ', ', $args[3], ')']]; + } + break; } - list($r, $g, $b, $a) = $args; + return $color; + } - return [Type::T_COLOR, $r[1], $g[1], $b[1], $a[1]]; + protected static $libRgba = [ + ['color'], + ['color', 'alpha'], + ['channels'], + ['red', 'green', 'blue'], + ['red', 'green', 'blue', 'alpha'] ]; + protected function libRgba($args, $kwargs) + { + return $this->libRgb($args, $kwargs, 'rgba'); } // helper function for adjust_color, change_color, and scale_color @@ -5037,21 +6646,25 @@ protected function alterColor($args, $fn) { $color = $this->assertColor($args[0]); - foreach ([1, 2, 3, 7] as $i) { - if (isset($args[$i])) { - $val = $this->assertNumber($args[$i]); - $ii = $i === 7 ? 4 : $i; // alpha - $color[$ii] = call_user_func($fn, isset($color[$ii]) ? $color[$ii] : 0, $val, $i); + foreach ([1 => 1, 2 => 2, 3 => 3, 7 => 4] as $iarg => $irgba) { + if (isset($args[$iarg])) { + $val = $this->assertNumber($args[$iarg]); + + if (! isset($color[$irgba])) { + $color[$irgba] = (($irgba < 4) ? 0 : 1); + } + + $color[$irgba] = \call_user_func($fn, $color[$irgba], $val, $iarg); } } - if (isset($args[4]) || isset($args[5]) || isset($args[6])) { + if (! empty($args[4]) || ! empty($args[5]) || ! empty($args[6])) { $hsl = $this->toHSL($color[1], $color[2], $color[3]); - 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); + foreach ([4 => 1, 5 => 2, 6 => 3] as $iarg => $ihsl) { + if (! empty($args[$iarg])) { + $val = $this->assertNumber($args[$iarg]); + $hsl[$ihsl] = \call_user_func($fn, $hsl[$ihsl], $val, $iarg); } } @@ -5068,8 +6681,8 @@ protected function alterColor($args, $fn) } protected static $libAdjustColor = [ - 'color', 'red', 'green', 'blue', - 'hue', 'saturation', 'lightness', 'alpha' + 'color', 'red:null', 'green:null', 'blue:null', + 'hue:null', 'saturation:null', 'lightness:null', 'alpha:null' ]; protected function libAdjustColor($args) { @@ -5079,8 +6692,8 @@ protected function libAdjustColor($args) } protected static $libChangeColor = [ - 'color', 'red', 'green', 'blue', - 'hue', 'saturation', 'lightness', 'alpha' + 'color', 'red:null', 'green:null', 'blue:null', + 'hue:null', 'saturation:null', 'lightness:null', 'alpha:null' ]; protected function libChangeColor($args) { @@ -5090,8 +6703,8 @@ protected function libChangeColor($args) } protected static $libScaleColor = [ - 'color', 'red', 'green', 'blue', - 'hue', 'saturation', 'lightness', 'alpha' + 'color', 'red:null', 'green:null', 'blue:null', + 'hue:null', 'saturation:null', 'lightness:null', 'alpha:null' ]; protected function libScaleColor($args) { @@ -5132,9 +6745,14 @@ protected function libScaleColor($args) protected function libIeHexStr($args) { $color = $this->coerceColor($args[0]); + + if (\is_null($color)) { + $this->throwError('Error: argument `$color` of `ie-hex-str($color)` must be a color'); + } + $color[4] = isset($color[4]) ? round(255 * $color[4]) : 255; - return sprintf('#%02X%02X%02X%02X', $color[4], $color[1], $color[2], $color[3]); + return [Type::T_STRING, '', [sprintf('#%02X%02X%02X%02X', $color[4], $color[1], $color[2], $color[3])]]; } protected static $libRed = ['color']; @@ -5142,6 +6760,10 @@ protected function libRed($args) { $color = $this->coerceColor($args[0]); + if (\is_null($color)) { + $this->throwError('Error: argument `$color` of `red($color)` must be a color'); + } + return $color[1]; } @@ -5150,6 +6772,10 @@ protected function libGreen($args) { $color = $this->coerceColor($args[0]); + if (\is_null($color)) { + $this->throwError('Error: argument `$color` of `green($color)` must be a color'); + } + return $color[2]; } @@ -5158,6 +6784,10 @@ protected function libBlue($args) { $color = $this->coerceColor($args[0]); + if (\is_null($color)) { + $this->throwError('Error: argument `$color` of `blue($color)` must be a color'); + } + return $color[3]; } @@ -5185,7 +6815,10 @@ protected function libOpacity($args) } // mix two colors - protected static $libMix = ['color-1', 'color-2', 'weight']; + protected static $libMix = [ + ['color1', 'color2', 'weight:0.5'], + ['color-1', 'color-2', 'weight:0.5'] + ]; protected function libMix($args) { list($first, $second, $weight) = $args; @@ -5221,25 +6854,85 @@ protected function libMix($args) return $this->fixColor($new); } - protected static $libHsl = ['hue', 'saturation', 'lightness']; - protected function libHsl($args) + protected static $libHsl = [ + ['channels'], + ['hue', 'saturation', 'lightness'], + ['hue', 'saturation', 'lightness', 'alpha'] ]; + protected function libHsl($args, $kwargs, $funcName = 'hsl') { - list($h, $s, $l) = $args; + $args_to_check = $args; - return $this->toRGB($h[1], $s[1], $l[1]); - } + if (\count($args) == 1) { + if ($args[0][0] !== Type::T_LIST || \count($args[0][2]) < 3 || \count($args[0][2]) > 4) { + return [Type::T_STRING, '', [$funcName . '(', $args[0], ')']]; + } - protected static $libHsla = ['hue', 'saturation', 'lightness', 'alpha']; - protected function libHsla($args) - { - list($h, $s, $l, $a) = $args; + $args = $args[0][2]; + $args_to_check = $kwargs['channels'][2]; + } + + $hue = $this->compileColorPartValue($args[0], 0, 360, false, false, true); + $saturation = $this->compileColorPartValue($args[1], 0, 100, false); + $lightness = $this->compileColorPartValue($args[2], 0, 100, false); + + foreach ($kwargs as $k => $arg) { + if (in_array($arg[0], [Type::T_FUNCTION_CALL]) && in_array($arg[1], ['min', 'max'])) { + return null; + } + } + + foreach ($args_to_check as $k => $arg) { + if (in_array($arg[0], [Type::T_FUNCTION_CALL]) && in_array($arg[1], ['min', 'max'])) { + if (count($kwargs) > 1 || ($k >= 2 && count($args) === 4)) { + return null; + } + + $args[$k] = $this->stringifyFncallArgs($arg); + $hue = ''; + } + + if ( + $k >= 2 && count($args) === 4 && + in_array($arg[0], [Type::T_FUNCTION_CALL, Type::T_FUNCTION]) && + in_array($arg[1], ['calc','env']) + ) { + return null; + } + } + + $alpha = null; + + if (\count($args) === 4) { + $alpha = $this->compileColorPartValue($args[3], 0, 100, false); + + if (! is_numeric($hue) || ! is_numeric($saturation) || ! is_numeric($lightness) || ! is_numeric($alpha)) { + return [Type::T_STRING, '', + [$funcName . '(', $args[0], ', ', $args[1], ', ', $args[2], ', ', $args[3], ')']]; + } + } else { + if (! is_numeric($hue) || ! is_numeric($saturation) || ! is_numeric($lightness)) { + return [Type::T_STRING, '', [$funcName . '(', $args[0], ', ', $args[1], ', ', $args[2], ')']]; + } + } - $color = $this->toRGB($h[1], $s[1], $l[1]); - $color[4] = $a[1]; + $color = $this->toRGB($hue, $saturation, $lightness); + + if (! \is_null($alpha)) { + $color[4] = $alpha; + } return $color; } + protected static $libHsla = [ + ['channels'], + ['hue', 'saturation', 'lightness'], + ['hue', 'saturation', 'lightness', 'alpha']]; + protected function libHsla($args, $kwargs) + { + return $this->libHsl($args, $kwargs, 'hsla'); + } + protected static $libHue = ['color']; protected function libHue($args) { @@ -5307,7 +7000,7 @@ protected function libDarken($args) return $this->adjustHsl($color, 3, -$amount); } - protected static $libSaturate = ['color', 'amount']; + protected static $libSaturate = [['color', 'amount'], ['amount']]; protected function libSaturate($args) { $value = $args[0]; @@ -5316,6 +7009,11 @@ protected function libSaturate($args) return null; } + if (count($args) === 1) { + $val = $this->compileValue($value); + throw $this->error("\$amount: $val is not a number"); + } + $color = $this->assertColor($value); $amount = 100 * $this->coercePercent($args[1]); @@ -5349,21 +7047,32 @@ protected function libComplement($args) return $this->adjustHsl($this->assertColor($args[0]), 1, 180); } - protected static $libInvert = ['color']; + protected static $libInvert = ['color', 'weight:1']; protected function libInvert($args) { - $value = $args[0]; + list($value, $weight) = $args; + + if (! isset($weight)) { + $weight = 1; + } else { + $weight = $this->coercePercent($weight); + } if ($value[0] === Type::T_NUMBER) { return null; } $color = $this->assertColor($value); - $color[1] = 255 - $color[1]; - $color[2] = 255 - $color[2]; - $color[3] = 255 - $color[3]; + $inverted = $color; + $inverted[1] = 255 - $inverted[1]; + $inverted[2] = 255 - $inverted[2]; + $inverted[3] = 255 - $inverted[3]; - return $color; + if ($weight < 1) { + return $this->libMix([$inverted, $color, [Type::T_NUMBER, $weight]]); + } + + return $inverted; } // increases opacity by amount @@ -5428,13 +7137,13 @@ protected function libQuote($args) return [Type::T_STRING, '"', [$value]]; } - protected static $libPercentage = ['value']; + protected static $libPercentage = ['number']; protected function libPercentage($args) { return new Node\Number($this->coercePercent($args[0]) * 100, '%'); } - protected static $libRound = ['value']; + protected static $libRound = ['number']; protected function libRound($args) { $num = $args[0]; @@ -5442,7 +7151,7 @@ protected function libRound($args) return new Node\Number(round($num[1]), $num[2]); } - protected static $libFloor = ['value']; + protected static $libFloor = ['number']; protected function libFloor($args) { $num = $args[0]; @@ -5450,7 +7159,7 @@ protected function libFloor($args) return new Node\Number(floor($num[1]), $num[2]); } - protected static $libCeil = ['value']; + protected static $libCeil = ['number']; protected function libCeil($args) { $num = $args[0]; @@ -5458,7 +7167,7 @@ protected function libCeil($args) return new Node\Number(ceil($num[1]), $num[2]); } - protected static $libAbs = ['value']; + protected static $libAbs = ['number']; protected function libAbs($args) { $num = $args[0]; @@ -5469,29 +7178,47 @@ protected function libAbs($args) protected function libMin($args) { $numbers = $this->getNormalizedNumbers($args); - $min = null; + $minOriginal = null; + $minNormalized = null; + + foreach ($numbers as $key => $pair) { + list($original, $normalized) = $pair; - foreach ($numbers as $key => $number) { - if (null === $min || $number[1] <= $min[1]) { - $min = [$key, $number[1]]; + if (\is_null($normalized) || \is_null($minNormalized)) { + if (\is_null($minOriginal) || $original[1] <= $minOriginal[1]) { + $minOriginal = $original; + $minNormalized = $normalized; + } + } elseif ($normalized[1] <= $minNormalized[1]) { + $minOriginal = $original; + $minNormalized = $normalized; } } - return $args[$min[0]]; + return $minOriginal; } protected function libMax($args) { $numbers = $this->getNormalizedNumbers($args); - $max = null; + $maxOriginal = null; + $maxNormalized = null; + + foreach ($numbers as $key => $pair) { + list($original, $normalized) = $pair; - foreach ($numbers as $key => $number) { - if (null === $max || $number[1] >= $max[1]) { - $max = [$key, $number[1]]; + if (\is_null($normalized) || \is_null($maxNormalized)) { + if (\is_null($maxOriginal) || $original[1] >= $maxOriginal[1]) { + $maxOriginal = $original; + $maxNormalized = $normalized; + } + } elseif ($normalized[1] >= $maxNormalized[1]) { + $maxOriginal = $original; + $maxNormalized = $normalized; } } - return $args[$max[0]]; + return $maxOriginal; } /** @@ -5503,27 +7230,23 @@ protected function libMax($args) */ protected function getNormalizedNumbers($args) { - $unit = null; + $unit = null; $originalUnit = null; - $numbers = []; + $numbers = []; foreach ($args as $key => $item) { - if ($item[0] !== Type::T_NUMBER) { - $this->throwError('%s is not a number', $item[0]); - break; - } + $this->assertNumber($item); $number = $item->normalize(); - if (null === $unit) { + if (empty($unit)) { $unit = $number[2]; $originalUnit = $item->unitStr(); - } elseif ($number[1] && $unit !== $number[2]) { - $this->throwError('Incompatible units: "%s" and "%s".', $originalUnit, $item->unitStr()); - break; + } elseif ($number[1] && $unit !== $number[2] && ! empty($number[2])) { + throw $this->error('Incompatible units: "%s" and "%s".', $originalUnit, $item->unitStr()); } - $numbers[$key] = $number; + $numbers[$key] = [$args[$key], empty($number[2]) ? null : $number]; } return $numbers; @@ -5532,21 +7255,25 @@ protected function getNormalizedNumbers($args) protected static $libLength = ['list']; protected function libLength($args) { - $list = $this->coerceList($args[0]); + $list = $this->coerceList($args[0], ',', true); - return count($list[2]); + return \count($list[2]); } //protected static $libListSeparator = ['list...']; protected function libListSeparator($args) { - if (count($args) > 1) { + if (\count($args) > 1) { return 'comma'; } + if (! \in_array($args[0][0], [Type::T_LIST, Type::T_MAP])) { + return 'space'; + } + $list = $this->coerceList($args[0]); - if (count($list[2]) <= 1) { + if (\count($list[2]) <= 1 && empty($list['enclosing'])) { return 'space'; } @@ -5560,13 +7287,13 @@ protected function libListSeparator($args) protected static $libNth = ['list', 'n']; protected function libNth($args) { - $list = $this->coerceList($args[0]); + $list = $this->coerceList($args[0], ',', false); $n = $this->assertNumber($args[1]); if ($n > 0) { $n--; } elseif ($n < 0) { - $n += count($list[2]); + $n += \count($list[2]); } return isset($list[2][$n]) ? $list[2][$n] : static::$defaultValue; @@ -5581,13 +7308,11 @@ protected function libSetNth($args) if ($n > 0) { $n--; } elseif ($n < 0) { - $n += count($list[2]); + $n += \count($list[2]); } if (! isset($list[2][$n])) { - $this->throwError('Invalid argument for "n"'); - - return null; + throw $this->error('Invalid argument for "n"'); } $list[2][$n] = $args[2]; @@ -5599,11 +7324,15 @@ protected function libSetNth($args) protected function libMapGet($args) { $map = $this->assertMap($args[0]); - $key = $this->compileStringContent($this->coerceString($args[1])); + $key = $args[1]; - for ($i = count($map[1]) - 1; $i >= 0; $i--) { - if ($key === $this->compileStringContent($this->coerceString($map[1][$i]))) { - return $map[2][$i]; + if (! \is_null($key)) { + $key = $this->compileStringContent($this->coerceString($key)); + + for ($i = \count($map[1]) - 1; $i >= 0; $i--) { + if ($key === $this->compileStringContent($this->coerceString($map[1][$i]))) { + return $map[2][$i]; + } } } @@ -5628,14 +7357,20 @@ protected function libMapValues($args) return [Type::T_LIST, ',', $values]; } - protected static $libMapRemove = ['map', 'key']; + protected static $libMapRemove = ['map', 'key...']; protected function libMapRemove($args) { $map = $this->assertMap($args[0]); - $key = $this->compileStringContent($this->coerceString($args[1])); + $keyList = $this->assertList($args[1]); - for ($i = count($map[1]) - 1; $i >= 0; $i--) { - if ($key === $this->compileStringContent($this->coerceString($map[1][$i]))) { + $keys = []; + + foreach ($keyList[2] as $key) { + $keys[] = $this->compileStringContent($this->coerceString($key)); + } + + for ($i = \count($map[1]) - 1; $i >= 0; $i--) { + if (in_array($this->compileStringContent($this->coerceString($map[1][$i])), $keys)) { array_splice($map[1], $i, 1); array_splice($map[2], $i, 1); } @@ -5650,7 +7385,7 @@ 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--) { + for ($i = \count($map[1]) - 1; $i >= 0; $i--) { if ($key === $this->compileStringContent($this->coerceString($map[1][$i]))) { return true; } @@ -5659,7 +7394,10 @@ protected function libMapHasKey($args) return false; } - protected static $libMapMerge = ['map-1', 'map-2']; + protected static $libMapMerge = [ + ['map1', 'map2'], + ['map-1', 'map-2'] + ]; protected function libMapMerge($args) { $map1 = $this->assertMap($args[0]); @@ -5698,6 +7436,19 @@ protected function libKeywords($args) return [Type::T_MAP, $keys, $values]; } + protected static $libIsBracketed = ['list']; + protected function libIsBracketed($args) + { + $list = $args[0]; + $this->coerceList($list, ' '); + + if (! empty($list['enclosing']) && $list['enclosing'] === 'bracket') { + return true; + } + + return false; + } + protected function listSeparatorForJoin($list1, $sep) { if (! isset($sep)) { @@ -5709,60 +7460,107 @@ protected function listSeparatorForJoin($list1, $sep) return ','; case 'space': - return ''; + return ' '; default: return $list1[1]; } } - protected static $libJoin = ['list1', 'list2', 'separator']; + protected static $libJoin = ['list1', 'list2', 'separator:null', 'bracketed:auto']; protected function libJoin($args) { - list($list1, $list2, $sep) = $args; + list($list1, $list2, $sep, $bracketed) = $args; + + $list1 = $this->coerceList($list1, ' ', true); + $list2 = $this->coerceList($list2, ' ', true); + $sep = $this->listSeparatorForJoin($list1, $sep); + + if ($bracketed === static::$true) { + $bracketed = true; + } elseif ($bracketed === static::$false) { + $bracketed = false; + } elseif ($bracketed === [Type::T_KEYWORD, 'auto']) { + $bracketed = 'auto'; + } elseif ($bracketed === static::$null) { + $bracketed = false; + } else { + $bracketed = $this->compileValue($bracketed); + $bracketed = ! ! $bracketed; + + if ($bracketed === true) { + $bracketed = true; + } + } + + if ($bracketed === 'auto') { + $bracketed = false; + + if (! empty($list1['enclosing']) && $list1['enclosing'] === 'bracket') { + $bracketed = true; + } + } + + $res = [Type::T_LIST, $sep, array_merge($list1[2], $list2[2])]; + + if (isset($list1['enclosing'])) { + $res['enlcosing'] = $list1['enclosing']; + } - $list1 = $this->coerceList($list1, ' '); - $list2 = $this->coerceList($list2, ' '); - $sep = $this->listSeparatorForJoin($list1, $sep); + if ($bracketed) { + $res['enclosing'] = 'bracket'; + } - return [Type::T_LIST, $sep, array_merge($list1[2], $list2[2])]; + return $res; } - protected static $libAppend = ['list', 'val', 'separator']; + protected static $libAppend = ['list', 'val', 'separator:null']; protected function libAppend($args) { list($list1, $value, $sep) = $args; - $list1 = $this->coerceList($list1, ' '); - $sep = $this->listSeparatorForJoin($list1, $sep); + $list1 = $this->coerceList($list1, ' ', true); + $sep = $this->listSeparatorForJoin($list1, $sep); + $res = [Type::T_LIST, $sep, array_merge($list1[2], [$value])]; + + if (isset($list1['enclosing'])) { + $res['enclosing'] = $list1['enclosing']; + } - return [Type::T_LIST, $sep, array_merge($list1[2], [$value])]; + return $res; } protected function libZip($args) { - foreach ($args as $arg) { - $this->assertList($arg); + foreach ($args as $key => $arg) { + $args[$key] = $this->coerceList($arg); } $lists = []; $firstList = array_shift($args); - foreach ($firstList[2] as $key => $item) { - $list = [Type::T_LIST, '', [$item]]; + $result = [Type::T_LIST, ',', $lists]; + if (! \is_null($firstList)) { + foreach ($firstList[2] as $key => $item) { + $list = [Type::T_LIST, '', [$item]]; - foreach ($args as $arg) { - if (isset($arg[2][$key])) { - $list[2][] = $arg[2][$key]; - } else { - break 2; + foreach ($args as $arg) { + if (isset($arg[2][$key])) { + $list[2][] = $arg[2][$key]; + } else { + break 2; + } } + + $lists[] = $list; } - $lists[] = $list; + $result[2] = $lists; + } else { + $result['enclosing'] = 'parent'; } - return [Type::T_LIST, ',', $lists]; + return $result; } protected static $libTypeOf = ['value']; @@ -5784,6 +7582,9 @@ protected function libTypeOf($args) case Type::T_FUNCTION: return 'string'; + case Type::T_FUNCTION_REFERENCE: + return 'function'; + case Type::T_LIST: if (isset($value[3]) && $value[3]) { return 'arglist'; @@ -5815,17 +7616,19 @@ protected function libUnitless($args) return $value[0] === Type::T_NUMBER && $value->unitless(); } - protected static $libComparable = ['number-1', 'number-2']; + protected static $libComparable = [ + ['number1', 'number2'], + ['number-1', 'number-2'] + ]; protected function libComparable($args) { list($number1, $number2) = $args; - if (! isset($number1[0]) || $number1[0] !== Type::T_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; + throw $this->error('Invalid argument(s) for "comparable"'); } $number1 = $number1->normalize(); @@ -5837,13 +7640,17 @@ protected function libComparable($args) protected static $libStrIndex = ['string', 'substring']; protected function libStrIndex($args) { - $string = $this->coerceString($args[0]); + $string = $this->assertString($args[0], 'string'); $stringContent = $this->compileStringContent($string); - $substring = $this->coerceString($args[1]); + $substring = $this->assertString($args[1], 'substring'); $substringContent = $this->compileStringContent($substring); - $result = strpos($stringContent, $substringContent); + if (! \strlen($substringContent)) { + $result = 0; + } else { + $result = strpos($stringContent, $substringContent); + } return $result === false ? static::$null : new Node\Number($result + 1, ''); } @@ -5851,15 +7658,25 @@ protected function libStrIndex($args) protected static $libStrInsert = ['string', 'insert', 'index']; protected function libStrInsert($args) { - $string = $this->coerceString($args[0]); + $string = $this->assertString($args[0], 'string'); $stringContent = $this->compileStringContent($string); - $insert = $this->coerceString($args[1]); + $insert = $this->assertString($args[1], 'insert'); $insertContent = $this->compileStringContent($insert); - list(, $index) = $args[2]; + $index = $this->assertInteger($args[2], 'index'); + if ($index > 0) { + $index = $index - 1; + } + if ($index < 0) { + $index = Util::mbStrlen($stringContent) + 1 + $index; + } - $string[2] = [substr_replace($stringContent, $insertContent, $index - 1, 0)]; + $string[2] = [ + Util::mbSubstr($stringContent, 0, $index), + $insertContent, + Util::mbSubstr($stringContent, $index) + ]; return $string; } @@ -5867,16 +7684,16 @@ protected function libStrInsert($args) protected static $libStrLength = ['string']; protected function libStrLength($args) { - $string = $this->coerceString($args[0]); + $string = $this->assertString($args[0], 'string'); $stringContent = $this->compileStringContent($string); - return new Node\Number(strlen($stringContent), ''); + return new Node\Number(Util::mbStrlen($stringContent), ''); } - protected static $libStrSlice = ['string', 'start-at', 'end-at']; + protected static $libStrSlice = ['string', 'start-at', 'end-at:-1']; protected function libStrSlice($args) { - if (isset($args[2]) && $args[2][1] == 0) { + if (isset($args[2]) && ! $args[2][1]) { return static::$nullString; } @@ -5889,7 +7706,7 @@ protected function libStrSlice($args) $start--; } - $end = (int) $args[2][1]; + $end = isset($args[2]) ? (int) $args[2][1] : -1; $length = $end < 0 ? $end + 1 : ($end > 0 ? $end - $start : $end); $string[2] = $length @@ -5905,7 +7722,7 @@ protected function libToLowerCase($args) $string = $this->coerceString($args[0]); $stringContent = $this->compileStringContent($string); - $string[2] = [function_exists('mb_strtolower') ? mb_strtolower($stringContent) : strtolower($stringContent)]; + $string[2] = [\function_exists('mb_strtolower') ? mb_strtolower($stringContent) : strtolower($stringContent)]; return $string; } @@ -5916,7 +7733,7 @@ protected function libToUpperCase($args) $string = $this->coerceString($args[0]); $stringContent = $this->compileStringContent($string); - $string[2] = [function_exists('mb_strtoupper') ? mb_strtoupper($stringContent) : strtoupper($stringContent)]; + $string[2] = [\function_exists('mb_strtoupper') ? mb_strtoupper($stringContent) : strtoupper($stringContent)]; return $string; } @@ -5928,7 +7745,7 @@ protected function libFeatureExists($args) $name = $this->compileStringContent($string); return $this->toBool( - array_key_exists($name, $this->registeredFeatures) ? $this->registeredFeatures[$name] : false + \array_key_exists($name, $this->registeredFeatures) ? $this->registeredFeatures[$name] : false ); } @@ -5952,7 +7769,7 @@ protected function libFunctionExists($args) // built-in functions $f = $this->getBuiltinFunction($name); - return $this->toBool(is_callable($f)); + return $this->toBool(\is_callable($f)); } protected static $libGlobalVariableExists = ['name']; @@ -5996,22 +7813,25 @@ protected function libCounter($args) return [Type::T_STRING, '', ['counter(' . implode(',', $list) . ')']]; } - protected static $libRandom = ['limit']; + protected static $libRandom = ['limit:null']; protected function libRandom($args) { - if (isset($args[0])) { + if (isset($args[0]) & $args[0] !== static::$null) { $n = $this->assertNumber($args[0]); if ($n < 1) { - $this->throwError("limit must be greater than or equal to 1"); + throw $this->error("\$limit must be greater than or equal to 1"); + } - return null; + if (round($n - \intval($n), Node\Number::PRECISION) > 0) { + throw $this->error("Expected \$limit to be an integer but got $n for `random`"); } - return new Node\Number(mt_rand(1, $n), ''); + return new Node\Number(mt_rand(1, \intval($n)), ''); } - return new Node\Number(mt_rand(1, mt_getrandmax()), ''); + $max = mt_getrandmax(); + return new Node\Number(mt_rand(0, $max - 1) / $max, ''); } protected function libUniqueId() @@ -6019,7 +7839,9 @@ protected function libUniqueId() static $id; if (! isset($id)) { - $id = mt_rand(0, pow(36, 8)); + $id = PHP_INT_SIZE === 4 + ? mt_rand(0, pow(36, 5)) . str_pad(mt_rand(0, pow(36, 5)) % 10000000, 7, '0', STR_PAD_LEFT) + : mt_rand(0, pow(36, 8)); } $id += mt_rand(0, 10) + 1; @@ -6027,14 +7849,47 @@ protected function libUniqueId() return [Type::T_STRING, '', ['u' . str_pad(base_convert($id, 10, 36), 8, '0', STR_PAD_LEFT)]]; } + protected function inspectFormatValue($value, $force_enclosing_display = false) + { + if ($value === static::$null) { + $value = [Type::T_KEYWORD, 'null']; + } + + $stringValue = [$value]; + + if ($value[0] === Type::T_LIST) { + if (end($value[2]) === static::$null) { + array_pop($value[2]); + $value[2][] = [Type::T_STRING, '', ['']]; + $force_enclosing_display = true; + } + + if ( + ! empty($value['enclosing']) && + ($force_enclosing_display || + ($value['enclosing'] === 'bracket') || + ! \count($value[2])) + ) { + $value['enclosing'] = 'forced_' . $value['enclosing']; + $force_enclosing_display = true; + } + + foreach ($value[2] as $k => $listelement) { + $value[2][$k] = $this->inspectFormatValue($listelement, $force_enclosing_display); + } + + $stringValue = [$value]; + } + + return [Type::T_STRING, '', $stringValue]; + } + protected static $libInspect = ['value']; protected function libInspect($args) { - if ($args[0] === static::$null) { - return [Type::T_KEYWORD, 'null']; - } + $value = $args[0]; - return $args[0]; + return $this->inspectFormatValue($value); } /** @@ -6044,14 +7899,21 @@ protected function libInspect($args) * * @return array|boolean */ - protected function getSelectorArg($arg) + protected function getSelectorArg($arg, $varname = null, $allowParent = false) { static $parser = null; - if (is_null($parser)) { + if (\is_null($parser)) { $parser = $this->parserFactory(__METHOD__); } + if (! $this->checkSelectorArgType($arg)) { + $var_display = ($varname ? ' $' . $varname . ':' : ''); + $var_value = $this->compileValue($arg); + throw $this->error("Error:{$var_display} $var_value is not a valid selector: it must be a string," + . " a list of strings, or a list of lists of strings"); + } + $arg = $this->libUnquote([$arg]); $arg = $this->compileValue($arg); @@ -6061,10 +7923,44 @@ protected function getSelectorArg($arg) $selector = $this->evalSelectors($parsedSelector); $gluedSelector = $this->glueFunctionSelectors($selector); + if (! $allowParent) { + foreach ($gluedSelector as $selector) { + foreach ($selector as $s) { + if (in_array(static::$selfSelector, $s)) { + $var_display = ($varname ? ' $' . $varname . ':' : ''); + throw $this->error("Error:{$var_display} Parent selectors aren't allowed here."); + } + } + } + } + return $gluedSelector; } - return false; + $var_display = ($varname ? ' $' . $varname . ':' : ''); + throw $this->error("Error:{$var_display} expected more input, invalid selector."); + } + + /** + * Check variable type for getSelectorArg() function + * @param array $arg + * @param int $maxDepth + * @return bool + */ + protected function checkSelectorArgType($arg, $maxDepth = 2) + { + if ($arg[0] === Type::T_LIST && $maxDepth > 0) { + foreach ($arg[2] as $elt) { + if (! $this->checkSelectorArgType($elt, $maxDepth - 1)) { + return false; + } + } + return true; + } + if (!in_array($arg[0], [Type::T_STRING, Type::T_KEYWORD])) { + return false; + } + return true; } /** @@ -6086,8 +7982,8 @@ protected function libIsSuperselector($args) { list($super, $sub) = $args; - $super = $this->getSelectorArg($super); - $sub = $this->getSelectorArg($sub); + $super = $this->getSelectorArg($super, 'super'); + $sub = $this->getSelectorArg($sub, 'sub'); return $this->isSuperSelector($super, $sub); } @@ -6103,12 +7999,30 @@ protected function libIsSuperselector($args) 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 (! $super) { + throw $this->error('Invalid super selector for isSuperSelector()'); + } + + if (! $sub) { + throw $this->error('Invalid sub selector for isSuperSelector()'); + } + + if (count($sub) > 1) { + foreach ($sub as $s) { + if (! $this->isSuperSelector($super, [$s])) { + return false; + } + } + return true; } - if (! $sub || count($sub) !== 1) { - $this->throwError("Invalid sub selector for isSuperSelector()"); + if (count($super) > 1) { + foreach ($super as $s) { + if ($this->isSuperSelector([$s], $sub)) { + return true; + } + } + return false; } $super = reset($super); @@ -6135,7 +8049,7 @@ function ($value, $key) use (&$compound) { $nextMustMatch = true; $i++; } else { - while ($i < count($sub) && ! $this->isSuperPart($node, $sub[$i])) { + while ($i < \count($sub) && ! $this->isSuperPart($node, $sub[$i])) { if ($nextMustMatch) { return false; } @@ -6143,7 +8057,7 @@ function ($value, $key) use (&$compound) { $i++; } - if ($i >= count($sub)) { + if ($i >= \count($sub)) { return false; } @@ -6168,11 +8082,11 @@ protected function isSuperPart($superParts, $subParts) $i = 0; foreach ($superParts as $superPart) { - while ($i < count($subParts) && $subParts[$i] !== $superPart) { + while ($i < \count($subParts) && $subParts[$i] !== $superPart) { $i++; } - if ($i >= count($subParts)) { + if ($i >= \count($subParts)) { return false; } @@ -6182,14 +8096,21 @@ protected function isSuperPart($superParts, $subParts) return true; } - //protected static $libSelectorAppend = ['selector...']; + protected static $libSelectorAppend = ['selector...']; protected function libSelectorAppend($args) { - if (count($args) < 1) { - $this->throwError("selector-append() needs at least 1 argument"); + // get the selector... list + $args = reset($args); + $args = $args[2]; + + if (\count($args) < 1) { + throw $this->error('selector-append() needs at least 1 argument'); } - $selectors = array_map([$this, 'getSelectorArg'], $args); + $selectors = []; + foreach ($args as $arg) { + $selectors[] = $this->getSelectorArg($arg, 'selector'); + } return $this->formatOutputSelector($this->selectorAppend($selectors)); } @@ -6201,21 +8122,21 @@ protected function libSelectorAppend($args) * * @return array * - * @throws \Leafo\ScssPhp\Exception\CompilerException + * @throws \ScssPhp\ScssPhp\Exception\CompilerException */ protected function selectorAppend($selectors) { $lastSelectors = array_pop($selectors); if (! $lastSelectors) { - $this->throwError("Invalid selector list in selector-append()"); + throw $this->error('Invalid selector list in selector-append()'); } - while (count($selectors)) { + while (\count($selectors)) { $previousSelectors = array_pop($selectors); if (! $previousSelectors) { - $this->throwError("Invalid selector list in selector-append()"); + throw $this->error('Invalid selector list in selector-append()'); } // do the trick, happening $lastSelector to $previousSelector @@ -6245,17 +8166,20 @@ protected function selectorAppend($selectors) return $lastSelectors; } - protected static $libSelectorExtend = ['selectors', 'extendee', 'extender']; + protected static $libSelectorExtend = [ + ['selector', 'extendee', 'extender'], + ['selectors', 'extendee', 'extender'] + ]; protected function libSelectorExtend($args) { list($selectors, $extendee, $extender) = $args; - $selectors = $this->getSelectorArg($selectors); - $extendee = $this->getSelectorArg($extendee); - $extender = $this->getSelectorArg($extender); + $selectors = $this->getSelectorArg($selectors, 'selector'); + $extendee = $this->getSelectorArg($extendee, 'extendee'); + $extender = $this->getSelectorArg($extender, 'extender'); if (! $selectors || ! $extendee || ! $extender) { - $this->throwError("selector-extend() invalid arguments"); + throw $this->error('selector-extend() invalid arguments'); } $extended = $this->extendOrReplaceSelectors($selectors, $extendee, $extender); @@ -6263,17 +8187,20 @@ protected function libSelectorExtend($args) return $this->formatOutputSelector($extended); } - protected static $libSelectorReplace = ['selectors', 'original', 'replacement']; + protected static $libSelectorReplace = [ + ['selector', 'original', 'replacement'], + ['selectors', 'original', 'replacement'] + ]; protected function libSelectorReplace($args) { list($selectors, $original, $replacement) = $args; - $selectors = $this->getSelectorArg($selectors); - $original = $this->getSelectorArg($original); - $replacement = $this->getSelectorArg($replacement); + $selectors = $this->getSelectorArg($selectors, 'selector'); + $original = $this->getSelectorArg($original, 'original'); + $replacement = $this->getSelectorArg($replacement, 'replacement'); if (! $selectors || ! $original || ! $replacement) { - $this->throwError("selector-replace() invalid arguments"); + throw $this->error('selector-replace() invalid arguments'); } $replaced = $this->extendOrReplaceSelectors($selectors, $original, $replacement, true); @@ -6312,12 +8239,12 @@ protected function extendOrReplaceSelectors($selectors, $extendee, $extender, $r $extended[] = $selector; } - $n = count($extended); + $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) { + if ($replace && \count($extended) === $n) { $extended[] = $selector; } } @@ -6328,16 +8255,24 @@ protected function extendOrReplaceSelectors($selectors, $extendee, $extender, $r return $extended; } - //protected static $libSelectorNest = ['selector...']; + protected static $libSelectorNest = ['selector...']; protected function libSelectorNest($args) { - if (count($args) < 1) { - $this->throwError("selector-nest() needs at least 1 argument"); + // get the selector... list + $args = reset($args); + $args = $args[2]; + + if (\count($args) < 1) { + throw $this->error('selector-nest() needs at least 1 argument'); } - $selectorsMap = array_map([$this, 'getSelectorArg'], $args); + $selectorsMap = []; + foreach ($args as $arg) { + $selectorsMap[] = $this->getSelectorArg($arg, 'selector', true); + } $envs = []; + foreach ($selectorsMap as $selectors) { $env = new Environment(); $env->selectors = $selectors; @@ -6345,18 +8280,21 @@ protected function libSelectorNest($args) $envs[] = $env; } - $envs = array_reverse($envs); - $env = $this->extractEnv($envs); + $envs = array_reverse($envs); + $env = $this->extractEnv($envs); $outputSelectors = $this->multiplySelectors($env); return $this->formatOutputSelector($outputSelectors); } - protected static $libSelectorParse = ['selectors']; + protected static $libSelectorParse = [ + ['selector'], + ['selectors'] + ]; protected function libSelectorParse($args) { $selectors = reset($args); - $selectors = $this->getSelectorArg($selectors); + $selectors = $this->getSelectorArg($selectors, 'selector'); return $this->formatOutputSelector($selectors); } @@ -6366,11 +8304,11 @@ protected function libSelectorUnify($args) { list($selectors1, $selectors2) = $args; - $selectors1 = $this->getSelectorArg($selectors1); - $selectors2 = $this->getSelectorArg($selectors2); + $selectors1 = $this->getSelectorArg($selectors1, 'selectors1'); + $selectors2 = $this->getSelectorArg($selectors2, 'selectors2'); if (! $selectors1 || ! $selectors2) { - $this->throwError("selector-unify() invalid arguments"); + throw $this->error('selector-unify() invalid arguments'); } // only consider the first compound of each @@ -6389,22 +8327,23 @@ protected function libSelectorUnify($args) * * @param array $compound1 * @param array $compound2 + * * @return array|mixed */ protected function unifyCompoundSelectors($compound1, $compound2) { - if (! count($compound1)) { + if (! \count($compound1)) { return $compound2; } - if (! count($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); + $last = $this->mergeParts($lastPart1, $lastPart2); if (! $last) { return [[]]; @@ -6414,7 +8353,7 @@ protected function unifyCompoundSelectors($compound1, $compound2) $unifiedSelectors = [$unifiedCompound]; // do the rest - while (count($compound1) || count($compound2)) { + while (\count($compound1) || \count($compound2)) { $part1 = end($compound1); $part2 = end($compound2); @@ -6427,6 +8366,7 @@ protected function unifyCompoundSelectors($compound1, $compound2) $c = $this->mergeParts($part1, $part2); $unifiedSelectors = $this->prependSelectors($unifiedSelectors, [$c]); + $part1 = $part2 = null; array_pop($compound1); @@ -6441,6 +8381,7 @@ protected function unifyCompoundSelectors($compound1, $compound2) $c = $this->mergeParts($part2, $part1); $unifiedSelectors = $this->prependSelectors($unifiedSelectors, [$c]); + $part1 = $part2 = null; array_pop($compound2); @@ -6452,9 +8393,9 @@ protected function unifyCompoundSelectors($compound1, $compound2) array_pop($compound1); array_pop($compound2); - $s = $this->prependSelectors($unifiedSelectors, [$part2]); + $s = $this->prependSelectors($unifiedSelectors, [$part2]); $new = array_merge($new, $this->prependSelectors($s, [$part1])); - $s = $this->prependSelectors($unifiedSelectors, [$part1]); + $s = $this->prependSelectors($unifiedSelectors, [$part1]); $new = array_merge($new, $this->prependSelectors($s, [$part2])); } elseif ($part1) { array_pop($compound1); @@ -6508,11 +8449,11 @@ protected function prependSelectors($selectors, $parts) protected function matchPartInCompound($part, $compound) { $partTag = $this->findTagName($part); - $before = $compound; - $after = []; + $before = $compound; + $after = []; // try to find a match by tag name first - while (count($before)) { + while (\count($before)) { $p = array_pop($before); if ($partTag && $partTag !== '*' && $partTag == $this->findTagName($p)) { @@ -6526,11 +8467,11 @@ protected function matchPartInCompound($part, $compound) $before = $compound; $after = []; - while (count($before)) { + while (\count($before)) { $p = array_pop($before); if ($this->checkCompatibleTags($partTag, $this->findTagName($p))) { - if (count(array_intersect($part, $p))) { + if (\count(array_intersect($part, $p))) { return [$before, $p, $after]; } } @@ -6555,7 +8496,7 @@ protected function mergeParts($parts1, $parts2) { $tag1 = $this->findTagName($parts1); $tag2 = $this->findTagName($parts2); - $tag = $this->checkCompatibleTags($tag1, $tag2); + $tag = $this->checkCompatibleTags($tag1, $tag2); // not compatible tags if ($tag === false) { @@ -6606,12 +8547,12 @@ protected function checkCompatibleTags($tag1, $tag2) $tags = array_unique($tags); $tags = array_filter($tags); - if (count($tags)>1) { + if (\count($tags) > 1) { $tags = array_diff($tags, ['*']); } // not compatible nodes - if (count($tags)>1) { + if (\count($tags) > 1) { return false; } @@ -6640,7 +8581,7 @@ protected function findTagName($parts) protected function libSimpleSelectors($args) { $selector = reset($args); - $selector = $this->getSelectorArg($selector); + $selector = $this->getSelectorArg($selector, 'selector'); // remove selectors list layer, keeping the first one $selector = reset($selector); @@ -6656,4 +8597,23 @@ protected function libSimpleSelectors($args) return [Type::T_LIST, ',', $listParts]; } + + protected static $libScssphpGlob = ['pattern']; + protected function libScssphpGlob($args) + { + $string = $this->coerceString($args[0]); + $pattern = $this->compileStringContent($string); + $matches = glob($pattern); + $listParts = []; + + foreach ($matches as $match) { + if (! is_file($match)) { + continue; + } + + $listParts[] = [Type::T_STRING, '"', [$match]]; + } + + return [Type::T_LIST, ',', $listParts]; + } } diff --git a/src/Compiler/Environment.php b/src/Compiler/Environment.php index 99231f36..dc2f86c1 100644 --- a/src/Compiler/Environment.php +++ b/src/Compiler/Environment.php @@ -1,15 +1,16 @@ */ -class CompilerException extends \Exception +class CompilerException extends \Exception implements SassException { } diff --git a/src/Exception/ParserException.php b/src/Exception/ParserException.php index 6d64335f..5237f307 100644 --- a/src/Exception/ParserException.php +++ b/src/Exception/ParserException.php @@ -1,21 +1,48 @@ */ -class ParserException extends \Exception +class ParserException extends \Exception implements SassException { + /** + * @var array + */ + private $sourcePosition; + + /** + * Get source position + * + * @api + */ + public function getSourcePosition() + { + return $this->sourcePosition; + } + + /** + * Set source position + * + * @api + * + * @param array $sourcePosition + */ + public function setSourcePosition($sourcePosition) + { + $this->sourcePosition = $sourcePosition; + } } diff --git a/src/Exception/RangeException.php b/src/Exception/RangeException.php index 3ba6bf14..b18c32d6 100644 --- a/src/Exception/RangeException.php +++ b/src/Exception/RangeException.php @@ -1,21 +1,22 @@ */ -class RangeException extends \Exception +class RangeException extends \Exception implements SassException { } diff --git a/src/Exception/SassException.php b/src/Exception/SassException.php new file mode 100644 index 00000000..9f62b3cd --- /dev/null +++ b/src/Exception/SassException.php @@ -0,0 +1,7 @@ + */ -class ServerException extends \Exception +class ServerException extends \Exception implements SassException { } diff --git a/src/Formatter.php b/src/Formatter.php index 1403859d..290f5f3c 100644 --- a/src/Formatter.php +++ b/src/Formatter.php @@ -1,18 +1,19 @@ keepSemicolons) { - return; - } - - if (($count = count($lines)) - && substr($lines[$count - 1], -1) === ';' - ) { - $lines[$count - 1] = substr($lines[$count - 1], 0, -1); - } + return rtrim($name) . trim($this->assignSeparator) . $value . ';'; } /** * Output lines inside a block * - * @param \Leafo\ScssPhp\Formatter\OutputBlock $block + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $block */ protected function blockLines(OutputBlock $block) { $inner = $this->indentStr(); - - $glue = $this->break . $inner; + $glue = $this->break . $inner; $this->write($inner . implode($glue, $block->lines)); @@ -154,7 +155,7 @@ protected function blockLines(OutputBlock $block) /** * Output block selectors * - * @param \Leafo\ScssPhp\Formatter\OutputBlock $block + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $block */ protected function blockSelectors(OutputBlock $block) { @@ -168,7 +169,7 @@ protected function blockSelectors(OutputBlock $block) /** * Output block children * - * @param \Leafo\ScssPhp\Formatter\OutputBlock $block + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $block */ protected function blockChildren(OutputBlock $block) { @@ -180,7 +181,7 @@ protected function blockChildren(OutputBlock $block) /** * Output non-empty block * - * @param \Leafo\ScssPhp\Formatter\OutputBlock $block + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $block */ protected function block(OutputBlock $block) { @@ -209,6 +210,10 @@ protected function block(OutputBlock $block) if (! empty($block->selectors)) { $this->indentLevel--; + if (! $this->keepSemicolons) { + $this->strippedSemicolon = ''; + } + if (empty($block->children)) { $this->write($this->break); } @@ -217,13 +222,41 @@ protected function block(OutputBlock $block) } } + /** + * Test and clean safely empty children + * + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $block + * + * @return boolean + */ + protected function testEmptyChildren($block) + { + $isEmpty = empty($block->lines); + + if ($block->children) { + foreach ($block->children as $k => &$child) { + if (! $this->testEmptyChildren($child)) { + $isEmpty = false; + continue; + } + + if ($child->type === Type::T_MEDIA || $child->type === Type::T_DIRECTIVE) { + $child->children = []; + $child->selectors = null; + } + } + } + + return $isEmpty; + } + /** * Entry point to formatting a block * * @api * - * @param \Leafo\ScssPhp\Formatter\OutputBlock $block An abstract syntax tree - * @param \Leafo\ScssPhp\SourceMap\SourceMapGenerator|null $sourceMapGenerator Optional source map generator + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $block An abstract syntax tree + * @param \ScssPhp\ScssPhp\SourceMap\SourceMapGenerator|null $sourceMapGenerator Optional source map generator * * @return string */ @@ -232,11 +265,13 @@ public function format(OutputBlock $block, SourceMapGenerator $sourceMapGenerato $this->sourceMapGenerator = null; if ($sourceMapGenerator) { - $this->currentLine = 1; - $this->currentColumn = 0; + $this->currentLine = 1; + $this->currentColumn = 0; $this->sourceMapGenerator = $sourceMapGenerator; } + $this->testEmptyChildren($block); + ob_start(); $this->block($block); @@ -247,10 +282,33 @@ public function format(OutputBlock $block, SourceMapGenerator $sourceMapGenerato } /** + * Output content + * * @param string $str */ protected function write($str) { + if (! empty($this->strippedSemicolon)) { + echo $this->strippedSemicolon; + + $this->strippedSemicolon = ''; + } + + /* + * Maybe Strip semi-colon appended by property(); it's a separator, not a terminator + * will be striped for real before a closing, otherwise displayed unchanged starting the next write + */ + if ( + ! $this->keepSemicolons && + $str && + (strpos($str, ';') !== false) && + (substr($str, -1) === ';') + ) { + $str = substr($str, 0, -1); + + $this->strippedSemicolon = ';'; + } + if ($this->sourceMapGenerator) { $this->sourceMapGenerator->addMapping( $this->currentLine, @@ -262,12 +320,12 @@ protected function write($str) ); $lines = explode("\n", $str); - $lineCount = count($lines); - $this->currentLine += $lineCount-1; + $lineCount = \count($lines); + $this->currentLine += $lineCount - 1; $lastLine = array_pop($lines); - $this->currentColumn = ($lineCount === 1 ? $this->currentColumn : 0) + strlen($lastLine); + $this->currentColumn = ($lineCount === 1 ? $this->currentColumn : 0) + \strlen($lastLine); } echo $str; diff --git a/src/Formatter/Compact.php b/src/Formatter/Compact.php index 4efa1a08..98009b41 100644 --- a/src/Formatter/Compact.php +++ b/src/Formatter/Compact.php @@ -1,17 +1,18 @@ lines as $index => $line) { if (substr($line, 0, 2) === '/*') { - $block->lines[$index] = preg_replace('/(\r|\n)+/', $glue, $line); + $block->lines[$index] = preg_replace('/\r\n?|\n|\f/', $this->break, $line); } } diff --git a/src/Formatter/Nested.php b/src/Formatter/Nested.php index 8f72206f..046ecc85 100644 --- a/src/Formatter/Nested.php +++ b/src/Formatter/Nested.php @@ -1,18 +1,20 @@ indentStr(); - - $glue = $this->break . $inner; + $glue = $this->break . $inner; foreach ($block->lines as $index => $line) { if (substr($line, 0, 2) === '/*') { - $block->lines[$index] = preg_replace('/(\r|\n)+/', $glue, $line); + $block->lines[$index] = preg_replace('/\r\n?|\n|\f/', $this->break, $line); } } $this->write($inner . implode($glue, $block->lines)); - - if (! empty($block->children)) { - $this->write($this->break); - } } /** * {@inheritdoc} */ - protected function blockSelectors(OutputBlock $block) + protected function block(OutputBlock $block) { - $inner = $this->indentStr(); - - $this->write($inner - . implode($this->tagSeparator, $block->selectors) - . $this->open . $this->break); - } + static $depths; + static $downLevel; + static $closeBlock; + static $previousEmpty; + static $previousHasSelector; - /** - * {@inheritdoc} - */ - protected function blockChildren(OutputBlock $block) - { - foreach ($block->children as $i => $child) { - $this->block($child); + if ($block->type === 'root') { + $depths = [ 0 ]; + $downLevel = ''; + $closeBlock = ''; + $this->depth = 0; + $previousEmpty = false; + $previousHasSelector = false; + } - if ($i < count($block->children) - 1) { - $this->write($this->break); + $isMediaOrDirective = \in_array($block->type, [Type::T_DIRECTIVE, Type::T_MEDIA]); + $isSupport = ($block->type === Type::T_DIRECTIVE + && $block->selectors && strpos(implode('', $block->selectors), '@supports') !== false); - if (isset($block->children[$i + 1])) { - $next = $block->children[$i + 1]; + while ($block->depth < end($depths) || ($block->depth == 1 && end($depths) == 1)) { + array_pop($depths); + $this->depth--; - if ($next->depth === max($block->depth, 1) && $child->depth >= $next->depth) { - $this->write($this->break); - } - } + if ( + ! $this->depth && ($block->depth <= 1 || (! $this->indentLevel && $block->type === Type::T_COMMENT)) && + (($block->selectors && ! $isMediaOrDirective) || $previousHasSelector) + ) { + $downLevel = $this->break; } - } - } - /** - * {@inheritdoc} - */ - protected function block(OutputBlock $block) - { - if ($block->type === 'root') { - $this->adjustAllChildren($block); + if (empty($block->lines) && empty($block->children)) { + $previousEmpty = true; + } } if (empty($block->lines) && empty($block->children)) { @@ -122,27 +116,94 @@ protected function block(OutputBlock $block) $this->currentBlock = $block; + if (! empty($block->lines) || (! empty($block->children) && ($this->depth < 1 || $isSupport))) { + if ($block->depth > end($depths)) { + if (! $previousEmpty || $this->depth < 1) { + $this->depth++; - $this->depth = $block->depth; + $depths[] = $block->depth; + } else { + // keep the current depth unchanged but take the block depth as a new reference for following blocks + array_pop($depths); + + $depths[] = $block->depth; + } + } + } + + $previousEmpty = ($block->type === Type::T_COMMENT); + $previousHasSelector = false; if (! empty($block->selectors)) { + if ($closeBlock) { + $this->write($closeBlock); + $closeBlock = ''; + } + + if ($downLevel) { + $this->write($downLevel); + $downLevel = ''; + } + $this->blockSelectors($block); $this->indentLevel++; } if (! empty($block->lines)) { + if ($closeBlock) { + $this->write($closeBlock); + $closeBlock = ''; + } + + if ($downLevel) { + $this->write($downLevel); + $downLevel = ''; + } + $this->blockLines($block); + + $closeBlock = $this->break; } if (! empty($block->children)) { - $this->blockChildren($block); + if ($this->depth > 0 && ($isMediaOrDirective || ! $this->hasFlatChild($block))) { + array_pop($depths); + + $this->depth--; + $this->blockChildren($block); + $this->depth++; + + $depths[] = $block->depth; + } else { + $this->blockChildren($block); + } + } + + // reclear to not be spoiled by children if T_DIRECTIVE + if ($block->type === Type::T_DIRECTIVE) { + $previousHasSelector = false; } if (! empty($block->selectors)) { $this->indentLevel--; + if (! $this->keepSemicolons) { + $this->strippedSemicolon = ''; + } + $this->write($this->close); + + $closeBlock = $this->break; + + if ($this->depth > 1 && ! empty($block->children)) { + array_pop($depths); + $this->depth--; + } + + if (! $isMediaOrDirective) { + $previousHasSelector = true; + } } if ($block->type === 'root') { @@ -151,51 +212,20 @@ protected function block(OutputBlock $block) } /** - * Adjust the depths of all children, depth first + * Block has flat child * - * @param \Leafo\ScssPhp\Formatter\OutputBlock $block + * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $block + * + * @return boolean */ - private function adjustAllChildren(OutputBlock $block) + private function hasFlatChild($block) { - // flatten empty nested blocks - $children = []; - - foreach ($block->children as $i => $child) { - if (empty($child->lines) && empty($child->children)) { - if (isset($block->children[$i + 1])) { - $block->children[$i + 1]->depth = $child->depth; - } - - continue; - } - - $children[] = $child; - } - - $count = count($children); - - for ($i = 0; $i < $count; $i++) { - $depth = $children[$i]->depth; - $j = $i + 1; - - if (isset($children[$j]) && $depth < $children[$j]->depth) { - $childDepth = $children[$j]->depth; - - for (; $j < $count; $j++) { - if ($depth < $children[$j]->depth && $childDepth >= $children[$j]->depth) { - $children[$j]->depth = $depth + 1; - } - } + foreach ($block->children as $child) { + if (empty($child->selectors)) { + return true; } } - $block->children = $children; - - // make relative to parent - foreach ($block->children as $child) { - $this->adjustAllChildren($child); - - $child->depth = $child->depth - $block->depth; - } + return false; } } diff --git a/src/Formatter/OutputBlock.php b/src/Formatter/OutputBlock.php index 5eb589c9..8dcba7c9 100644 --- a/src/Formatter/OutputBlock.php +++ b/src/Formatter/OutputBlock.php @@ -1,15 +1,16 @@ [ 'in' => 1, 'pc' => 6, @@ -64,8 +68,8 @@ class Number extends Node implements \ArrayAccess ], 'dpi' => [ 'dpi' => 1, - 'dpcm' => 2.54, - 'dppx' => 96, + 'dpcm' => 1 / 2.54, + 'dppx' => 1 / 96, ], ]; @@ -89,7 +93,7 @@ public function __construct($dimension, $initialUnit) { $this->type = Type::T_NUMBER; $this->dimension = $dimension; - $this->units = is_array($initialUnit) + $this->units = \is_array($initialUnit) ? $initialUnit : ($initialUnit ? [$initialUnit => 1] : []); @@ -100,7 +104,7 @@ public function __construct($dimension, $initialUnit) * * @param array $units * - * @return \Leafo\ScssPhp\Node\Number + * @return \ScssPhp\ScssPhp\Node\Number */ public function coerce($units) { @@ -110,11 +114,18 @@ public function coerce($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; + if (\count($units)) { + $baseUnit = array_keys($units); + $baseUnit = reset($baseUnit); + $baseUnit = $this->findBaseUnit($baseUnit); + if ($baseUnit && isset(static::$unitTable[$baseUnit])) { + foreach (static::$unitTable[$baseUnit] 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); @@ -123,14 +134,14 @@ public function coerce($units) /** * Normalize number * - * @return \Leafo\ScssPhp\Node\Number + * @return \ScssPhp\ScssPhp\Node\Number */ public function normalize() { $dimension = $this->dimension; $units = []; - $this->normalizeUnits($dimension, $units, 'in'); + $this->normalizeUnits($dimension, $units); return new Number($dimension, $units); } @@ -141,17 +152,18 @@ public function normalize() public function offsetExists($offset) { if ($offset === -3) { - return $this->sourceColumn !== null; + return ! \is_null($this->sourceColumn); } if ($offset === -2) { - return $this->sourceLine !== null; + return ! \is_null($this->sourceLine); } - if ($offset === -1 - || $offset === 0 - || $offset === 1 - || $offset === 2 + if ( + $offset === -1 || + $offset === 0 || + $offset === 1 || + $offset === 2 ) { return true; } @@ -231,6 +243,35 @@ public function unitless() return ! array_sum($this->units); } + /** + * Test if a number can be normalized in a base unit + * ie if its units are homogeneous + * + * @return boolean + */ + public function isNormalizable() + { + if ($this->unitless()) { + return false; + } + + $baseUnit = null; + + foreach ($this->units as $unit => $exp) { + $b = $this->findBaseUnit($unit); + + if (\is_null($baseUnit)) { + $baseUnit = $b; + } + + if (\is_null($b) or $b !== $baseUnit) { + return false; + } + } + + return $baseUnit; + } + /** * Returns unit(s) as the product of numerator units divided by the product of denominator units * @@ -243,41 +284,41 @@ public function unitStr() foreach ($this->units as $unit => $unitSize) { if ($unitSize > 0) { - $numerators = array_pad($numerators, count($numerators) + $unitSize, $unit); + $numerators = array_pad($numerators, \count($numerators) + $unitSize, $unit); continue; } if ($unitSize < 0) { - $denominators = array_pad($denominators, count($denominators) + $unitSize, $unit); + $denominators = array_pad($denominators, \count($denominators) - $unitSize, $unit); continue; } } - return implode('*', $numerators) . (count($denominators) ? '/' . implode('*', $denominators) : ''); + return implode('*', $numerators) . (\count($denominators) ? '/' . implode('*', $denominators) : ''); } /** * Output number * - * @param \Leafo\ScssPhp\Compiler $compiler + * @param \ScssPhp\ScssPhp\Compiler $compiler * * @return string */ public function output(Compiler $compiler = null) { - $dimension = round($this->dimension, static::$precision); + $dimension = round($this->dimension, self::PRECISION); $units = array_filter($this->units, function ($unitSize) { return $unitSize; }); - if (count($units) > 1 && array_sum($units) === 0) { + if (\count($units) > 1 && array_sum($units) === 0) { $dimension = $this->dimension; $units = []; - $this->normalizeUnits($dimension, $units, 'in'); + $this->normalizeUnits($dimension, $units); - $dimension = round($dimension, static::$precision); + $dimension = round($dimension, self::PRECISION); $units = array_filter($units, function ($unitSize) { return $unitSize; }); @@ -285,15 +326,17 @@ public function output(Compiler $compiler = null) $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."); + if ($compiler && ($unitSize > 1 || $unitSize < 0 || \count($units) > 1)) { + $this->units = $units; + $unit = $this->unitStr(); + } else { + reset($units); + $unit = key($units); } - reset($units); - $unit = key($units); - $dimension = number_format($dimension, static::$precision, '.', ''); + $dimension = number_format($dimension, self::PRECISION, '.', ''); - return (static::$precision ? rtrim(rtrim($dimension, '0'), '.') : $dimension) . $unit; + return (self::PRECISION ? rtrim(rtrim($dimension, '0'), '.') : $dimension) . $unit; } /** @@ -311,13 +354,17 @@ public function __toString() * @param array $units * @param string $baseUnit */ - private function normalizeUnits(&$dimension, &$units, $baseUnit = 'in') + private function normalizeUnits(&$dimension, &$units, $baseUnit = null) { $dimension = $this->dimension; $units = []; foreach ($this->units as $unit => $exp) { - if (isset(static::$unitTable[$baseUnit][$unit])) { + if (! $baseUnit) { + $baseUnit = $this->findBaseUnit($unit); + } + + if ($baseUnit && isset(static::$unitTable[$baseUnit][$unit])) { $factor = pow(static::$unitTable[$baseUnit][$unit], $exp); $unit = $baseUnit; @@ -327,4 +374,22 @@ private function normalizeUnits(&$dimension, &$units, $baseUnit = 'in') $units[$unit] = $exp + (isset($units[$unit]) ? $units[$unit] : 0); } } + + /** + * Find the base unit family for a given unit + * + * @param string $unit + * + * @return string|null + */ + private function findBaseUnit($unit) + { + foreach (static::$unitTable as $baseUnit => $unitVariants) { + if (isset($unitVariants[$unit])) { + return $baseUnit; + } + } + + return null; + } } diff --git a/src/Parser.php b/src/Parser.php index c05e4ee8..75700c7f 100644 --- a/src/Parser.php +++ b/src/Parser.php @@ -1,22 +1,23 @@ sourceName = $sourceName ?: '(stdin)'; $this->sourceIndex = $sourceIndex; @@ -88,6 +93,9 @@ public function __construct($sourceName, $sourceIndex = 0, $encoding = 'utf-8', $this->utf8 = ! $encoding || strtolower($encoding) === 'utf-8'; $this->patternModifiers = $this->utf8 ? 'Aisu' : 'Ais'; $this->commentsSeen = []; + $this->commentsSeen = []; + $this->allowVars = true; + $this->cssOnly = $cssOnly; if (empty(static::$operatorPattern)) { static::$operatorPattern = '([*\/%+-]|[!=]\=|\>\=?|\<\=\>|\<\=?|and|or)'; @@ -126,7 +134,7 @@ public function getSourceName() * * @param string $msg * - * @throws \Leafo\ScssPhp\Exception\ParserException + * @throws \ScssPhp\ScssPhp\Exception\ParserException */ public function throwParseError($msg = 'parse error') { @@ -136,11 +144,21 @@ public function throwParseError($msg = 'parse error') ? "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"); + if ($this->peek('(.*?)(\n|$)', $m, $this->count)) { + $this->restoreEncoding(); + + $e = new ParserException("$msg: failed at `$m[1]` $loc"); + $e->setSourcePosition([$this->sourceName, $line, $column]); + + throw $e; } - throw new ParserException("$msg: $loc"); + $this->restoreEncoding(); + + $e = new ParserException("$msg: $loc"); + $e->setSourcePosition([$this->sourceName, $line, $column]); + + throw $e; } /** @@ -150,19 +168,19 @@ public function throwParseError($msg = 'parse error') * * @param string $buffer * - * @return \Leafo\ScssPhp\Block + * @return \ScssPhp\ScssPhp\Block */ public function parse($buffer) { if ($this->cache) { - $cacheKey = $this->sourceName . ":" . md5($buffer); + $cacheKey = $this->sourceName . ':' . md5($buffer); $parseOptions = [ 'charset' => $this->charset, 'utf8' => $this->utf8, ]; - $v = $this->cache->getCache("parse", $cacheKey, $parseOptions); + $v = $this->cache->getCache('parse', $cacheKey, $parseOptions); - if (! is_null($v)) { + if (! \is_null($v)) { return $v; } } @@ -190,7 +208,7 @@ public function parse($buffer) ; } - if ($this->count !== strlen($this->buffer)) { + if ($this->count !== \strlen($this->buffer)) { $this->throwParseError(); } @@ -205,7 +223,7 @@ public function parse($buffer) $this->restoreEncoding(); if ($this->cache) { - $this->cache->setCache("parse", $cacheKey, $this->env, $parseOptions); + $this->cache->setCache('parse', $cacheKey, $this->env, $parseOptions); } return $this->env; @@ -216,8 +234,8 @@ public function parse($buffer) * * @api * - * @param string $buffer - * @param string $out + * @param string $buffer + * @param string|array $out * * @return boolean */ @@ -243,8 +261,8 @@ public function parseValue($buffer, &$out) * * @api * - * @param string $buffer - * @param string $out + * @param string $buffer + * @param string|array $out * * @return boolean */ @@ -265,6 +283,33 @@ public function parseSelector($buffer, &$out) return $selector; } + /** + * Parse a media Query + * + * @api + * + * @param string $buffer + * @param string|array $out + * + * @return boolean + */ + public function parseMediaQueryList($buffer, &$out) + { + $this->count = 0; + $this->env = null; + $this->inParens = false; + $this->eatWhiteDefault = true; + $this->buffer = (string) $buffer; + + $this->saveEncoding(); + + $isMediaQuery = $this->mediaQueryList($out); + + $this->restoreEncoding(); + + return $isMediaQuery; + } + /** * Parse a single chunk off the head of the buffer and append it to the * current parse environment. @@ -310,21 +355,31 @@ protected function parseChunk() // the directives if (isset($this->buffer[$this->count]) && $this->buffer[$this->count] === '@') { - if ($this->literal('@at-root', 8) && + if ( + $this->literal('@at-root', 8) && ($this->selectors($selector) || true) && ($this->map($with) || true) && - $this->matchChar('{') + (($this->matchChar('(') && + $this->interpolation($with) && + $this->matchChar(')')) || true) && + $this->matchChar('{', false) ) { + ! $this->cssOnly || $this->assertPlainCssValid(false, $s); + $atRoot = $this->pushSpecialBlock(Type::T_AT_ROOT, $s); $atRoot->selector = $selector; - $atRoot->with = $with; + $atRoot->with = $with; return true; } $this->seek($s); - if ($this->literal('@media', 6) && $this->mediaQueryList($mediaQueryList) && $this->matchChar('{')) { + if ( + $this->literal('@media', 6) && + $this->mediaQueryList($mediaQueryList) && + $this->matchChar('{', false) + ) { $media = $this->pushSpecialBlock(Type::T_MEDIA, $s); $media->queryList = $mediaQueryList[2]; @@ -333,11 +388,14 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@mixin', 6) && + if ( + $this->literal('@mixin', 6) && $this->keyword($mixinName) && ($this->argumentDef($args) || true) && - $this->matchChar('{') + $this->matchChar('{', false) ) { + ! $this->cssOnly || $this->assertPlainCssValid(false, $s); + $mixin = $this->pushSpecialBlock(Type::T_MIXIN, $s); $mixin->name = $mixinName; $mixin->args = $args; @@ -347,15 +405,27 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@include', 8) && - $this->keyword($mixinName) && - ($this->matchChar('(') && + if ( + ($this->literal('@include', 8) && + $this->keyword($mixinName) && + ($this->matchChar('(') && ($this->argValues($argValues) || true) && $this->matchChar(')') || true) && - ($this->end() || - $this->matchChar('{') && $hasBlock = true) + ($this->end()) || + ($this->literal('using', 5) && + $this->argumentDef($argUsing) && + ($this->end() || $this->matchChar('{') && $hasBlock = true)) || + $this->matchChar('{') && $hasBlock = true) ) { - $child = [Type::T_INCLUDE, $mixinName, isset($argValues) ? $argValues : null, null]; + ! $this->cssOnly || $this->assertPlainCssValid(false, $s); + + $child = [ + Type::T_INCLUDE, + $mixinName, + isset($argValues) ? $argValues : null, + null, + isset($argUsing) ? $argUsing : null + ]; if (! empty($hasBlock)) { $include = $this->pushSpecialBlock(Type::T_INCLUDE, $s); @@ -369,10 +439,13 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@scssphp-import-once', 20) && + if ( + $this->literal('@scssphp-import-once', 20) && $this->valueList($importPath) && $this->end() ) { + ! $this->cssOnly || $this->assertPlainCssValid(false, $s); + $this->append([Type::T_SCSSPHP_IMPORT_ONCE, $importPath], $s); return true; @@ -380,10 +453,18 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@import', 7) && + if ( + $this->literal('@import', 7) && $this->valueList($importPath) && + $importPath[0] !== Type::T_FUNCTION_CALL && $this->end() ) { + if ($this->cssOnly) { + $this->assertPlainCssValid($importPath, $s); + $this->append([Type::T_COMMENT, rtrim(substr($this->buffer, $s, $this->count - $s))]); + return true; + } + $this->append([Type::T_IMPORT, $importPath], $s); return true; @@ -391,10 +472,17 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@import', 7) && + if ( + $this->literal('@import', 7) && $this->url($importPath) && $this->end() ) { + if ($this->cssOnly) { + $this->assertPlainCssValid($importPath, $s); + $this->append([Type::T_COMMENT, rtrim(substr($this->buffer, $s, $this->count - $s))]); + return true; + } + $this->append([Type::T_IMPORT, $importPath], $s); return true; @@ -402,10 +490,13 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@extend', 7) && + if ( + $this->literal('@extend', 7) && $this->selectors($selectors) && $this->end() ) { + ! $this->cssOnly || $this->assertPlainCssValid(false, $s); + // check for '!flag' $optional = $this->stripOptionalFlag($selectors); $this->append([Type::T_EXTEND, $selectors, $optional], $s); @@ -415,11 +506,14 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@function', 9) && + if ( + $this->literal('@function', 9) && $this->keyword($fnName) && $this->argumentDef($args) && - $this->matchChar('{') + $this->matchChar('{', false) ) { + ! $this->cssOnly || $this->assertPlainCssValid(false, $s); + $func = $this->pushSpecialBlock(Type::T_FUNCTION, $s); $func->name = $fnName; $func->args = $args; @@ -429,7 +523,12 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@break', 6) && $this->end()) { + if ( + $this->literal('@break', 6) && + $this->end() + ) { + ! $this->cssOnly || $this->assertPlainCssValid(false, $s); + $this->append([Type::T_BREAK], $s); return true; @@ -437,7 +536,12 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@continue', 9) && $this->end()) { + if ( + $this->literal('@continue', 9) && + $this->end() + ) { + ! $this->cssOnly || $this->assertPlainCssValid(false, $s); + $this->append([Type::T_CONTINUE], $s); return true; @@ -445,7 +549,13 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@return', 7) && ($this->valueList($retVal) || true) && $this->end()) { + if ( + $this->literal('@return', 7) && + ($this->valueList($retVal) || true) && + $this->end() + ) { + ! $this->cssOnly || $this->assertPlainCssValid(false, $s); + $this->append([Type::T_RETURN, isset($retVal) ? $retVal : [Type::T_NULL]], $s); return true; @@ -453,12 +563,15 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@each', 5) && + if ( + $this->literal('@each', 5) && $this->genericList($varNames, 'variable', ',', false) && $this->literal('in', 2) && $this->valueList($list) && - $this->matchChar('{') + $this->matchChar('{', false) ) { + ! $this->cssOnly || $this->assertPlainCssValid(false, $s); + $each = $this->pushSpecialBlock(Type::T_EACH, $s); foreach ($varNames[2] as $varName) { @@ -472,10 +585,22 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@while', 6) && + if ( + $this->literal('@while', 6) && $this->expression($cond) && - $this->matchChar('{') + $this->matchChar('{', false) ) { + ! $this->cssOnly || $this->assertPlainCssValid(false, $s); + + while ( + $cond[0] === Type::T_LIST && + ! empty($cond['enclosing']) && + $cond['enclosing'] === 'parent' && + \count($cond[2]) == 1 + ) { + $cond = reset($cond[2]); + } + $while = $this->pushSpecialBlock(Type::T_WHILE, $s); $while->cond = $cond; @@ -484,19 +609,22 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@for', 4) && + if ( + $this->literal('@for', 4) && $this->variable($varName) && $this->literal('from', 4) && $this->expression($start) && ($this->literal('through', 7) || ($forUntil = true && $this->literal('to', 2))) && $this->expression($end) && - $this->matchChar('{') + $this->matchChar('{', false) ) { + ! $this->cssOnly || $this->assertPlainCssValid(false, $s); + $for = $this->pushSpecialBlock(Type::T_FOR, $s); - $for->var = $varName[1]; + $for->var = $varName[1]; $for->start = $start; - $for->end = $end; + $for->end = $end; $for->until = isset($forUntil); return true; @@ -504,9 +632,24 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@if', 3) && $this->valueList($cond) && $this->matchChar('{')) { + if ( + $this->literal('@if', 3) && + $this->functionCallArgumentsList($cond, false, '{', false) + ) { + ! $this->cssOnly || $this->assertPlainCssValid(false, $s); + $if = $this->pushSpecialBlock(Type::T_IF, $s); - $if->cond = $cond; + + while ( + $cond[0] === Type::T_LIST && + ! empty($cond['enclosing']) && + $cond['enclosing'] === 'parent' && + \count($cond[2]) == 1 + ) { + $cond = reset($cond[2]); + } + + $if->cond = $cond; $if->cases = []; return true; @@ -514,10 +657,12 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@debug', 6) && - $this->valueList($value) && - $this->end() + if ( + $this->literal('@debug', 6) && + $this->functionCallArgumentsList($value, false) ) { + ! $this->cssOnly || $this->assertPlainCssValid(false, $s); + $this->append([Type::T_DEBUG, $value], $s); return true; @@ -525,10 +670,12 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@warn', 5) && - $this->valueList($value) && - $this->end() + if ( + $this->literal('@warn', 5) && + $this->functionCallArgumentsList($value, false) ) { + ! $this->cssOnly || $this->assertPlainCssValid(false, $s); + $this->append([Type::T_WARN, $value], $s); return true; @@ -536,10 +683,12 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@error', 6) && - $this->valueList($value) && - $this->end() + if ( + $this->literal('@error', 6) && + $this->functionCallArgumentsList($value, false) ) { + ! $this->cssOnly || $this->assertPlainCssValid(false, $s); + $this->append([Type::T_ERROR, $value], $s); return true; @@ -547,8 +696,17 @@ protected function parseChunk() $this->seek($s); - if ($this->literal('@content', 8) && $this->end()) { - $this->append([Type::T_MIXIN_CONTENT], $s); + if ( + $this->literal('@content', 8) && + ($this->end() || + $this->matchChar('(') && + $this->argValues($argContent) && + $this->matchChar(')') && + $this->end()) + ) { + ! $this->cssOnly || $this->assertPlainCssValid(false, $s); + + $this->append([Type::T_MIXIN_CONTENT, isset($argContent) ? $argContent : null], $s); return true; } @@ -561,9 +719,13 @@ protected function parseChunk() list(, $if) = $last; if ($this->literal('@else', 5)) { - if ($this->matchChar('{')) { + if ($this->matchChar('{', false)) { $else = $this->pushSpecialBlock(Type::T_ELSE, $s); - } elseif ($this->literal('if', 2) && $this->valueList($cond) && $this->matchChar('{')) { + } elseif ( + $this->literal('if', 2) && + $this->valueList($cond) && + $this->matchChar('{', false) + ) { $else = $this->pushSpecialBlock(Type::T_ELSEIF, $s); $else->cond = $cond; } @@ -580,7 +742,8 @@ protected function parseChunk() } // only retain the first @charset directive encountered - if ($this->literal('@charset', 8) && + if ( + $this->literal('@charset', 8) && $this->valueList($charset) && $this->end() ) { @@ -601,12 +764,31 @@ protected function parseChunk() $this->seek($s); + if ( + $this->literal('@supports', 9) && + ($t1 = $this->supportsQuery($supportQuery)) && + ($t2 = $this->matchChar('{', false)) + ) { + $directive = $this->pushSpecialBlock(Type::T_DIRECTIVE, $s); + $directive->name = 'supports'; + $directive->value = $supportQuery; + + return true; + } + + $this->seek($s); + // doesn't match built in directive, do generic one - if ($this->matchChar('@', false) && - $this->keyword($dirName) && - ($this->variable($dirValue) || $this->openString('{', $dirValue) || true) && - $this->matchChar('{') + if ( + $this->matchChar('@', false) && + $this->mixedKeyword($dirName) && + $this->directiveValue($dirValue, '{') ) { + if (count($dirName) === 1 && is_string(reset($dirName))) { + $dirName = reset($dirName); + } else { + $dirName = [Type::T_STRING, '', $dirName]; + } if ($dirName === 'media') { $directive = $this->pushSpecialBlock(Type::T_MEDIA, $s); } else { @@ -615,6 +797,7 @@ protected function parseChunk() } if (isset($dirValue)) { + ! $this->cssOnly || ($dirValue = $this->assertPlainCssValid($dirValue)); $directive->value = $dirValue; } @@ -623,12 +806,102 @@ protected function parseChunk() $this->seek($s); + // maybe it's a generic blockless directive + if ( + $this->matchChar('@', false) && + $this->mixedKeyword($dirName) && + ! $this->isKnownGenericDirective($dirName) && + ($this->end(false) || ($this->directiveValue($dirValue, '') && $this->end(false))) + ) { + if (\count($dirName) === 1 && \is_string(\reset($dirName))) { + $dirName = \reset($dirName); + } else { + $dirName = [Type::T_STRING, '', $dirName]; + } + if ( + ! empty($this->env->parent) && + $this->env->type && + ! \in_array($this->env->type, [Type::T_DIRECTIVE, Type::T_MEDIA]) + ) { + $plain = \trim(\substr($this->buffer, $s, $this->count - $s)); + $this->throwParseError( + "Unknown directive `{$plain}` not allowed in `" . $this->env->type . "` block" + ); + } + // blockless directives with a blank line after keeps their blank lines after + // sass-spec compliance purpose + $s = $this->count; + $hasBlankLine = false; + if ($this->match('\s*?\n\s*\n', $out, false)) { + $hasBlankLine = true; + $this->seek($s); + } + $isNotRoot = ! empty($this->env->parent); + $this->append([Type::T_DIRECTIVE, [$dirName, $dirValue, $hasBlankLine, $isNotRoot]], $s); + $this->whitespace(); + + return true; + } + + $this->seek($s); + return false; } + $inCssSelector = null; + if ($this->cssOnly) { + $inCssSelector = (! empty($this->env->parent) && + ! in_array($this->env->type, [Type::T_DIRECTIVE, Type::T_MEDIA])); + } + // custom properties : right part is static + if (($this->customProperty($name) ) && $this->matchChar(':', false)) { + $start = $this->count; + + // but can be complex and finish with ; or } + foreach ([';','}'] as $ending) { + if ( + $this->openString($ending, $stringValue, '(', ')', false) && + $this->end() + ) { + $end = $this->count; + $value = $stringValue; + + // check if we have only a partial value due to nested [] or { } to take in account + $nestingPairs = [['[', ']'], ['{', '}']]; + + foreach ($nestingPairs as $nestingPair) { + $p = strpos($this->buffer, $nestingPair[0], $start); + + if ($p && $p < $end) { + $this->seek($start); + + if ( + $this->openString($ending, $stringValue, $nestingPair[0], $nestingPair[1], false) && + $this->end() && + $this->count > $end + ) { + $end = $this->count; + $value = $stringValue; + } + } + } + + $this->seek($end); + $this->append([Type::T_CUSTOM_PROPERTY, $name, $value], $s); + + return true; + } + } + + // TODO: output an error here if nothing found according to sass spec + } + + $this->seek($s); + // property shortcut // captures most properties before having to parse a selector - if ($this->keyword($name, false) && + if ( + $this->keyword($name, false) && $this->literal(': ', 2) && $this->valueList($value) && $this->end() @@ -642,11 +915,14 @@ protected function parseChunk() $this->seek($s); // variable assigns - if ($this->variable($name) && + if ( + $this->variable($name) && $this->matchChar(':') && $this->valueList($value) && $this->end() ) { + ! $this->cssOnly || $this->assertPlainCssValid(false, $s); + // check for '!flag' $assignmentFlags = $this->stripAssignmentFlags($value); $this->append([Type::T_ASSIGN, $name, $value, $assignmentFlags], $s); @@ -662,12 +938,17 @@ protected function parseChunk() } // opening css block - if ($this->selectors($selectors) && $this->matchChar('{', false)) { + if ( + $this->selectors($selectors) && + $this->matchChar('{', false) + ) { + ! $this->cssOnly || ! $inCssSelector || $this->assertPlainCssValid(false); + $this->pushBlock($selectors, $s); if ($this->eatWhiteDefault) { $this->whitespace(); - $this->append(null); // collect comments at the begining if needed + $this->append(null); // collect comments at the beginning if needed } return true; @@ -676,7 +957,10 @@ protected function parseChunk() $this->seek($s); // property assign, or nested assign - if ($this->propertyName($name) && $this->matchChar(':')) { + if ( + $this->propertyName($name) && + $this->matchChar(':') + ) { $foundSomething = false; if ($this->valueList($value)) { @@ -688,9 +972,13 @@ protected function parseChunk() $foundSomething = true; } - if ($this->matchChar('{')) { + if ($this->matchChar('{', false)) { + ! $this->cssOnly || $this->assertPlainCssValid(false); + $propBlock = $this->pushSpecialBlock(Type::T_NESTED_PROPERTY, $s); $propBlock->prefix = $name; + $propBlock->hasValue = $foundSomething; + $foundSomething = true; } elseif ($foundSomething) { $foundSomething = $this->end(); @@ -704,9 +992,15 @@ protected function parseChunk() $this->seek($s); // closing a block - if ($this->matchChar('}')) { + if ($this->matchChar('}', false)) { $block = $this->popBlock(); + if (! isset($block->type) || $block->type !== Type::T_IF) { + if ($this->env->parent) { + $this->append(null); // collect comments before next statement if needed + } + } + if (isset($block->type) && $block->type === Type::T_INCLUDE) { $include = $block->child; unset($block->child); @@ -717,11 +1011,21 @@ protected function parseChunk() $this->append([$type, $block], $s); } + // collect comments just after the block closing if needed + if ($this->eatWhiteDefault) { + $this->whitespace(); + + if ($this->env->comments) { + $this->append(null); + } + } + return true; } // extra stuff - if ($this->matchChar(';') || + if ( + $this->matchChar(';') || $this->literal('