概要

1 概要

SPIEは，対象ソフトウェアを理解する作業を支援する以下のHTMLファイル群を自動生成する．

ソースプログラム
関数情報テーブル
大域変数情報テーブル
局所変数情報テーブル
引数情報テーブル
型情報テーブル
構造体メンバ情報テーブル
列挙子情報テーブル
マクロ情報テーブル
定数情報テーブル
タグ情報テーブル
ソフトウェア関連文書

これらの情報テーブルはソースプログラムから得られる情報をコンパクトにまとめたクロスリファレンス表であり，構成要素の定義・出現位置を参照しジャンプすることができる．また，HTMLに変換されたソースファイルでは，各種の識別子にアンカーが張られている．利用者は，アンカーをクリックすることによって，上記の各種情報テーブルにジャンプすることができる．

SPIEにより，自動生成したHTMLファイルをWWWブラウザで表示した例を図1 に示す．また，

http://www.sapid.org/sample/SPIE/gzip-1.2.4/index.html

でSPIEのサンプル出力にアクセスすることができる．

図1 SPIEの初期画面

SPIEはLaTeXモードとHTMLモードの2つの動作モードを持つ． LaTeXモードでは，LaTeXソースファイル形式の情報テーブルを標準出力に出力する． HTMLモードでは，ハイパーリンクや色付けなどにより修飾されたソースプログラムとクロスリファレンス表がHTMLファイル群として生成される．利用者は，HTML ブラウザを用いてこれらのファイルにアクセスすることにより，ソースプログラムの全体構造を容易に把握を行うことができる．また，専用のCGIスクリプトと共にWWWサーバ経由でHTMLファイル群を参照することにより，ソースプログラムと連携するメモ機能，カテゴリ(関数，大域変数，型，マクロなど)や文脈(左辺値・右辺値)を考慮した高度な検索機能などを利用することができる．

なお，SPIEはmkSpec5のHTMLファイル生成機能を拡張して作成された．