259 lines
6.2 KiB
PHP
259 lines
6.2 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of Twig.
|
|
*
|
|
* (c) Fabien Potencier
|
|
* (c) Armin Ronacher
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Twig;
|
|
|
|
use Twig\Node\Node;
|
|
|
|
/**
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
|
*/
|
|
class Compiler
|
|
{
|
|
private $lastLine;
|
|
private $source;
|
|
private $indentation;
|
|
private $env;
|
|
private $debugInfo = [];
|
|
private $sourceOffset;
|
|
private $sourceLine;
|
|
private $varNameSalt = 0;
|
|
private $didUseEcho = false;
|
|
private $didUseEchoStack = [];
|
|
|
|
public function __construct(Environment $env)
|
|
{
|
|
$this->env = $env;
|
|
}
|
|
|
|
public function getEnvironment(): Environment
|
|
{
|
|
return $this->env;
|
|
}
|
|
|
|
public function getSource(): string
|
|
{
|
|
return $this->source;
|
|
}
|
|
|
|
/**
|
|
* @return $this
|
|
*/
|
|
public function reset(int $indentation = 0)
|
|
{
|
|
$this->lastLine = null;
|
|
$this->source = '';
|
|
$this->debugInfo = [];
|
|
$this->sourceOffset = 0;
|
|
// source code starts at 1 (as we then increment it when we encounter new lines)
|
|
$this->sourceLine = 1;
|
|
$this->indentation = $indentation;
|
|
$this->varNameSalt = 0;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return $this
|
|
*/
|
|
public function compile(Node $node, int $indentation = 0)
|
|
{
|
|
$this->reset($indentation);
|
|
$this->didUseEchoStack[] = $this->didUseEcho;
|
|
|
|
try {
|
|
$this->didUseEcho = false;
|
|
$node->compile($this);
|
|
|
|
if ($this->didUseEcho) {
|
|
trigger_deprecation('twig/twig', '3.9', 'Using "%s" is deprecated, use "yield" instead in "%s", then flag the class with #[YieldReady].', $this->didUseEcho, \get_class($node));
|
|
}
|
|
|
|
return $this;
|
|
} finally {
|
|
$this->didUseEcho = array_pop($this->didUseEchoStack);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return $this
|
|
*/
|
|
public function subcompile(Node $node, bool $raw = true)
|
|
{
|
|
if (!$raw) {
|
|
$this->source .= str_repeat(' ', $this->indentation * 4);
|
|
}
|
|
|
|
$this->didUseEchoStack[] = $this->didUseEcho;
|
|
|
|
try {
|
|
$this->didUseEcho = false;
|
|
$node->compile($this);
|
|
|
|
if ($this->didUseEcho) {
|
|
trigger_deprecation('twig/twig', '3.9', 'Using "%s" is deprecated, use "yield" instead in "%s", then flag the class with #[YieldReady].', $this->didUseEcho, \get_class($node));
|
|
}
|
|
|
|
return $this;
|
|
} finally {
|
|
$this->didUseEcho = array_pop($this->didUseEchoStack);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds a raw string to the compiled code.
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function raw(string $string)
|
|
{
|
|
$this->checkForEcho($string);
|
|
$this->source .= $string;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Writes a string to the compiled code by adding indentation.
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function write(...$strings)
|
|
{
|
|
foreach ($strings as $string) {
|
|
$this->checkForEcho($string);
|
|
$this->source .= str_repeat(' ', $this->indentation * 4).$string;
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Adds a quoted string to the compiled code.
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function string(string $value)
|
|
{
|
|
$this->source .= sprintf('"%s"', addcslashes($value, "\0\t\"\$\\"));
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Returns a PHP representation of a given value.
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function repr($value)
|
|
{
|
|
if (\is_int($value) || \is_float($value)) {
|
|
if (false !== $locale = setlocale(\LC_NUMERIC, '0')) {
|
|
setlocale(\LC_NUMERIC, 'C');
|
|
}
|
|
|
|
$this->raw(var_export($value, true));
|
|
|
|
if (false !== $locale) {
|
|
setlocale(\LC_NUMERIC, $locale);
|
|
}
|
|
} elseif (null === $value) {
|
|
$this->raw('null');
|
|
} elseif (\is_bool($value)) {
|
|
$this->raw($value ? 'true' : 'false');
|
|
} elseif (\is_array($value)) {
|
|
$this->raw('array(');
|
|
$first = true;
|
|
foreach ($value as $key => $v) {
|
|
if (!$first) {
|
|
$this->raw(', ');
|
|
}
|
|
$first = false;
|
|
$this->repr($key);
|
|
$this->raw(' => ');
|
|
$this->repr($v);
|
|
}
|
|
$this->raw(')');
|
|
} else {
|
|
$this->string($value);
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return $this
|
|
*/
|
|
public function addDebugInfo(Node $node)
|
|
{
|
|
if ($node->getTemplateLine() != $this->lastLine) {
|
|
$this->write(sprintf("// line %d\n", $node->getTemplateLine()));
|
|
|
|
$this->sourceLine += substr_count($this->source, "\n", $this->sourceOffset);
|
|
$this->sourceOffset = \strlen($this->source);
|
|
$this->debugInfo[$this->sourceLine] = $node->getTemplateLine();
|
|
|
|
$this->lastLine = $node->getTemplateLine();
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function getDebugInfo(): array
|
|
{
|
|
ksort($this->debugInfo);
|
|
|
|
return $this->debugInfo;
|
|
}
|
|
|
|
/**
|
|
* @return $this
|
|
*/
|
|
public function indent(int $step = 1)
|
|
{
|
|
$this->indentation += $step;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return $this
|
|
*
|
|
* @throws \LogicException When trying to outdent too much so the indentation would become negative
|
|
*/
|
|
public function outdent(int $step = 1)
|
|
{
|
|
// can't outdent by more steps than the current indentation level
|
|
if ($this->indentation < $step) {
|
|
throw new \LogicException('Unable to call outdent() as the indentation would become negative.');
|
|
}
|
|
|
|
$this->indentation -= $step;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function getVarName(): string
|
|
{
|
|
return sprintf('__internal_compile_%d', $this->varNameSalt++);
|
|
}
|
|
|
|
private function checkForEcho(string $string): void
|
|
{
|
|
if ($this->didUseEcho) {
|
|
return;
|
|
}
|
|
|
|
$this->didUseEcho = preg_match('/^\s*+(echo|print)\b/', $string, $m) ? $m[1] : false;
|
|
}
|
|
}
|