Source in HTML fOr Web ユーザーズガイド

バージョン 1.1.1, 2001年 6月24日

SHOW ( Source in HTML fOr Web の略 ) バージョン 1.1 の使用ガイドです。セットアップについては、各種ダウンロードしたアーカイブ内の Readme.txt をご覧ください。 SHOW は、コマンドベースの Java アプリケーションです。セットアッププログラムあるいはユーティリティが適当な起動コマンドを生成します。

アプリケーションの説明
新機能と変更点
必要な環境
含まれるファイル
実行方法
オプション
カスタマイズファイル書式
使用例
既知のバグ
ソフトの使用の中止
次のバージョン
参照ページ

アプリケーションの説明

コマンドラインベースの Java アプリケーションで、各種プログラミング言語のソースファイルから、HTML を生成します。バージョン 1.1 では、Java, C, C++, C ヘッダファイルに対応しています。出力される HTML は、キーワードがハイライト ( カラーリング ) され、見易くなります。また、行番号を含めることも可能です。

新機能と変更点

バージョン 1.1 では 1.0 から以下の機能を追加しています。

for, if などの識別子が適切な色に設定されないバグを修正 ( BUG No.01005 )。
カラーリングの対象を追加。
C++, objective-C (仮対応) に対応しました。
StarSHOW と同様の設定ファイル方式を採用。
起動コマンドを生成するセットアッププログラム、ユーティリティの追加。

必要な環境

以下の Java 実行環境で動作します。

Java Runtime Environment, v1.1.8
Java 2 Runtime Environment, Standard Edition, v1.2 以降
Microsoft Command-line Loader for Java

以下の環境で動作確認をおこなっています。

Windows 2000, J2RE 1.3.1
Windows 2000, JRE 1.1.8-007
Windows 2000, jview version 5.00.3310
Windows Me, J2RE 1.3.1
Vine Linux 2.1.5 ( 2.1CR のアップグレード ), J2RE 1.3.1

含まれるファイル

最終的なインストール先に以下のファイルが生成されます。

ファイル名	簡単な説明
Readme.txt	README (Shift_JIS)
doc/guide.html	使用ガイド (本ファイル)
lib/show.jar	アプリケーション本体
lib/yklib.jar	関連ライブラリ
lib/conf/encode.conf	設定ファイル
lib/conf/handler.conf	設定ファイル
lib/conf/htmlenc.list	設定ファイル

実行方法

セットアッププログラム、またはユーティリティは、適当な起動コマンドを生成します。

Windows を使用の場合: show(.bat) [引数] を使用します。なお、jview を使用する場合 ( セットアップの際に setupms.bat を使用した場合 )、showms(.bat) [引数] を使用してください。
UNIX 系 OS あるいは Mac OS X を使用の場合: show.sh [引数] を使用してます。
コマンドを自分でタイプする場合 ( 必要時に限る ): J2RE ( 1.2 以降 ) をご使用の場合、
java -jar show.jar [引数]
JRE 1.1.x をご使用の場合、
jre -cp show.jar;(UNIX 系は :)yklib.jar -DSHOW_BASE_DIR=(SHOWのlibディレクトリへの絶対パス) jp.gr.java_conf.yku.app.show.SHOWLauncher [引数]
MS jview をご使用の場合、
jview /cp show.jar;yklib.jar /d:SHOW_BASE_DIR=(SHOWのlibディレクトリへの絶対パス) JRE 1.1.x で jre コマンドがない場合、
java -cp show.jar;(UNIX 系は :)yklib.jar -DSHOW_BASE_DIR=(SHOWのlibディレクトリへの絶対パス) jp.gr.java_conf.yku.app.show.SHOWLauncher [引数]
を使用します。

[引数] には、オプションと、処理するソースファイル名あるいはディレクトリ名を指定します。オプションは次項を参照してください。 1 つのファイルを処理する場合は、そのソースファイル名を、ディレクトリ単位で処理する場合は、そのディレクトリ名を指定します。また、出力ファイル名は、ソースファイル名に .html を付加したものです。

