Util/Tokens: Compatibility with php-parser

Author: 0zd0

src/Util/Tokens.php

@@ -90,108 +90,7 @@
  * `PHP_CodeSniffer\Tests\Core\Util\Tokens\TokenNameTest::dataPolyfilledPHPNativeTokens()` test method!}
  */
 
-// Some PHP 5.5 tokens, replicated for lower versions.
-if (defined('T_FINALLY') === false) {
-    define('T_FINALLY', 'PHPCS_T_FINALLY');
-}
-
-if (defined('T_YIELD') === false) {
-    define('T_YIELD', 'PHPCS_T_YIELD');
-}
-
-// Some PHP 5.6 tokens, replicated for lower versions.
-if (defined('T_ELLIPSIS') === false) {
-    define('T_ELLIPSIS', 'PHPCS_T_ELLIPSIS');
-}
-
-if (defined('T_POW') === false) {
-    define('T_POW', 'PHPCS_T_POW');
-}
-
-if (defined('T_POW_EQUAL') === false) {
-    define('T_POW_EQUAL', 'PHPCS_T_POW_EQUAL');
-}
-
-// Some PHP 7 tokens, replicated for lower versions.
-if (defined('T_SPACESHIP') === false) {
-    define('T_SPACESHIP', 'PHPCS_T_SPACESHIP');
-}
-
-if (defined('T_COALESCE') === false) {
-    define('T_COALESCE', 'PHPCS_T_COALESCE');
-}
-
-if (defined('T_COALESCE_EQUAL') === false) {
-    define('T_COALESCE_EQUAL', 'PHPCS_T_COALESCE_EQUAL');
-}
-
-if (defined('T_YIELD_FROM') === false) {
-    define('T_YIELD_FROM', 'PHPCS_T_YIELD_FROM');
-}
-
-// Some PHP 7.4 tokens, replicated for lower versions.
-if (defined('T_BAD_CHARACTER') === false) {
-    define('T_BAD_CHARACTER', 'PHPCS_T_BAD_CHARACTER');
-}
-
-if (defined('T_FN') === false) {
-    define('T_FN', 'PHPCS_T_FN');
-}
-
-// Some PHP 8.0 tokens, replicated for lower versions.
-if (defined('T_NULLSAFE_OBJECT_OPERATOR') === false) {
-    define('T_NULLSAFE_OBJECT_OPERATOR', 'PHPCS_T_NULLSAFE_OBJECT_OPERATOR');
-}
-
-if (defined('T_NAME_QUALIFIED') === false) {
-    define('T_NAME_QUALIFIED', 'PHPCS_T_NAME_QUALIFIED');
-}
-
-if (defined('T_NAME_FULLY_QUALIFIED') === false) {
-    define('T_NAME_FULLY_QUALIFIED', 'PHPCS_T_NAME_FULLY_QUALIFIED');
-}
-
-if (defined('T_NAME_RELATIVE') === false) {
-    define('T_NAME_RELATIVE', 'PHPCS_T_NAME_RELATIVE');
-}
-
-if (defined('T_MATCH') === false) {
-    define('T_MATCH', 'PHPCS_T_MATCH');
-}
-
-if (defined('T_ATTRIBUTE') === false) {
-    define('T_ATTRIBUTE', 'PHPCS_T_ATTRIBUTE');
-}
-
-// Some PHP 8.1 tokens, replicated for lower versions.
-if (defined('T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG') === false) {
-    define('T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG', 'PHPCS_T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG');
-}
-
-if (defined('T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG') === false) {
-    define('T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG', 'PHPCS_T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG');
-}
-
-if (defined('T_READONLY') === false) {
-    define('T_READONLY', 'PHPCS_T_READONLY');
-}
-
-if (defined('T_ENUM') === false) {
-    define('T_ENUM', 'PHPCS_T_ENUM');
-}
-
-// Some PHP 8.4 tokens, replicated for lower versions.
-if (defined('T_PUBLIC_SET') === false) {
-    define('T_PUBLIC_SET', 'PHPCS_T_PUBLIC_SET');
-}
-
-if (defined('T_PROTECTED_SET') === false) {
-    define('T_PROTECTED_SET', 'PHPCS_T_PROTECTED_SET');
-}
-
-if (defined('T_PRIVATE_SET') === false) {
-    define('T_PRIVATE_SET', 'PHPCS_T_PRIVATE_SET');
-}
+Tokens::registerPolyfills();
 
 // Tokens used for parsing doc blocks.
 define('T_DOC_COMMENT_STAR', 'PHPCS_T_DOC_COMMENT_STAR');
@@ -210,6 +109,12 @@
 
 final class Tokens
 {
+    /**
+     * Counter for assigning unique negative IDs to polyfilled tokens.
+     *
+     * @var int
+     */
+    private static $nextPolyfillId = -1000;
 
     /**
      * The token weightings.
@@ -832,4 +737,69 @@ public static function getHighestWeightedToken(array $tokens)
     }//end getHighestWeightedToken()
 
 
+    /**
+     * Defines a token if it does not exist in the current PHP.
+     *
+     * @param string $name Constant name
+     *
+     * @return void
+     */
+    private static function polyfill(string $name): void
+    {
+        if (defined($name) === false) {
+            define($name, self::$nextPolyfillId--);
+        }
+
+    }//end polyfill()
+
+
+    /**
+     * Initialization of all emulated tokens.
+     *
+     * @return void
+     */
+    public static function registerPolyfills(): void
+    {
+        // PHP 5.5.
+        self::polyfill('T_FINALLY');
+        self::polyfill('T_YIELD');
+
+        // PHP 5.6.
+        self::polyfill('T_ELLIPSIS');
+        self::polyfill('T_POW');
+        self::polyfill('T_POW_EQUAL');
+
+        // PHP 7.
+        self::polyfill('T_SPACESHIP');
+        self::polyfill('T_COALESCE');
+        self::polyfill('T_COALESCE_EQUAL');
+        self::polyfill('T_YIELD_FROM');
+
+        // PHP 7.4.
+        self::polyfill('T_BAD_CHARACTER');
+        self::polyfill('T_FN');
+
+        // PHP 8.0.
+        self::polyfill('T_NULLSAFE_OBJECT_OPERATOR');
+        self::polyfill('T_NAME_QUALIFIED');
+        self::polyfill('T_NAME_FULLY_QUALIFIED');
+        self::polyfill('T_NAME_RELATIVE');
+        self::polyfill('T_MATCH');
+        self::polyfill('T_ATTRIBUTE');
+
+        // PHP 8.1.
+        self::polyfill('T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG');
+        self::polyfill('T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG');
+        self::polyfill('T_READONLY');
+        self::polyfill('T_ENUM');
+
+        // PHP 8.4.
+        self::polyfill('T_PROPERTY_C');
+        self::polyfill('T_PUBLIC_SET');
+        self::polyfill('T_PROTECTED_SET');
+        self::polyfill('T_PRIVATE_SET');
+
+    }//end registerPolyfills()
+
+
 }//end class