tests/PHPUnit/PHP/Token.php

   1 <?php
   2 /**
   3  * php-token-stream
   4  *
   5  * Copyright (c) 2009-2010, Sebastian Bergmann <sb@sebastian-bergmann.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @package   PHP_TokenStream
  38  * @author    Sebastian Bergmann <sb@sebastian-bergmann.de>
  39  * @copyright 2009-2010 Sebastian Bergmann <sb@sebastian-bergmann.de>
  40  * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
  41  * @since     File available since Release 1.0.0
  42  */
  43
  44 require_once 'PHP/Token/Exception.php';
  45
  46 /**
  47  * A PHP token.
  48  *
  49  * @author    Sebastian Bergmann <sb@sebastian-bergmann.de>
  50  * @copyright 2009-2010 Sebastian Bergmann <sb@sebastian-bergmann.de>
  51  * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
  52  * @version   Release: 1.0.1
  53  * @link      http://github.com/sebastianbergmann/php-token-stream/tree
  54  * @since     Class available since Release 1.0.0
  55  */
  56 abstract class PHP_Token
  57 {
  58     /**
  59      * @var string
  60      */
  61     protected $text;
  62
  63     /**
  64      * @var integer
  65      */
  66     protected $line;
  67
  68     /**
  69      * @var PHP_Token_Stream
  70      */
  71     protected $tokenStream;
  72
  73     /**
  74      * @var integer
  75      */
  76     protected $id;
  77
  78     /**
  79      * Constructor.
  80      *
  81      * @param string           $text
  82      * @param integer          $line
  83      * @param PHP_Token_Stream $tokenStream
  84      * @param integer          $id
  85      */
  86     public function __construct($text, $line, PHP_Token_Stream $tokenStream, $id)
  87     {
  88         $this->text        = $text;
  89         $this->line        = $line;
  90         $this->tokenStream = $tokenStream;
  91         $this->id          = $id;
  92     }
  93
  94     /**
  95      * @return string
  96      */
  97     public function __toString()
  98     {
  99         return $this->text;
 100     }
 101
 102     /**
 103      * @return integer
 104      */
 105     public function getLine()
 106     {
 107         return $this->line;
 108     }
 109 }
 110
 111 abstract class PHP_TokenWithScope extends PHP_Token
 112 {
 113     protected $endTokenId;
 114
 115     public function getDocblock()
 116     {
 117         $tokens = $this->tokenStream->tokens();
 118
 119         for ($i = $this->id - 2; $i > $this->id - 6; $i -= 2) {
 120             if (isset($tokens[$i]) &&
 121                 $tokens[$i] instanceof PHP_Token_DOC_COMMENT) {
 122                 return (string)$tokens[$i];
 123             }
 124         }
 125     }
 126
 127     public function getEndTokenId()
 128     {
 129         $block  = 0;
 130         $i      = $this->id;
 131         $tokens = $this->tokenStream->tokens();
 132
 133         while ($this->endTokenId === NULL && isset($tokens[$i])) {
 134             if ($tokens[$i] instanceof PHP_Token_OPEN_CURLY) {
 135                 $block++;
 136             }
 137
 138             else if ($tokens[$i] instanceof PHP_Token_CLOSE_CURLY) {
 139                 $block--;
 140
 141                 if ($block === 0) {
 142                     $this->endTokenId = $i;
 143                 }
 144             }
 145
 146             $i++;
 147         }
 148
 149         if ($this->endTokenId === NULL) {
 150             $this->endTokenId = $this->id;
 151         }
 152
 153         return $this->endTokenId;
 154     }
 155
 156     public function getEndLine()
 157     {
 158         return $this->tokenStream[$this->getEndTokenId()]->getLine();
 159     }
 160 }
 161
 162 class PHP_Token_REQUIRE_ONCE extends PHP_Token {}
 163 class PHP_Token_REQUIRE extends PHP_Token {}
 164 class PHP_Token_EVAL extends PHP_Token {}
 165 class PHP_Token_INCLUDE_ONCE extends PHP_Token {}
 166 class PHP_Token_INCLUDE extends PHP_Token {}
 167 class PHP_Token_LOGICAL_OR extends PHP_Token {}
 168 class PHP_Token_LOGICAL_XOR extends PHP_Token {}
 169 class PHP_Token_LOGICAL_AND extends PHP_Token {}
 170 class PHP_Token_PRINT extends PHP_Token {}
 171 class PHP_Token_SR_EQUAL extends PHP_Token {}
 172 class PHP_Token_SL_EQUAL extends PHP_Token {}
 173 class PHP_Token_XOR_EQUAL extends PHP_Token {}
 174 class PHP_Token_OR_EQUAL extends PHP_Token {}
 175 class PHP_Token_AND_EQUAL extends PHP_Token {}
 176 class PHP_Token_MOD_EQUAL extends PHP_Token {}
 177 class PHP_Token_CONCAT_EQUAL extends PHP_Token {}
 178 class PHP_Token_DIV_EQUAL extends PHP_Token {}
 179 class PHP_Token_MUL_EQUAL extends PHP_Token {}
 180 class PHP_Token_MINUS_EQUAL extends PHP_Token {}
 181 class PHP_Token_PLUS_EQUAL extends PHP_Token {}
 182 class PHP_Token_BOOLEAN_OR extends PHP_Token {}
 183 class PHP_Token_BOOLEAN_AND extends PHP_Token {}
 184 class PHP_Token_IS_NOT_IDENTICAL extends PHP_Token {}
 185 class PHP_Token_IS_IDENTICAL extends PHP_Token {}
 186 class PHP_Token_IS_NOT_EQUAL extends PHP_Token {}
 187 class PHP_Token_IS_EQUAL extends PHP_Token {}
 188 class PHP_Token_IS_GREATER_OR_EQUAL extends PHP_Token {}
 189 class PHP_Token_IS_SMALLER_OR_EQUAL extends PHP_Token {}
 190 class PHP_Token_SR extends PHP_Token {}
 191 class PHP_Token_SL extends PHP_Token {}
 192 class PHP_Token_INSTANCEOF extends PHP_Token {}
 193 class PHP_Token_UNSET_CAST extends PHP_Token {}
 194 class PHP_Token_BOOL_CAST extends PHP_Token {}
 195 class PHP_Token_OBJECT_CAST extends PHP_Token {}
 196 class PHP_Token_ARRAY_CAST extends PHP_Token {}
 197 class PHP_Token_STRING_CAST extends PHP_Token {}
 198 class PHP_Token_DOUBLE_CAST extends PHP_Token {}
 199 class PHP_Token_INT_CAST extends PHP_Token {}
 200 class PHP_Token_DEC extends PHP_Token {}
 201 class PHP_Token_INC extends PHP_Token {}
 202 class PHP_Token_CLONE extends PHP_Token {}
 203 class PHP_Token_NEW extends PHP_Token {}
 204 class PHP_Token_EXIT extends PHP_Token {}
 205 class PHP_Token_IF extends PHP_Token {}
 206 class PHP_Token_ELSEIF extends PHP_Token {}
 207 class PHP_Token_ELSE extends PHP_Token {}
 208 class PHP_Token_ENDIF extends PHP_Token {}
 209 class PHP_Token_LNUMBER extends PHP_Token {}
 210 class PHP_Token_DNUMBER extends PHP_Token {}
 211 class PHP_Token_STRING extends PHP_Token {}
 212 class PHP_Token_STRING_VARNAME extends PHP_Token {}
 213 class PHP_Token_VARIABLE extends PHP_Token {}
 214 class PHP_Token_NUM_STRING extends PHP_Token {}
 215 class PHP_Token_INLINE_HTML extends PHP_Token {}
 216 class PHP_Token_CHARACTER extends PHP_Token {}
 217 class PHP_Token_BAD_CHARACTER extends PHP_Token {}
 218 class PHP_Token_ENCAPSED_AND_WHITESPACE extends PHP_Token {}
 219 class PHP_Token_CONSTANT_ENCAPSED_STRING extends PHP_Token {}
 220 class PHP_Token_ECHO extends PHP_Token {}
 221 class PHP_Token_DO extends PHP_Token {}
 222 class PHP_Token_WHILE extends PHP_Token {}
 223 class PHP_Token_ENDWHILE extends PHP_Token {}
 224 class PHP_Token_FOR extends PHP_Token {}
 225 class PHP_Token_ENDFOR extends PHP_Token {}
 226 class PHP_Token_FOREACH extends PHP_Token {}
 227 class PHP_Token_ENDFOREACH extends PHP_Token {}
 228 class PHP_Token_DECLARE extends PHP_Token {}
 229 class PHP_Token_ENDDECLARE extends PHP_Token {}
 230 class PHP_Token_AS extends PHP_Token {}
 231 class PHP_Token_SWITCH extends PHP_Token {}
 232 class PHP_Token_ENDSWITCH extends PHP_Token {}
 233 class PHP_Token_CASE extends PHP_Token {}
 234 class PHP_Token_DEFAULT extends PHP_Token {}
 235 class PHP_Token_BREAK extends PHP_Token {}
 236 class PHP_Token_CONTINUE extends PHP_Token {}
 237 class PHP_Token_GOTO extends PHP_Token {}
 238
 239 class PHP_Token_FUNCTION extends PHP_TokenWithScope
 240 {
 241     protected $arguments;
 242     protected $ccn;
 243     protected $name;
 244     protected $signature;
 245
 246     public function getArguments()
 247     {
 248         if ($this->arguments !== NULL) {
 249             return $this->arguments;
 250         }
 251
 252         $this->arguments = array();
 253         $i               = $this->id + 3;
 254         $tokens          = $this->tokenStream->tokens();
 255         $typeHint        = NULL;
 256
 257         while (!$tokens[$i] instanceof PHP_Token_CLOSE_BRACKET) {
 258             if ($tokens[$i] instanceof PHP_Token_STRING) {
 259                 $typeHint = (string)$tokens[$i];
 260             }
 261
 262             else if ($tokens[$i] instanceof PHP_Token_VARIABLE) {
 263                 $this->arguments[(string)$tokens[$i]] = $typeHint;
 264                 $typeHint                             = NULL;
 265             }
 266
 267             $i++;
 268         }
 269
 270         return $this->arguments;
 271     }
 272
 273     public function getName()
 274     {
 275         if ($this->name !== NULL) {
 276             return $this->name;
 277         }
 278
 279         $tokens = $this->tokenStream->tokens();
 280
 281         if ($tokens[$this->id+2] instanceof PHP_Token_STRING) {
 282             $this->name = (string)$tokens[$this->id+2];
 283         }
 284
 285         else if ($tokens[$this->id+2] instanceof PHP_Token_AMPERSAND &&
 286                  $tokens[$this->id+3] instanceof PHP_Token_STRING) {
 287             $this->name = (string)$tokens[$this->id+3];
 288         }
 289
 290         else {
 291             $this->name = 'anonymous function';
 292         }
 293
 294         return $this->name;
 295     }
 296
 297     public function getCCN()
 298     {
 299         if ($this->ccn !== NULL) {
 300             return $this->ccn;
 301         }
 302
 303         $this->ccn = 1;
 304         $end       = $this->getEndTokenId();
 305         $tokens    = $this->tokenStream->tokens();
 306
 307         for ($i = $this->id; $i <= $end; $i++) {
 308             switch (get_class($tokens[$i])) {
 309                 case 'PHP_Token_IF':
 310                 case 'PHP_Token_ELSEIF':
 311                 case 'PHP_Token_FOR':
 312                 case 'PHP_Token_FOREACH':
 313                 case 'PHP_Token_WHILE':
 314                 case 'PHP_Token_CASE':
 315                 case 'PHP_Token_CATCH':
 316                 case 'PHP_Token_BOOLEAN_AND':
 317                 case 'PHP_Token_LOGICAL_AND':
 318                 case 'PHP_Token_BOOLEAN_OR':
 319                 case 'PHP_Token_LOGICAL_OR':
 320                 case 'PHP_Token_QUESTION_MARK': {
 321                     $this->ccn++;
 322                 }
 323                 break;
 324             }
 325         }
 326
 327         return $this->ccn;
 328     }
 329
 330     public function getSignature()
 331     {
 332         if ($this->signature !== NULL) {
 333             return $this->signature;
 334         }
 335
 336         $this->signature = '';
 337
 338         $i      = $this->id + 2;
 339         $tokens = $this->tokenStream->tokens();
 340
 341         while (!$tokens[$i] instanceof PHP_Token_CLOSE_BRACKET) {
 342             $this->signature .= $tokens[$i++];
 343         }
 344
 345         $this->signature .= ')';
 346
 347         return $this->signature;
 348     }
 349 }
 350
 351 class PHP_Token_CONST extends PHP_Token {}
 352 class PHP_Token_RETURN extends PHP_Token {}
 353 class PHP_Token_TRY extends PHP_Token {}
 354 class PHP_Token_CATCH extends PHP_Token {}
 355 class PHP_Token_THROW extends PHP_Token {}
 356 class PHP_Token_USE extends PHP_Token {}
 357 class PHP_Token_GLOBAL extends PHP_Token {}
 358 class PHP_Token_PUBLIC extends PHP_Token {}
 359 class PHP_Token_PROTECTED extends PHP_Token {}
 360 class PHP_Token_PRIVATE extends PHP_Token {}
 361 class PHP_Token_FINAL extends PHP_Token {}
 362 class PHP_Token_ABSTRACT extends PHP_Token {}
 363 class PHP_Token_STATIC extends PHP_Token {}
 364 class PHP_Token_VAR extends PHP_Token {}
 365 class PHP_Token_UNSET extends PHP_Token {}
 366 class PHP_Token_ISSET extends PHP_Token {}
 367 class PHP_Token_EMPTY extends PHP_Token {}
 368 class PHP_Token_HALT_COMPILER extends PHP_Token {}
 369
 370 class PHP_Token_INTERFACE extends PHP_TokenWithScope
 371 {
 372     public function getName()
 373     {
 374         return (string)$this->tokenStream[$this->id + 2];
 375     }
 376
 377     public function hasParent()
 378     {
 379         return $this->tokenStream[$this->id + 4] instanceof PHP_Token_EXTENDS;
 380     }
 381
 382     public function getParent()
 383     {
 384         if (!$this->hasParent()) {
 385             return FALSE;
 386         }
 387
 388         $i         = $this->id + 6;
 389         $tokens    = $this->tokenStream->tokens();
 390         $className = (string)$tokens[$i];
 391
 392         while (!$tokens[$i+1] instanceof PHP_Token_WHITESPACE) {
 393             $className .= (string)$tokens[++$i];
 394         }
 395
 396         return $className;
 397     }
 398 }
 399
 400 class PHP_Token_CLASS extends PHP_Token_INTERFACE {}
 401 class PHP_Token_EXTENDS extends PHP_Token {}
 402 class PHP_Token_IMPLEMENTS extends PHP_Token {}
 403 class PHP_Token_OBJECT_OPERATOR extends PHP_Token {}
 404 class PHP_Token_DOUBLE_ARROW extends PHP_Token {}
 405 class PHP_Token_LIST extends PHP_Token {}
 406 class PHP_Token_ARRAY extends PHP_Token {}
 407 class PHP_Token_CLASS_C extends PHP_Token {}
 408 class PHP_Token_METHOD_C extends PHP_Token {}
 409 class PHP_Token_FUNC_C extends PHP_Token {}
 410 class PHP_Token_LINE extends PHP_Token {}
 411 class PHP_Token_FILE extends PHP_Token {}
 412 class PHP_Token_COMMENT extends PHP_Token {}
 413 class PHP_Token_DOC_COMMENT extends PHP_Token {}
 414 class PHP_Token_OPEN_TAG extends PHP_Token {}
 415 class PHP_Token_OPEN_TAG_WITH_ECHO extends PHP_Token {}
 416 class PHP_Token_CLOSE_TAG extends PHP_Token {}
 417 class PHP_Token_WHITESPACE extends PHP_Token {}
 418 class PHP_Token_START_HEREDOC extends PHP_Token {}
 419 class PHP_Token_END_HEREDOC extends PHP_Token {}
 420 class PHP_Token_DOLLAR_OPEN_CURLY_BRACES extends PHP_Token {}
 421 class PHP_Token_CURLY_OPEN extends PHP_Token {}
 422 class PHP_Token_PAAMAYIM_NEKUDOTAYIM extends PHP_Token {}
 423
 424 class PHP_Token_NAMESPACE extends PHP_Token
 425 {
 426     public function getName()
 427     {
 428         $tokens    = $this->tokenStream->tokens();
 429         $namespace = (string)$tokens[$this->id+2];
 430
 431         for ($i = $this->id + 3; ; $i += 2) {
 432             if (isset($tokens[$i]) &&
 433                 $tokens[$i] instanceof PHP_Token_NS_SEPARATOR) {
 434                 $namespace .= '\\' . $tokens[$i+1];
 435             } else {
 436                 break;
 437             }
 438         }
 439
 440         return $namespace;
 441     }
 442 }
 443
 444 class PHP_Token_NS_C extends PHP_Token {}
 445 class PHP_Token_DIR extends PHP_Token {}
 446 class PHP_Token_NS_SEPARATOR extends PHP_Token {}
 447 class PHP_Token_DOUBLE_COLON extends PHP_Token {}
 448 class PHP_Token_OPEN_BRACKET extends PHP_Token {}
 449 class PHP_Token_CLOSE_BRACKET extends PHP_Token {}
 450 class PHP_Token_OPEN_SQUARE extends PHP_Token {}
 451 class PHP_Token_CLOSE_SQUARE extends PHP_Token {}
 452 class PHP_Token_OPEN_CURLY extends PHP_Token {}
 453 class PHP_Token_CLOSE_CURLY extends PHP_Token {}
 454 class PHP_Token_SEMICOLON extends PHP_Token {}
 455 class PHP_Token_DOT extends PHP_Token {}
 456 class PHP_Token_COMMA extends PHP_Token {}
 457 class PHP_Token_EQUAL extends PHP_Token {}
 458 class PHP_Token_LT extends PHP_Token {}
 459 class PHP_Token_GT extends PHP_Token {}
 460 class PHP_Token_PLUS extends PHP_Token {}
 461 class PHP_Token_MINUS extends PHP_Token {}
 462 class PHP_Token_MULT extends PHP_Token {}
 463 class PHP_Token_DIV extends PHP_Token {}
 464 class PHP_Token_QUESTION_MARK extends PHP_Token {}
 465 class PHP_Token_EXCLAMATION_MARK extends PHP_Token {}
 466 class PHP_Token_COLON extends PHP_Token {}
 467 class PHP_Token_DOUBLE_QUOTES extends PHP_Token {}
 468 class PHP_Token_AT extends PHP_Token {}
 469 class PHP_Token_AMPERSAND extends PHP_Token {}
 470 class PHP_Token_PERCENT extends PHP_Token {}
 471 class PHP_Token_PIPE extends PHP_Token {}
 472 class PHP_Token_DOLLAR extends PHP_Token {}
 473 class PHP_Token_CARET extends PHP_Token {}
 474 class PHP_Token_TILDE extends PHP_Token {}
 475 class PHP_Token_BACKTICK extends PHP_Token {}