オプション

-r: ソースとして指定されたものがディレクトリの場合、そのディレクトリ内を再帰的に ( ディレクトリ内にディレクトリがあれば、それも処理する ) 処理します。
-d <directory>: 指定されたディレクトリへ変換後の HTML ファイルを置きます。
-l: 各行頭に、行番号を付加した HTML を作成します。
-v: 実行状況を表示します。
-e <encoding>: 出力 HTML ファイルのエンコーディング名を決定します。以下のコードを指定できます。なお、ここで指定するエンコーディング名は、 HTML でサポートされる正式な名称です。
Shift_JIS: シフト JIS, EUC-JP: 日本語 EUC, ISO-2022-JP: 日本語 ISO2022
このアプリケーションがサポートするのは、lib/conf にある encode.conf と htmlenc.list に Java エンコーディングと HTML エンコーディングとの対応が示されたものです (通常、気にする必要はありません)。
-?: 使用方法を表示します。
-s suffix:file,suffix:file,...: カスタマイズファイルを指定します。拡張子に対するカスタマイズファイル名を : で区切って指定し、複数のペアを指定する場合はこれを , で区切ってリストします。
-version: バージョンの表示をします。
-description: 簡単な説明を表示します。

カスタマイズファイル書式

ハイライトする色を指定できるようになりました。この機能は、カスタマイズをファイルに指定することで利用できます。そのファイルの書式は、次のようになります。

   # コメント行
   keyword-type: color
   keyword-type color
   keyword-type=color

行頭が # で始まる行はコメントとみなします。 keyword-type は、ハイライトの色を設定するためのキーワードのグループ名です。これは次に説明します。 color は、スタイルシートで指定できる形式で指定します。例えば、green といった色名や、#9966cc のような形式です。 keyword-type と color の間は、: ,(white space) , = のいずれかで区切ります。なお、カスタマイズしたい項目のみの設定でかまいません。ほかの値は、デフォルト色 ( カスタマイズファイルを使用しない場合の色 ) が使用されます。なおkeyword-typeに対し色名を指定しなかった場合、ハイライトを中止させることができます。過剰なハイライトが気になる場合、この方法を使用してハイライトの対象を抑制することができます。

keyword-type

keyword-type は、ソースファイルの種類によって異なります。いかにそのリストを示します。

Java ソースの場合: modifier (public などの修飾子), primitive (基本型), control (for, if など), class_type (class, interface), generalizer (extends, implements), class_name (クラス名), method_name (メソッド名、現在使用していない), package (パッケージ宣言 package), import (インポート宣言 import), package_name (パッケージ名), line_number (行番号), comment (コメント), doc_comment (ドキュメントコメント、現在使用していない)
C, C++, objective-C 言語ソース、ヘッダファイル: line_number (行番号表示), comment (コメント), preprocess (#define, #ifdef など), primitive (int,double などの型), modifier (const, static などの修飾子), define ( typedef や struct など), extern (extern), EXTERN (EXTERN), control (if, for など), op (sizeof など), obj_c (objective-C キーワード、仮)

カスタマイズファイル例

以下は、行番号を黒で、修飾子を黄色で表示するようにする、カスタマイズファイルの例です。

  line_number:#000000
  modifier:yellow

このファイルは、コマンドラインオプション -s に指定することで有効になります。

使用例

簡単な使用例です。コマンドは Windows のバッチファイルを使用する場合です。必要に応じて適切なものに置き換えてください。

show.bat -r -d HTMLfiles -l Src: ディレクトリ Src 以下のソースファイルをすべて変換し、行番号付きで、ディレクトリ HTMLfiles 以下に出力します。
show.bat -e EUC-JP Foo.java: Foo.java を、日本語 EUC の文字コードの HTML に変換します。