279 lines
8.6 KiB
PHP
279 lines
8.6 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of Mustache.php.
|
|
*
|
|
* (c) 2012 Justin Hileman
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
/**
|
|
* Mustache Tokenizer class.
|
|
*
|
|
* This class is responsible for turning raw template source into a set of Mustache tokens.
|
|
*/
|
|
class Mustache_Tokenizer
|
|
{
|
|
|
|
// Finite state machine states
|
|
const IN_TEXT = 0;
|
|
const IN_TAG_TYPE = 1;
|
|
const IN_TAG = 2;
|
|
|
|
// Token types
|
|
const T_SECTION = '#';
|
|
const T_INVERTED = '^';
|
|
const T_END_SECTION = '/';
|
|
const T_COMMENT = '!';
|
|
const T_PARTIAL = '>';
|
|
const T_PARTIAL_2 = '<';
|
|
const T_DELIM_CHANGE = '=';
|
|
const T_ESCAPED = '_v';
|
|
const T_UNESCAPED = '{';
|
|
const T_UNESCAPED_2 = '&';
|
|
const T_TEXT = '_t';
|
|
const T_PRAGMA = '%';
|
|
|
|
// Valid token types
|
|
private static $tagTypes = array(
|
|
self::T_SECTION => true,
|
|
self::T_INVERTED => true,
|
|
self::T_END_SECTION => true,
|
|
self::T_COMMENT => true,
|
|
self::T_PARTIAL => true,
|
|
self::T_PARTIAL_2 => true,
|
|
self::T_DELIM_CHANGE => true,
|
|
self::T_ESCAPED => true,
|
|
self::T_UNESCAPED => true,
|
|
self::T_UNESCAPED_2 => true,
|
|
self::T_PRAGMA => true,
|
|
);
|
|
|
|
// Interpolated tags
|
|
private static $interpolatedTags = array(
|
|
self::T_ESCAPED => true,
|
|
self::T_UNESCAPED => true,
|
|
self::T_UNESCAPED_2 => true,
|
|
);
|
|
|
|
// Token properties
|
|
const TYPE = 'type';
|
|
const NAME = 'name';
|
|
const OTAG = 'otag';
|
|
const CTAG = 'ctag';
|
|
const LINE = 'line';
|
|
const INDEX = 'index';
|
|
const END = 'end';
|
|
const INDENT = 'indent';
|
|
const NODES = 'nodes';
|
|
const VALUE = 'value';
|
|
|
|
private $state;
|
|
private $tagType;
|
|
private $tag;
|
|
private $buffer;
|
|
private $tokens;
|
|
private $seenTag;
|
|
private $line;
|
|
private $otag;
|
|
private $ctag;
|
|
|
|
/**
|
|
* Scan and tokenize template source.
|
|
*
|
|
* @param string $text Mustache template source to tokenize
|
|
* @param string $delimiters Optionally, pass initial opening and closing delimiters (default: null)
|
|
*
|
|
* @return array Set of Mustache tokens
|
|
*/
|
|
public function scan($text, $delimiters = null)
|
|
{
|
|
$this->reset();
|
|
|
|
if ($delimiters = trim($delimiters)) {
|
|
list($otag, $ctag) = explode(' ', $delimiters);
|
|
$this->otag = $otag;
|
|
$this->ctag = $ctag;
|
|
}
|
|
|
|
$len = strlen($text);
|
|
for ($i = 0; $i < $len; $i++) {
|
|
switch ($this->state) {
|
|
case self::IN_TEXT:
|
|
if ($this->tagChange($this->otag, $text, $i)) {
|
|
$i--;
|
|
$this->flushBuffer();
|
|
$this->state = self::IN_TAG_TYPE;
|
|
} else {
|
|
$char = substr($text, $i, 1);
|
|
$this->buffer .= $char;
|
|
if ($char == "\n") {
|
|
$this->flushBuffer();
|
|
$this->line++;
|
|
}
|
|
}
|
|
break;
|
|
|
|
case self::IN_TAG_TYPE:
|
|
$i += strlen($this->otag) - 1;
|
|
$char = substr($text, $i + 1, 1);
|
|
if (isset(self::$tagTypes[$char])) {
|
|
$tag = $char;
|
|
$this->tagType = $tag;
|
|
} else {
|
|
$tag = null;
|
|
$this->tagType = self::T_ESCAPED;
|
|
}
|
|
|
|
if ($this->tagType === self::T_DELIM_CHANGE) {
|
|
$i = $this->changeDelimiters($text, $i);
|
|
$this->state = self::IN_TEXT;
|
|
} elseif ($this->tagType === self::T_PRAGMA) {
|
|
$i = $this->addPragma($text, $i);
|
|
$this->state = self::IN_TEXT;
|
|
} else {
|
|
if ($tag !== null) {
|
|
$i++;
|
|
}
|
|
$this->state = self::IN_TAG;
|
|
}
|
|
$this->seenTag = $i;
|
|
break;
|
|
|
|
default:
|
|
if ($this->tagChange($this->ctag, $text, $i)) {
|
|
$this->tokens[] = array(
|
|
self::TYPE => $this->tagType,
|
|
self::NAME => trim($this->buffer),
|
|
self::OTAG => $this->otag,
|
|
self::CTAG => $this->ctag,
|
|
self::LINE => $this->line,
|
|
self::INDEX => ($this->tagType == self::T_END_SECTION) ? $this->seenTag - strlen($this->otag) : $i + strlen($this->ctag)
|
|
);
|
|
|
|
$this->buffer = '';
|
|
$i += strlen($this->ctag) - 1;
|
|
$this->state = self::IN_TEXT;
|
|
if ($this->tagType == self::T_UNESCAPED) {
|
|
if ($this->ctag == '}}') {
|
|
$i++;
|
|
} else {
|
|
// Clean up `{{{ tripleStache }}}` style tokens.
|
|
$lastName = $this->tokens[count($this->tokens) - 1][self::NAME];
|
|
if (substr($lastName, -1) === '}') {
|
|
$this->tokens[count($this->tokens) - 1][self::NAME] = trim(substr($lastName, 0, -1));
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
$this->buffer .= substr($text, $i, 1);
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
$this->flushBuffer();
|
|
|
|
return $this->tokens;
|
|
}
|
|
|
|
/**
|
|
* Helper function to reset tokenizer internal state.
|
|
*/
|
|
private function reset()
|
|
{
|
|
$this->state = self::IN_TEXT;
|
|
$this->tagType = null;
|
|
$this->tag = null;
|
|
$this->buffer = '';
|
|
$this->tokens = array();
|
|
$this->seenTag = false;
|
|
$this->line = 0;
|
|
$this->otag = '{{';
|
|
$this->ctag = '}}';
|
|
}
|
|
|
|
/**
|
|
* Flush the current buffer to a token.
|
|
*/
|
|
private function flushBuffer()
|
|
{
|
|
if (!empty($this->buffer)) {
|
|
$this->tokens[] = array(
|
|
self::TYPE => self::T_TEXT,
|
|
self::LINE => $this->line,
|
|
self::VALUE => $this->buffer
|
|
);
|
|
$this->buffer = '';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Change the current Mustache delimiters. Set new `otag` and `ctag` values.
|
|
*
|
|
* @param string $text Mustache template source
|
|
* @param int $index Current tokenizer index
|
|
*
|
|
* @return int New index value
|
|
*/
|
|
private function changeDelimiters($text, $index)
|
|
{
|
|
$startIndex = strpos($text, '=', $index) + 1;
|
|
$close = '='.$this->ctag;
|
|
$closeIndex = strpos($text, $close, $index);
|
|
|
|
list($otag, $ctag) = explode(' ', trim(substr($text, $startIndex, $closeIndex - $startIndex)));
|
|
$this->otag = $otag;
|
|
$this->ctag = $ctag;
|
|
|
|
$this->tokens[] = array(
|
|
self::TYPE => self::T_DELIM_CHANGE,
|
|
self::LINE => $this->line,
|
|
);
|
|
|
|
return $closeIndex + strlen($close) - 1;
|
|
}
|
|
|
|
/**
|
|
* Add pragma token.
|
|
*
|
|
* Pragmas are hoisted to the front of the template, so all pragma tokens
|
|
* will appear at the front of the token list.
|
|
*
|
|
* @param string $text
|
|
* @param int $index
|
|
*
|
|
* @return int New index value
|
|
*/
|
|
private function addPragma($text, $index)
|
|
{
|
|
$end = strpos($text, $this->ctag, $index);
|
|
$pragma = trim(substr($text, $index + 2, $end - $index - 2));
|
|
|
|
// Pragmas are hoisted to the front of the template.
|
|
array_unshift($this->tokens, array(
|
|
self::TYPE => self::T_PRAGMA,
|
|
self::NAME => $pragma,
|
|
self::LINE => 0,
|
|
));
|
|
|
|
return $end + strlen($this->ctag) - 1;
|
|
}
|
|
|
|
/**
|
|
* Test whether it's time to change tags.
|
|
*
|
|
* @param string $tag Current tag name
|
|
* @param string $text Mustache template source
|
|
* @param int $index Current tokenizer index
|
|
*
|
|
* @return boolean True if this is a closing section tag
|
|
*/
|
|
private function tagChange($tag, $text, $index)
|
|
{
|
|
return substr($text, $index, strlen($tag)) === $tag;
|
|
}
|
|
}
|