vendor/doctrine/common/lib/Doctrine/Common/Annotations/DocLexer.php

   1 <?php
   2 /*
   3  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   4  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   5  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   6  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   7  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   8  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   9  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14  *
  15  * This software consists of voluntary contributions made by many individuals
  16  * and is licensed under the MIT license. For more information, see
  17  * <http://www.doctrine-project.org>.
  18  */
  19
  20 namespace Doctrine\Common\Annotations;
  21
  22 use Doctrine\Common\Lexer;
  23
  24 /**
  25  * Simple lexer for docblock annotations.
  26  *
  27  * @author Benjamin Eberlei <kontakt@beberlei.de>
  28  * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
  29  * @author Jonathan Wage <jonwage@gmail.com>
  30  * @author Roman Borschel <roman@code-factory.org>
  31  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  32  */
  33 final class DocLexer extends Lexer
  34 {
  35     const T_NONE                = 1;
  36     const T_INTEGER             = 2;
  37     const T_STRING              = 3;
  38     const T_FLOAT               = 4;
  39
  40     // All tokens that are also identifiers should be >= 100
  41     const T_IDENTIFIER          = 100;
  42     const T_AT                  = 101;
  43     const T_CLOSE_CURLY_BRACES  = 102;
  44     const T_CLOSE_PARENTHESIS   = 103;
  45     const T_COMMA               = 104;
  46     const T_EQUALS              = 105;
  47     const T_FALSE               = 106;
  48     const T_NAMESPACE_SEPARATOR = 107;
  49     const T_OPEN_CURLY_BRACES   = 108;
  50     const T_OPEN_PARENTHESIS    = 109;
  51     const T_TRUE                = 110;
  52     const T_NULL                = 111;
  53     const T_COLON               = 112;
  54
  55     protected $noCase = array(
  56         '@'  => self::T_AT,
  57         ','  => self::T_COMMA,
  58         '('  => self::T_OPEN_PARENTHESIS,
  59         ')'  => self::T_CLOSE_PARENTHESIS,
  60         '{'  => self::T_OPEN_CURLY_BRACES,
  61         '}'  => self::T_CLOSE_CURLY_BRACES,
  62         '='  => self::T_EQUALS,
  63         ':'  => self::T_COLON,
  64         '\\' => self::T_NAMESPACE_SEPARATOR
  65     );
  66
  67     protected $withCase = array(
  68         'true'  => self::T_TRUE,
  69         'false' => self::T_FALSE,
  70         'null'  => self::T_NULL
  71     );
  72
  73     /**
  74      * {@inheritdoc}
  75      */
  76     protected function getCatchablePatterns()
  77     {
  78         return array(
  79             '[a-z_\\\][a-z0-9_\:\\\]*[a-z]{1}',
  80             '(?:[+-]?[0-9]+(?:[\.][0-9]+)*)(?:[eE][+-]?[0-9]+)?',
  81             '"(?:[^"]|"")*"',
  82         );
  83     }
  84
  85     /**
  86      * {@inheritdoc}
  87      */
  88     protected function getNonCatchablePatterns()
  89     {
  90         return array('\s+', '\*+', '(.)');
  91     }
  92
  93     /**
  94      * {@inheritdoc}
  95      *
  96      * @param string $value
  97      *
  98      * @return int
  99      */
 100     protected function getType(&$value)
 101     {
 102         $type = self::T_NONE;
 103
 104         if ($value[0] === '"') {
 105             $value = str_replace('""', '"', substr($value, 1, strlen($value) - 2));
 106
 107             return self::T_STRING;
 108         }
 109
 110         if (isset($this->noCase[$value])) {
 111             return $this->noCase[$value];
 112         }
 113
 114         if ($value[0] === '_' || $value[0] === '\\' || ctype_alpha($value[0])) {
 115             return self::T_IDENTIFIER;
 116         }
 117
 118         $lowerValue = strtolower($value);
 119
 120         if (isset($this->withCase[$lowerValue])) {
 121             return $this->withCase[$lowerValue];
 122         }
 123
 124         // Checking numeric value
 125         if (is_numeric($value)) {
 126             return (strpos($value, '.') !== false || stripos($value, 'e') !== false)
 127                 ? self::T_FLOAT : self::T_INTEGER;
 128         }
 129
 130         return $type;
 131     }
 132 }