Text_Highlighter

Introduction

Text_Highlighter を使用すると、 さまざまな形式のファイルに対して シンタックスハイライティングを行うことができます。

現在は、以下のフォーマットがサポートされています。

• ABAP

• C++

• CSS

• diff(1) の出力

• DTD

• HTML

• Java

• Javascript

• MySQL

• Perl

• PHP

• Python

• Ruby

• sh

• SQL

• VBScript

• XML

各種レンダラを使用して、 さまざまな形式でハイライト結果を出力することができます。 レンダラの一覧を次に示します。

• Array

• Console

• HTML - span タグで CSS のクラス名を指定します。 これがデフォルトのレンダラです。

• HTMLTags - シンプルなタグである B と I、そして U のみを使用します。 HTML のサブセットしかサポートしていないデバイス (iPod など) で便利です。

• JSON

• XML

使用法

Text_Highlighter クラスには シンタックスハイライティングを行うために必要な機能がすべて含まれています。 ただし、各種フォーマットに対する強調ルールは除きます。 これらのルールは Text_Highlighter のサブクラスで定義されていますが、 このサブクラスのインスタンスを直接作成する必要はありません。 オブジェクト指向なファクトリパターンを用いて、 フォーマットに応じたオブジェクトを作成します。

<?php
require_once "Text/Highlighter.php";

$hlSQL =& Text_Highlighter::factory("SQL");
echo $hlSQL->highlight("SELECT * FROM some_table WHERE id = 12");
?>

その他のフォーマットについてのシンタックスハイライティングを行うには Text_Highlighter::factory の引数の値 SQL を以下のいずれかに変更する必要があります。 ABAP、CPP、CSS、DIFF、 DTD、HTML、JAVA、 JAVASCRIPT、MYSQL、 PERL、PHP、 PYTHON、RUBY、SQL、 あるいは XML。

出力のカスタマイズ

デフォルトでは、Text_Highlighter は、入力内容の構文を強調した HTML を作成します。

作成される出力結果を変更し、 xterm のようなカラー対応端末や less(1) に適した形式とすることも可能です。 そのためには、Text_Highlighter に対して別のレンダラを使用するように指示します。

<?php
require_once "Text/Highlighter.php";
require_once "Text/Highlighter/Renderer/Console.php";

$hlSQL =& Text_Highlighter::factory("SQL");
$hlSQL->setRenderer(new Text_Highlighter_Renderer_Console);
echo $hlSQL->highlight("SELECT * FROM some_table WHERE id = 12");
?>

HTML レンダラやコンソールレンダラの出力結果をさらにカスタマイズすることも可能です。 その場合は、コンストラクタにオプションの連想配列を渡します。

<?php
require_once "Text/Highlighter.php";
require_once "Text/Highlighter/Renderer/Html.php";

$renderer = new Text_Highlighter_Renderer_Html(array("numbers" => HL_NUMBERS_LI, "tabsize" => 4));

$hlJava =& Text_Highlighter::factory("JAVA");
$hlJava->setRenderer($renderer);

echo $hlJava->highlight('class JavaProgram {
    public static void main(String args[]) {
        System.out.println("Hello World!");
    }
}');
?>

以下のオプションが使用可能です。