【PHP8.x】T_LNUMBER定数の使い方

Copy
1<?php
2
3/**
4 * PHPコードを解析し、T_LNUMBER (整数リテラル) の有無をチェックします。
5 * 特定の文脈で整数リテラルが期待されるにも関わらず見つからない場合を「エラー」として扱います。
6 * これは、プログラミング言語の字句解析における T_LNUMBER の役割と、
7 * 予期せぬトークンが引き起こす可能性のある問題（エラー）を示すためのものです。
8 *
9 * @param string $code 解析対象のPHPコード文字列
10 */
11function analyzeCodeForNumericLiterals(string $code): void
12{
13    echo "--- 解析対象コード ---\n";
14    echo $code . "\n";
15    echo "----------------------\n";
16
17    // token_get_all() はPHPコードをトークンに分解します。
18    // PHPコードが常に '<?php' タグから始まることを期待するため、
19    // 解析するコードの前に明示的に追加します。
20    $tokens = token_get_all("<?php " . $code);
21
22    $errorDetected = false;
23
24    // 分解されたトークンを一つずつ検査します。
25    foreach ($tokens as $index => $token) {
26        // token は配列 (トークンID, 値, 行番号) または文字列 (単一文字トークン、例: ';', '=') です。
27        if (is_array($token)) {
28            $tokenId = $token[0];
29            $tokenValue = $token[1];
30            $lineNumber = $token[2];
31
32            // T_LNUMBER は整数リテラル（例: 123, 456）を表すトークンIDです。
33            if ($tokenId === T_LNUMBER) {
34                echo "INFO: 整数リテラル (T_LNUMBER) を発見: '{$tokenValue}' (行: {$lineNumber})\n";
35            } 
36            // デモンストレーションとして、変数 '$expectedNumber' の直後には
37            // 整数リテラルが続くべきという簡易的なルールを仮定します。
38            elseif ($tokenId === T_VARIABLE && $tokenValue === '$expectedNumber') {
39                // 次のトークンが存在し、かつ配列形式（詳細情報を持つトークン）であるかを確認
40                if (isset($tokens[$index + 1]) && is_array($tokens[$index + 1])) {
41                    $nextToken = $tokens[$index + 1];
42                    // 次のトークンが空白でなく、かつ T_LNUMBER でもない場合を「エラー」と見なします。
43                    // これは、本来整数が来るべき場所で別のものが来たという状況をシミュレートします。
44                    if ($nextToken[0] !== T_WHITESPACE && $nextToken[0] !== T_LNUMBER) {
45                        echo "ERROR: '\$expectedNumber' の直後に整数リテラル (T_LNUMBER) が期待されましたが、\n";
46                        echo "       '{$nextToken[1]}' (タイプ: " . token_name($nextToken[0]) . ") が見つかりました (行: {$nextToken[2]})\n";
47                        $errorDetected = true;
48                    }
49                }
50            }
51        }
52    }
53
54    if (!$errorDetected) {
55        echo "SUCCESS: 簡易ルールに基づく T_LNUMBER 関連のエラーは検出されませんでした。\n";
56    }
57    echo "----------------------\n\n";
58}
59
60// --- サンプルコードの実行 ---
61
62// 例1: T_LNUMBER を含む、期待通りのコード
63analyzeCodeForNumericLiterals("
64\$count = 100;
65\$expectedNumber = 250; // \$expectedNumber の直後に T_LNUMBER (250) がある
66\$value = 75;
67");
68
69// 例2: T_LNUMBER が期待される場所に文字列リテラルがあるコード (エラーとして検出)
70analyzeCodeForNumericLiterals("
71\$size = 50;
72\$expectedNumber = 'thirty'; // \$expectedNumber の直後に T_LNUMBER ではなく文字列がある
73\$status = true;
74");
75
76// 例3: T_LNUMBER が期待される場所に別の変数があるコード (エラーとして検出)
77analyzeCodeForNumericLiterals("
78\$limit = 10;
79\$anotherValue = 99;
80\$expectedNumber = \$anotherValue; // \$expectedNumber の直後に T_LNUMBER ではなく変数がある
81");

このPHPサンプルコードは、PHPの字句解析において整数リテラルを識別する際に使用されるT_LNUMBER定数の役割と、コード中の特定の位置で期待されるトークンが見つからない場合の「エラー」検出の考え方を示しています。T_LNUMBERは、ソースコード内で123のような整数値が直接記述された部分をPHPが認識する際に用いられるトークンIDです。

analyzeCodeForNumericLiterals関数は、引数として受け取ったPHPコード文字列を、token_get_all()関数を使って個々の「トークン」と呼ばれる要素に分解します。そして、それぞれのトークンの種類を検査し、T_LNUMBERトークン（整数リテラル）を発見すると、その値とコード内の行番号を出力します。

さらに、デモンストレーションとして、「$expectedNumber変数の直後には整数リテラルが続くべき」という簡易的なルールを仮定しています。もし$expectedNumberの直後にT_LNUMBER以外のトークン（例えば文字列や別の変数）があった場合、これを「エラー」として報告します。これは、実際のプログラム言語が文法ルールに基づいて予期せぬトークンをエラーとして検出する仕組みの一端をシミュレートするものです。

この関数は、解析したいPHPコードをstring $codeという引数で受け取ります。戻り値はvoidであり、解析結果や検出されたエラーメッセージは標準出力に直接表示されるため、具体的な値を返すことはありません。

Copy
1<?php
2
3/**
4 * T_LNUMBER定数を使ったPHPコードのトークン解析のデモンストレーションを行います。
5 *
6 * T_LNUMBERは、PHPの字句解析器が整数リテラル（例: 123, 456）を認識したときに生成するトークンIDです。
7 * この関数は、`token_get_all()`を使ってPHPコードをトークンに分解し、
8 * T_LNUMBERがどのように識別されるかを示します。
9 */
10function demonstrateTLNUMBERConstant(): void
11{
12    // 解析対象のPHPコード文字列
13    // ここでは2つの整数リテラル（123, 456）が含まれています。
14    $code = '<?php $var1 = 123; $var2 = 456; $text = "Hello"; ?>';
15
16    echo "--- 解析対象のPHPコード --- \n";
17    echo $code . "\n\n";
18    echo "--- トークン解析結果 ---\n";
19
20    // `token_get_all()`関数でPHPコードをトークンに分解します。
21    // 各トークンは配列 ([トークンID, 値, 行番号]) または単一の文字列 (演算子など) で返されます。
22    $tokens = token_get_all($code);
23
24    foreach ($tokens as $token) {
25        if (is_array($token)) {
26            // トークンが配列の場合 (定数、変数名、文字列リテラル、数値リテラルなど)
27            $tokenId = $token[0];
28            $tokenValue = $token[1];
29            $lineNumber = $token[2];
30
31            // `token_name()`でトークンID (数値) を可読な文字列に変換します。
32            $tokenName = token_name($tokenId);
33
34            echo sprintf("ID: %-15s | 値: '%-10s' | 行: %-3d", $tokenName, $tokenValue, $lineNumber);
35
36            // 現在のトークンが T_LNUMBER であるかどうかのチェック
37            if ($tokenId === T_LNUMBER) {
38                echo " <-- T_LNUMBER (整数リテラル) です！";
39            }
40            echo "\n";
41        } else {
42            // トークンが単一の文字列の場合 (例: 演算子 '=', 区切り文字 ';')
43            echo sprintf("ID: %-15s | 値: '%-10s' | 行: %-3s", "オペレータ/記号", $token, "N/A") . "\n";
44        }
45    }
46    echo "------------------------\n";
47}
48
49// 上記のデモンストレーション関数を実行します。
50demonstrateTLNUMBERConstant();
51

PHPのT_LNUMBERは、PHP言語の内部で使われる特別な定数（トークンID）の一つです。これは、PHPがソースコードを解析する際に、数値の中でも特に「整数リテラル」（例: 123, 456）を認識したときに、その部分が整数であることを識別するために使用されます。この定数自体は、引数を取ったり、特定の値を返したりするものではありません。その存在が、PHPのプログラムがコードを構成する要素を分類する上で重要な意味を持ちます。

提供されたサンプルコードは、token_get_all()関数を使ってPHPコード文字列を小さな部品（トークン）に分解し、T_LNUMBERがどのように整数リテラルを識別するかをデモンストレーションしています。token_get_all()関数は、コードを解析してトークンの配列を返します。配列の各要素は、トークンID、値、行番号などの情報を含みます。サンプルコードでは、これらのトークンを一つずつ調べ、もしトークンIDがT_LNUMBERと一致すれば、それがソースコード中の整数リテラルであることを特定し、その旨を表示しています。このように、T_LNUMBERは、PHPのコード解析や、エディタの構文ハイライト機能、コードの自動整形ツールなどの開発において活用される、言語の内部構造を理解するための重要な要素です。