Chris@17: <?php
Chris@17: /**
Chris@17:  * Stores weightings and groupings of tokens.
Chris@17:  *
Chris@17:  * @author    Greg Sherwood <gsherwood@squiz.net>
Chris@17:  * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
Chris@17:  * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
Chris@17:  */
Chris@17: 
Chris@17: namespace PHP_CodeSniffer\Util;
Chris@17: 
Chris@17: define('T_NONE', 'PHPCS_T_NONE');
Chris@17: define('T_OPEN_CURLY_BRACKET', 'PHPCS_T_OPEN_CURLY_BRACKET');
Chris@17: define('T_CLOSE_CURLY_BRACKET', 'PHPCS_T_CLOSE_CURLY_BRACKET');
Chris@17: define('T_OPEN_SQUARE_BRACKET', 'PHPCS_T_OPEN_SQUARE_BRACKET');
Chris@17: define('T_CLOSE_SQUARE_BRACKET', 'PHPCS_T_CLOSE_SQUARE_BRACKET');
Chris@17: define('T_OPEN_PARENTHESIS', 'PHPCS_T_OPEN_PARENTHESIS');
Chris@17: define('T_CLOSE_PARENTHESIS', 'PHPCS_T_CLOSE_PARENTHESIS');
Chris@17: define('T_COLON', 'PHPCS_T_COLON');
Chris@17: define('T_NULLABLE', 'PHPCS_T_NULLABLE');
Chris@17: define('T_STRING_CONCAT', 'PHPCS_T_STRING_CONCAT');
Chris@17: define('T_INLINE_THEN', 'PHPCS_T_INLINE_THEN');
Chris@17: define('T_INLINE_ELSE', 'PHPCS_T_INLINE_ELSE');
Chris@17: define('T_NULL', 'PHPCS_T_NULL');
Chris@17: define('T_FALSE', 'PHPCS_T_FALSE');
Chris@17: define('T_TRUE', 'PHPCS_T_TRUE');
Chris@17: define('T_SEMICOLON', 'PHPCS_T_SEMICOLON');
Chris@17: define('T_EQUAL', 'PHPCS_T_EQUAL');
Chris@17: define('T_MULTIPLY', 'PHPCS_T_MULTIPLY');
Chris@17: define('T_DIVIDE', 'PHPCS_T_DIVIDE');
Chris@17: define('T_PLUS', 'PHPCS_T_PLUS');
Chris@17: define('T_MINUS', 'PHPCS_T_MINUS');
Chris@17: define('T_MODULUS', 'PHPCS_T_MODULUS');
Chris@17: define('T_BITWISE_AND', 'PHPCS_T_BITWISE_AND');
Chris@17: define('T_BITWISE_OR', 'PHPCS_T_BITWISE_OR');
Chris@17: define('T_BITWISE_XOR', 'PHPCS_T_BITWISE_XOR');
Chris@17: define('T_BITWISE_NOT', 'PHPCS_T_BITWISE_NOT');
Chris@17: define('T_ARRAY_HINT', 'PHPCS_T_ARRAY_HINT');
Chris@17: define('T_GREATER_THAN', 'PHPCS_T_GREATER_THAN');
Chris@17: define('T_LESS_THAN', 'PHPCS_T_LESS_THAN');
Chris@17: define('T_BOOLEAN_NOT', 'PHPCS_T_BOOLEAN_NOT');
Chris@17: define('T_SELF', 'PHPCS_T_SELF');
Chris@17: define('T_PARENT', 'PHPCS_T_PARENT');
Chris@17: define('T_DOUBLE_QUOTED_STRING', 'PHPCS_T_DOUBLE_QUOTED_STRING');
Chris@17: define('T_COMMA', 'PHPCS_T_COMMA');
Chris@17: define('T_HEREDOC', 'PHPCS_T_HEREDOC');
Chris@17: define('T_PROTOTYPE', 'PHPCS_T_PROTOTYPE');
Chris@17: define('T_THIS', 'PHPCS_T_THIS');
Chris@17: define('T_REGULAR_EXPRESSION', 'PHPCS_T_REGULAR_EXPRESSION');
Chris@17: define('T_PROPERTY', 'PHPCS_T_PROPERTY');
Chris@17: define('T_LABEL', 'PHPCS_T_LABEL');
Chris@17: define('T_OBJECT', 'PHPCS_T_OBJECT');
Chris@17: define('T_CLOSE_OBJECT', 'PHPCS_T_CLOSE_OBJECT');
Chris@17: define('T_COLOUR', 'PHPCS_T_COLOUR');
Chris@17: define('T_HASH', 'PHPCS_T_HASH');
Chris@17: define('T_URL', 'PHPCS_T_URL');
Chris@17: define('T_STYLE', 'PHPCS_T_STYLE');
Chris@17: define('T_ASPERAND', 'PHPCS_T_ASPERAND');
Chris@17: define('T_DOLLAR', 'PHPCS_T_DOLLAR');
Chris@17: define('T_TYPEOF', 'PHPCS_T_TYPEOF');
Chris@17: define('T_CLOSURE', 'PHPCS_T_CLOSURE');
Chris@17: define('T_ANON_CLASS', 'PHPCS_T_ANON_CLASS');
Chris@17: define('T_BACKTICK', 'PHPCS_T_BACKTICK');
Chris@17: define('T_START_NOWDOC', 'PHPCS_T_START_NOWDOC');
Chris@17: define('T_NOWDOC', 'PHPCS_T_NOWDOC');
Chris@17: define('T_END_NOWDOC', 'PHPCS_T_END_NOWDOC');
Chris@17: define('T_OPEN_SHORT_ARRAY', 'PHPCS_T_OPEN_SHORT_ARRAY');
Chris@17: define('T_CLOSE_SHORT_ARRAY', 'PHPCS_T_CLOSE_SHORT_ARRAY');
Chris@17: define('T_GOTO_LABEL', 'PHPCS_T_GOTO_LABEL');
Chris@17: define('T_BINARY_CAST', 'PHPCS_T_BINARY_CAST');
Chris@17: define('T_EMBEDDED_PHP', 'PHPCS_T_EMBEDDED_PHP');
Chris@17: define('T_RETURN_TYPE', 'PHPCS_T_RETURN_TYPE');
Chris@17: define('T_OPEN_USE_GROUP', 'PHPCS_T_OPEN_USE_GROUP');
Chris@17: define('T_CLOSE_USE_GROUP', 'PHPCS_T_CLOSE_USE_GROUP');
Chris@17: define('T_ZSR', 'PHPCS_T_ZSR');
Chris@17: define('T_ZSR_EQUAL', 'PHPCS_T_ZSR_EQUAL');
Chris@17: 
Chris@17: // Some PHP 5.5 tokens, replicated for lower versions.
Chris@17: if (defined('T_FINALLY') === false) {
Chris@17:     define('T_FINALLY', 'PHPCS_T_FINALLY');
Chris@17: }
Chris@17: 
Chris@17: if (defined('T_YIELD') === false) {
Chris@17:     define('T_YIELD', 'PHPCS_T_YIELD');
Chris@17: }
Chris@17: 
Chris@17: // Some PHP 5.6 tokens, replicated for lower versions.
Chris@17: if (defined('T_ELLIPSIS') === false) {
Chris@17:     define('T_ELLIPSIS', 'PHPCS_T_ELLIPSIS');
Chris@17: }
Chris@17: 
Chris@17: if (defined('T_POW') === false) {
Chris@17:     define('T_POW', 'PHPCS_T_POW');
Chris@17: }
Chris@17: 
Chris@17: if (defined('T_POW_EQUAL') === false) {
Chris@17:     define('T_POW_EQUAL', 'PHPCS_T_POW_EQUAL');
Chris@17: }
Chris@17: 
Chris@17: // Some PHP 7 tokens, replicated for lower versions.
Chris@17: if (defined('T_SPACESHIP') === false) {
Chris@17:     define('T_SPACESHIP', 'PHPCS_T_SPACESHIP');
Chris@17: }
Chris@17: 
Chris@17: if (defined('T_COALESCE') === false) {
Chris@17:     define('T_COALESCE', 'PHPCS_T_COALESCE');
Chris@17: }
Chris@17: 
Chris@17: if (defined('T_COALESCE_EQUAL') === false) {
Chris@17:     define('T_COALESCE_EQUAL', 'PHPCS_T_COALESCE_EQUAL');
Chris@17: }
Chris@17: 
Chris@17: if (defined('T_YIELD_FROM') === false) {
Chris@17:     define('T_YIELD_FROM', 'PHPCS_T_YIELD_FROM');
Chris@17: }
Chris@17: 
Chris@17: // Tokens used for parsing doc blocks.
Chris@17: define('T_DOC_COMMENT_STAR', 'PHPCS_T_DOC_COMMENT_STAR');
Chris@17: define('T_DOC_COMMENT_WHITESPACE', 'PHPCS_T_DOC_COMMENT_WHITESPACE');
Chris@17: define('T_DOC_COMMENT_TAG', 'PHPCS_T_DOC_COMMENT_TAG');
Chris@17: define('T_DOC_COMMENT_OPEN_TAG', 'PHPCS_T_DOC_COMMENT_OPEN_TAG');
Chris@17: define('T_DOC_COMMENT_CLOSE_TAG', 'PHPCS_T_DOC_COMMENT_CLOSE_TAG');
Chris@17: define('T_DOC_COMMENT_STRING', 'PHPCS_T_DOC_COMMENT_STRING');
Chris@17: 
Chris@17: // Tokens used for PHPCS instruction comments.
Chris@17: define('T_PHPCS_ENABLE', 'PHPCS_T_PHPCS_ENABLE');
Chris@17: define('T_PHPCS_DISABLE', 'PHPCS_T_PHPCS_DISABLE');
Chris@17: define('T_PHPCS_SET', 'PHPCS_T_PHPCS_SET');
Chris@17: define('T_PHPCS_IGNORE', 'PHPCS_T_PHPCS_IGNORE');
Chris@17: define('T_PHPCS_IGNORE_FILE', 'PHPCS_T_PHPCS_IGNORE_FILE');
Chris@17: 
Chris@17: final class Tokens
Chris@17: {
Chris@17: 
Chris@17:     /**
Chris@17:      * The token weightings.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $weightings = [
Chris@17:         T_CLASS               => 1000,
Chris@17:         T_INTERFACE           => 1000,
Chris@17:         T_TRAIT               => 1000,
Chris@17:         T_NAMESPACE           => 1000,
Chris@17:         T_FUNCTION            => 100,
Chris@17:         T_CLOSURE             => 100,
Chris@17: 
Chris@17:         /*
Chris@17:          * Conditions.
Chris@17:          */
Chris@17: 
Chris@17:         T_WHILE               => 50,
Chris@17:         T_FOR                 => 50,
Chris@17:         T_FOREACH             => 50,
Chris@17:         T_IF                  => 50,
Chris@17:         T_ELSE                => 50,
Chris@17:         T_ELSEIF              => 50,
Chris@17:         T_DO                  => 50,
Chris@17:         T_TRY                 => 50,
Chris@17:         T_CATCH               => 50,
Chris@17:         T_FINALLY             => 50,
Chris@17:         T_SWITCH              => 50,
Chris@17: 
Chris@17:         T_SELF                => 25,
Chris@17:         T_PARENT              => 25,
Chris@17: 
Chris@17:         /*
Chris@17:          * Operators and arithmetic.
Chris@17:          */
Chris@17: 
Chris@17:         T_BITWISE_AND         => 8,
Chris@17:         T_BITWISE_OR          => 8,
Chris@17:         T_BITWISE_XOR         => 8,
Chris@17: 
Chris@17:         T_MULTIPLY            => 5,
Chris@17:         T_DIVIDE              => 5,
Chris@17:         T_PLUS                => 5,
Chris@17:         T_MINUS               => 5,
Chris@17:         T_MODULUS             => 5,
Chris@17:         T_POW                 => 5,
Chris@17:         T_SPACESHIP           => 5,
Chris@17:         T_COALESCE            => 5,
Chris@17:         T_COALESCE_EQUAL      => 5,
Chris@17: 
Chris@17:         T_SL                  => 5,
Chris@17:         T_SR                  => 5,
Chris@17:         T_SL_EQUAL            => 5,
Chris@17:         T_SR_EQUAL            => 5,
Chris@17: 
Chris@17:         T_EQUAL               => 5,
Chris@17:         T_AND_EQUAL           => 5,
Chris@17:         T_CONCAT_EQUAL        => 5,
Chris@17:         T_DIV_EQUAL           => 5,
Chris@17:         T_MINUS_EQUAL         => 5,
Chris@17:         T_MOD_EQUAL           => 5,
Chris@17:         T_MUL_EQUAL           => 5,
Chris@17:         T_OR_EQUAL            => 5,
Chris@17:         T_PLUS_EQUAL          => 5,
Chris@17:         T_XOR_EQUAL           => 5,
Chris@17: 
Chris@17:         T_BOOLEAN_AND         => 5,
Chris@17:         T_BOOLEAN_OR          => 5,
Chris@17: 
Chris@17:         /*
Chris@17:          * Equality.
Chris@17:          */
Chris@17: 
Chris@17:         T_IS_EQUAL            => 5,
Chris@17:         T_IS_NOT_EQUAL        => 5,
Chris@17:         T_IS_IDENTICAL        => 5,
Chris@17:         T_IS_NOT_IDENTICAL    => 5,
Chris@17:         T_IS_SMALLER_OR_EQUAL => 5,
Chris@17:         T_IS_GREATER_OR_EQUAL => 5,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that represent assignments.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $assignmentTokens = [
Chris@17:         T_EQUAL          => T_EQUAL,
Chris@17:         T_AND_EQUAL      => T_AND_EQUAL,
Chris@17:         T_OR_EQUAL       => T_OR_EQUAL,
Chris@17:         T_CONCAT_EQUAL   => T_CONCAT_EQUAL,
Chris@17:         T_DIV_EQUAL      => T_DIV_EQUAL,
Chris@17:         T_MINUS_EQUAL    => T_MINUS_EQUAL,
Chris@17:         T_POW_EQUAL      => T_POW_EQUAL,
Chris@17:         T_MOD_EQUAL      => T_MOD_EQUAL,
Chris@17:         T_MUL_EQUAL      => T_MUL_EQUAL,
Chris@17:         T_PLUS_EQUAL     => T_PLUS_EQUAL,
Chris@17:         T_XOR_EQUAL      => T_XOR_EQUAL,
Chris@17:         T_DOUBLE_ARROW   => T_DOUBLE_ARROW,
Chris@17:         T_SL_EQUAL       => T_SL_EQUAL,
Chris@17:         T_SR_EQUAL       => T_SR_EQUAL,
Chris@17:         T_COALESCE_EQUAL => T_COALESCE_EQUAL,
Chris@17:         T_ZSR_EQUAL      => T_ZSR_EQUAL,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that represent equality comparisons.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $equalityTokens = [
Chris@17:         T_IS_EQUAL            => T_IS_EQUAL,
Chris@17:         T_IS_NOT_EQUAL        => T_IS_NOT_EQUAL,
Chris@17:         T_IS_IDENTICAL        => T_IS_IDENTICAL,
Chris@17:         T_IS_NOT_IDENTICAL    => T_IS_NOT_IDENTICAL,
Chris@17:         T_IS_SMALLER_OR_EQUAL => T_IS_SMALLER_OR_EQUAL,
Chris@17:         T_IS_GREATER_OR_EQUAL => T_IS_GREATER_OR_EQUAL,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that represent comparison operator.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $comparisonTokens = [
Chris@17:         T_IS_EQUAL            => T_IS_EQUAL,
Chris@17:         T_IS_IDENTICAL        => T_IS_IDENTICAL,
Chris@17:         T_IS_NOT_EQUAL        => T_IS_NOT_EQUAL,
Chris@17:         T_IS_NOT_IDENTICAL    => T_IS_NOT_IDENTICAL,
Chris@17:         T_LESS_THAN           => T_LESS_THAN,
Chris@17:         T_GREATER_THAN        => T_GREATER_THAN,
Chris@17:         T_IS_SMALLER_OR_EQUAL => T_IS_SMALLER_OR_EQUAL,
Chris@17:         T_IS_GREATER_OR_EQUAL => T_IS_GREATER_OR_EQUAL,
Chris@17:         T_SPACESHIP           => T_SPACESHIP,
Chris@17:         T_COALESCE            => T_COALESCE,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that represent arithmetic operators.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $arithmeticTokens = [
Chris@17:         T_PLUS     => T_PLUS,
Chris@17:         T_MINUS    => T_MINUS,
Chris@17:         T_MULTIPLY => T_MULTIPLY,
Chris@17:         T_DIVIDE   => T_DIVIDE,
Chris@17:         T_MODULUS  => T_MODULUS,
Chris@17:         T_POW      => T_POW,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that perform operations.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $operators = [
Chris@17:         T_MINUS       => T_MINUS,
Chris@17:         T_PLUS        => T_PLUS,
Chris@17:         T_MULTIPLY    => T_MULTIPLY,
Chris@17:         T_DIVIDE      => T_DIVIDE,
Chris@17:         T_MODULUS     => T_MODULUS,
Chris@17:         T_POW         => T_POW,
Chris@17:         T_SPACESHIP   => T_SPACESHIP,
Chris@17:         T_COALESCE    => T_COALESCE,
Chris@17:         T_BITWISE_AND => T_BITWISE_AND,
Chris@17:         T_BITWISE_OR  => T_BITWISE_OR,
Chris@17:         T_BITWISE_XOR => T_BITWISE_XOR,
Chris@17:         T_SL          => T_SL,
Chris@17:         T_SR          => T_SR,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that perform boolean operations.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $booleanOperators = [
Chris@17:         T_BOOLEAN_AND => T_BOOLEAN_AND,
Chris@17:         T_BOOLEAN_OR  => T_BOOLEAN_OR,
Chris@17:         T_LOGICAL_AND => T_LOGICAL_AND,
Chris@17:         T_LOGICAL_OR  => T_LOGICAL_OR,
Chris@17:         T_LOGICAL_XOR => T_LOGICAL_XOR,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that represent casting.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $castTokens = [
Chris@17:         T_INT_CAST    => T_INT_CAST,
Chris@17:         T_STRING_CAST => T_STRING_CAST,
Chris@17:         T_DOUBLE_CAST => T_DOUBLE_CAST,
Chris@17:         T_ARRAY_CAST  => T_ARRAY_CAST,
Chris@17:         T_BOOL_CAST   => T_BOOL_CAST,
Chris@17:         T_OBJECT_CAST => T_OBJECT_CAST,
Chris@17:         T_UNSET_CAST  => T_UNSET_CAST,
Chris@17:         T_BINARY_CAST => T_BINARY_CAST,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Token types that open parenthesis.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $parenthesisOpeners = [
Chris@17:         T_ARRAY    => T_ARRAY,
Chris@17:         T_FUNCTION => T_FUNCTION,
Chris@17:         T_CLOSURE  => T_CLOSURE,
Chris@17:         T_WHILE    => T_WHILE,
Chris@17:         T_FOR      => T_FOR,
Chris@17:         T_FOREACH  => T_FOREACH,
Chris@17:         T_SWITCH   => T_SWITCH,
Chris@17:         T_IF       => T_IF,
Chris@17:         T_ELSEIF   => T_ELSEIF,
Chris@17:         T_CATCH    => T_CATCH,
Chris@17:         T_DECLARE  => T_DECLARE,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that are allowed to open scopes.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $scopeOpeners = [
Chris@17:         T_CLASS      => T_CLASS,
Chris@17:         T_ANON_CLASS => T_ANON_CLASS,
Chris@17:         T_INTERFACE  => T_INTERFACE,
Chris@17:         T_TRAIT      => T_TRAIT,
Chris@17:         T_NAMESPACE  => T_NAMESPACE,
Chris@17:         T_FUNCTION   => T_FUNCTION,
Chris@17:         T_CLOSURE    => T_CLOSURE,
Chris@17:         T_IF         => T_IF,
Chris@17:         T_SWITCH     => T_SWITCH,
Chris@17:         T_CASE       => T_CASE,
Chris@17:         T_DECLARE    => T_DECLARE,
Chris@17:         T_DEFAULT    => T_DEFAULT,
Chris@17:         T_WHILE      => T_WHILE,
Chris@17:         T_ELSE       => T_ELSE,
Chris@17:         T_ELSEIF     => T_ELSEIF,
Chris@17:         T_FOR        => T_FOR,
Chris@17:         T_FOREACH    => T_FOREACH,
Chris@17:         T_DO         => T_DO,
Chris@17:         T_TRY        => T_TRY,
Chris@17:         T_CATCH      => T_CATCH,
Chris@17:         T_FINALLY    => T_FINALLY,
Chris@17:         T_PROPERTY   => T_PROPERTY,
Chris@17:         T_OBJECT     => T_OBJECT,
Chris@17:         T_USE        => T_USE,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that represent scope modifiers.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $scopeModifiers = [
Chris@17:         T_PRIVATE   => T_PRIVATE,
Chris@17:         T_PUBLIC    => T_PUBLIC,
Chris@17:         T_PROTECTED => T_PROTECTED,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that can prefix a method name
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $methodPrefixes = [
Chris@17:         T_PRIVATE   => T_PRIVATE,
Chris@17:         T_PUBLIC    => T_PUBLIC,
Chris@17:         T_PROTECTED => T_PROTECTED,
Chris@17:         T_ABSTRACT  => T_ABSTRACT,
Chris@17:         T_STATIC    => T_STATIC,
Chris@17:         T_FINAL     => T_FINAL,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that open code blocks.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $blockOpeners = [
Chris@17:         T_OPEN_CURLY_BRACKET  => T_OPEN_CURLY_BRACKET,
Chris@17:         T_OPEN_SQUARE_BRACKET => T_OPEN_SQUARE_BRACKET,
Chris@17:         T_OPEN_PARENTHESIS    => T_OPEN_PARENTHESIS,
Chris@17:         T_OBJECT              => T_OBJECT,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that don't represent code.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $emptyTokens = [
Chris@17:         T_WHITESPACE             => T_WHITESPACE,
Chris@17:         T_COMMENT                => T_COMMENT,
Chris@17:         T_DOC_COMMENT            => T_DOC_COMMENT,
Chris@17:         T_DOC_COMMENT_STAR       => T_DOC_COMMENT_STAR,
Chris@17:         T_DOC_COMMENT_WHITESPACE => T_DOC_COMMENT_WHITESPACE,
Chris@17:         T_DOC_COMMENT_TAG        => T_DOC_COMMENT_TAG,
Chris@17:         T_DOC_COMMENT_OPEN_TAG   => T_DOC_COMMENT_OPEN_TAG,
Chris@17:         T_DOC_COMMENT_CLOSE_TAG  => T_DOC_COMMENT_CLOSE_TAG,
Chris@17:         T_DOC_COMMENT_STRING     => T_DOC_COMMENT_STRING,
Chris@17:         T_PHPCS_ENABLE           => T_PHPCS_ENABLE,
Chris@17:         T_PHPCS_DISABLE          => T_PHPCS_DISABLE,
Chris@17:         T_PHPCS_SET              => T_PHPCS_SET,
Chris@17:         T_PHPCS_IGNORE           => T_PHPCS_IGNORE,
Chris@17:         T_PHPCS_IGNORE_FILE      => T_PHPCS_IGNORE_FILE,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that are comments.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $commentTokens = [
Chris@17:         T_COMMENT                => T_COMMENT,
Chris@17:         T_DOC_COMMENT            => T_DOC_COMMENT,
Chris@17:         T_DOC_COMMENT_STAR       => T_DOC_COMMENT_STAR,
Chris@17:         T_DOC_COMMENT_WHITESPACE => T_DOC_COMMENT_WHITESPACE,
Chris@17:         T_DOC_COMMENT_TAG        => T_DOC_COMMENT_TAG,
Chris@17:         T_DOC_COMMENT_OPEN_TAG   => T_DOC_COMMENT_OPEN_TAG,
Chris@17:         T_DOC_COMMENT_CLOSE_TAG  => T_DOC_COMMENT_CLOSE_TAG,
Chris@17:         T_DOC_COMMENT_STRING     => T_DOC_COMMENT_STRING,
Chris@17:         T_PHPCS_ENABLE           => T_PHPCS_ENABLE,
Chris@17:         T_PHPCS_DISABLE          => T_PHPCS_DISABLE,
Chris@17:         T_PHPCS_SET              => T_PHPCS_SET,
Chris@17:         T_PHPCS_IGNORE           => T_PHPCS_IGNORE,
Chris@17:         T_PHPCS_IGNORE_FILE      => T_PHPCS_IGNORE_FILE,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that are comments containing PHPCS instructions.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $phpcsCommentTokens = [
Chris@17:         T_PHPCS_ENABLE      => T_PHPCS_ENABLE,
Chris@17:         T_PHPCS_DISABLE     => T_PHPCS_DISABLE,
Chris@17:         T_PHPCS_SET         => T_PHPCS_SET,
Chris@17:         T_PHPCS_IGNORE      => T_PHPCS_IGNORE,
Chris@17:         T_PHPCS_IGNORE_FILE => T_PHPCS_IGNORE_FILE,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that represent strings.
Chris@17:      *
Chris@17:      * Note that T_STRINGS are NOT represented in this list.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $stringTokens = [
Chris@17:         T_CONSTANT_ENCAPSED_STRING => T_CONSTANT_ENCAPSED_STRING,
Chris@17:         T_DOUBLE_QUOTED_STRING     => T_DOUBLE_QUOTED_STRING,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that represent text strings.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $textStringTokens = [
Chris@17:         T_CONSTANT_ENCAPSED_STRING => T_CONSTANT_ENCAPSED_STRING,
Chris@17:         T_DOUBLE_QUOTED_STRING     => T_DOUBLE_QUOTED_STRING,
Chris@17:         T_INLINE_HTML              => T_INLINE_HTML,
Chris@17:         T_HEREDOC                  => T_HEREDOC,
Chris@17:         T_NOWDOC                   => T_NOWDOC,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that represent brackets and parenthesis.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $bracketTokens = [
Chris@17:         T_OPEN_CURLY_BRACKET   => T_OPEN_CURLY_BRACKET,
Chris@17:         T_CLOSE_CURLY_BRACKET  => T_CLOSE_CURLY_BRACKET,
Chris@17:         T_OPEN_SQUARE_BRACKET  => T_OPEN_SQUARE_BRACKET,
Chris@17:         T_CLOSE_SQUARE_BRACKET => T_CLOSE_SQUARE_BRACKET,
Chris@17:         T_OPEN_PARENTHESIS     => T_OPEN_PARENTHESIS,
Chris@17:         T_CLOSE_PARENTHESIS    => T_CLOSE_PARENTHESIS,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that include files.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $includeTokens = [
Chris@17:         T_REQUIRE_ONCE => T_REQUIRE_ONCE,
Chris@17:         T_REQUIRE      => T_REQUIRE,
Chris@17:         T_INCLUDE_ONCE => T_INCLUDE_ONCE,
Chris@17:         T_INCLUDE      => T_INCLUDE,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that make up a heredoc string.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $heredocTokens = [
Chris@17:         T_START_HEREDOC => T_START_HEREDOC,
Chris@17:         T_END_HEREDOC   => T_END_HEREDOC,
Chris@17:         T_HEREDOC       => T_HEREDOC,
Chris@17:         T_START_NOWDOC  => T_START_NOWDOC,
Chris@17:         T_END_NOWDOC    => T_END_NOWDOC,
Chris@17:         T_NOWDOC        => T_NOWDOC,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that represent the names of called functions.
Chris@17:      *
Chris@17:      * Mostly, these are just strings. But PHP tokenizes some language
Chris@17:      * constructs and functions using their own tokens.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $functionNameTokens = [
Chris@17:         T_STRING       => T_STRING,
Chris@17:         T_EVAL         => T_EVAL,
Chris@17:         T_EXIT         => T_EXIT,
Chris@17:         T_INCLUDE      => T_INCLUDE,
Chris@17:         T_INCLUDE_ONCE => T_INCLUDE_ONCE,
Chris@17:         T_REQUIRE      => T_REQUIRE,
Chris@17:         T_REQUIRE_ONCE => T_REQUIRE_ONCE,
Chris@17:         T_ISSET        => T_ISSET,
Chris@17:         T_UNSET        => T_UNSET,
Chris@17:         T_EMPTY        => T_EMPTY,
Chris@17:         T_SELF         => T_SELF,
Chris@17:         T_STATIC       => T_STATIC,
Chris@17:     ];
Chris@17: 
Chris@17:     /**
Chris@17:      * Tokens that open class and object scopes.
Chris@17:      *
Chris@17:      * @var array<int, int>
Chris@17:      */
Chris@17:     public static $ooScopeTokens = [
Chris@17:         T_CLASS      => T_CLASS,
Chris@17:         T_ANON_CLASS => T_ANON_CLASS,
Chris@17:         T_INTERFACE  => T_INTERFACE,
Chris@17:         T_TRAIT      => T_TRAIT,
Chris@17:     ];
Chris@17: 
Chris@17: 
Chris@17:     /**
Chris@17:      * Given a token, returns the name of the token.
Chris@17:      *
Chris@17:      * If passed an integer, the token name is sourced from PHP's token_name()
Chris@17:      * function. If passed a string, it is assumed to be a PHPCS-supplied token
Chris@17:      * that begins with PHPCS_T_, so the name is sourced from the token value itself.
Chris@17:      *
Chris@17:      * @param int|string $token The token to get the name for.
Chris@17:      *
Chris@17:      * @return string
Chris@17:      */
Chris@17:     public static function tokenName($token)
Chris@17:     {
Chris@17:         if (is_string($token) === false) {
Chris@17:             // PHP-supplied token name.
Chris@17:             return token_name($token);
Chris@17:         }
Chris@17: 
Chris@17:         return substr($token, 6);
Chris@17: 
Chris@17:     }//end tokenName()
Chris@17: 
Chris@17: 
Chris@17:     /**
Chris@17:      * Returns the highest weighted token type.
Chris@17:      *
Chris@17:      * Tokens are weighted by their approximate frequency of appearance in code
Chris@17:      * - the less frequently they appear in the code, the higher the weighting.
Chris@17:      * For example T_CLASS tokens appear very infrequently in a file, and
Chris@17:      * therefore have a high weighting.
Chris@17:      *
Chris@17:      * Returns false if there are no weightings for any of the specified tokens.
Chris@17:      *
Chris@17:      * @param array<int, int> $tokens The token types to get the highest weighted
Chris@17:      *                                type for.
Chris@17:      *
Chris@17:      * @return int The highest weighted token.
Chris@17:      */
Chris@17:     public static function getHighestWeightedToken(array $tokens)
Chris@17:     {
Chris@17:         $highest     = -1;
Chris@17:         $highestType = false;
Chris@17: 
Chris@17:         $weights = self::$weightings;
Chris@17: 
Chris@17:         foreach ($tokens as $token) {
Chris@17:             if (isset($weights[$token]) === true) {
Chris@17:                 $weight = $weights[$token];
Chris@17:             } else {
Chris@17:                 $weight = 0;
Chris@17:             }
Chris@17: 
Chris@17:             if ($weight > $highest) {
Chris@17:                 $highest     = $weight;
Chris@17:                 $highestType = $token;
Chris@17:             }
Chris@17:         }
Chris@17: 
Chris@17:         return $highestType;
Chris@17: 
Chris@17:     }//end getHighestWeightedToken()
Chris@17: 
Chris@17: 
Chris@17: }//end class