[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /*
   4   * This file is part of Twig.
   5   *
   6   * (c) Fabien Potencier
   7   * (c) Armin Ronacher
   8   *
   9   * For the full copyright and license information, please view the LICENSE
  10   * file that was distributed with this source code.
  11   */
  12  
  13  namespace Twig;
  14  
  15  use Twig\Error\SyntaxError;
  16  
  17  /**
  18   * Represents a token stream.
  19   *
  20   * @final
  21   *
  22   * @author Fabien Potencier <fabien@symfony.com>
  23   */
  24  class TokenStream
  25  {
  26      protected $tokens;
  27      protected $current = 0;
  28      protected $filename;
  29  
  30      private $source;
  31  
  32      /**
  33       * @param array       $tokens An array of tokens
  34       * @param string|null $name   The name of the template which tokens are associated with
  35       * @param string|null $source The source code associated with the tokens
  36       */
  37      public function __construct(array $tokens, $name = null, $source = null)
  38      {
  39          if (!$name instanceof Source) {
  40              if (null !== $name || null !== $source) {
  41                  @trigger_error(sprintf('Passing a string as the $name argument of %s() is deprecated since version 1.27. Pass a \Twig\Source instance instead.', __METHOD__), E_USER_DEPRECATED);
  42              }
  43              $this->source = new Source($source, $name);
  44          } else {
  45              $this->source = $name;
  46          }
  47  
  48          $this->tokens = $tokens;
  49  
  50          // deprecated, not used anymore, to be removed in 2.0
  51          $this->filename = $this->source->getName();
  52      }
  53  
  54      public function __toString()
  55      {
  56          return implode("\n", $this->tokens);
  57      }
  58  
  59      public function injectTokens(array $tokens)
  60      {
  61          $this->tokens = array_merge(\array_slice($this->tokens, 0, $this->current), $tokens, \array_slice($this->tokens, $this->current));
  62      }
  63  
  64      /**
  65       * Sets the pointer to the next token and returns the old one.
  66       *
  67       * @return Token
  68       */
  69      public function next()
  70      {
  71          if (!isset($this->tokens[++$this->current])) {
  72              throw new SyntaxError('Unexpected end of template.', $this->tokens[$this->current - 1]->getLine(), $this->source);
  73          }
  74  
  75          return $this->tokens[$this->current - 1];
  76      }
  77  
  78      /**
  79       * Tests a token, sets the pointer to the next one and returns it or throws a syntax error.
  80       *
  81       * @return Token|null The next token if the condition is true, null otherwise
  82       */
  83      public function nextIf($primary, $secondary = null)
  84      {
  85          if ($this->tokens[$this->current]->test($primary, $secondary)) {
  86              return $this->next();
  87          }
  88      }
  89  
  90      /**
  91       * Tests a token and returns it or throws a syntax error.
  92       *
  93       * @return Token
  94       */
  95      public function expect($type, $value = null, $message = null)
  96      {
  97          $token = $this->tokens[$this->current];
  98          if (!$token->test($type, $value)) {
  99              $line = $token->getLine();
 100              throw new SyntaxError(sprintf('%sUnexpected token "%s"%s ("%s" expected%s).',
 101                  $message ? $message.'. ' : '',
 102                  Token::typeToEnglish($token->getType()),
 103                  $token->getValue() ? sprintf(' of value "%s"', $token->getValue()) : '',
 104                  Token::typeToEnglish($type), $value ? sprintf(' with value "%s"', $value) : ''),
 105                  $line,
 106                  $this->source
 107              );
 108          }
 109          $this->next();
 110  
 111          return $token;
 112      }
 113  
 114      /**
 115       * Looks at the next token.
 116       *
 117       * @param int $number
 118       *
 119       * @return Token
 120       */
 121      public function look($number = 1)
 122      {
 123          if (!isset($this->tokens[$this->current + $number])) {
 124              throw new SyntaxError('Unexpected end of template.', $this->tokens[$this->current + $number - 1]->getLine(), $this->source);
 125          }
 126  
 127          return $this->tokens[$this->current + $number];
 128      }
 129  
 130      /**
 131       * Tests the current token.
 132       *
 133       * @return bool
 134       */
 135      public function test($primary, $secondary = null)
 136      {
 137          return $this->tokens[$this->current]->test($primary, $secondary);
 138      }
 139  
 140      /**
 141       * Checks if end of stream was reached.
 142       *
 143       * @return bool
 144       */
 145      public function isEOF()
 146      {
 147          return Token::EOF_TYPE === $this->tokens[$this->current]->getType();
 148      }
 149  
 150      /**
 151       * @return Token
 152       */
 153      public function getCurrent()
 154      {
 155          return $this->tokens[$this->current];
 156      }
 157  
 158      /**
 159       * Gets the name associated with this stream (null if not defined).
 160       *
 161       * @return string|null
 162       *
 163       * @deprecated since 1.27 (to be removed in 2.0)
 164       */
 165      public function getFilename()
 166      {
 167          @trigger_error(sprintf('The %s() method is deprecated since version 1.27 and will be removed in 2.0. Use getSourceContext() instead.', __METHOD__), E_USER_DEPRECATED);
 168  
 169          return $this->source->getName();
 170      }
 171  
 172      /**
 173       * Gets the source code associated with this stream.
 174       *
 175       * @return string
 176       *
 177       * @internal Don't use this as it might be empty depending on the environment configuration
 178       *
 179       * @deprecated since 1.27 (to be removed in 2.0)
 180       */
 181      public function getSource()
 182      {
 183          @trigger_error(sprintf('The %s() method is deprecated since version 1.27 and will be removed in 2.0. Use getSourceContext() instead.', __METHOD__), E_USER_DEPRECATED);
 184  
 185          return $this->source->getCode();
 186      }
 187  
 188      /**
 189       * Gets the source associated with this stream.
 190       *
 191       * @return Source
 192       *
 193       * @internal
 194       */
 195      public function getSourceContext()
 196      {
 197          return $this->source;
 198      }
 199  }
 200  
 201  class_alias('Twig\TokenStream', 'Twig_TokenStream');