(Japanese | English)

RDoc Fortran 90/95 ソースコード解析機能強化版 (地球流体電脳倶楽部 dcmodel プロジェクト用)

RDoc の Fortran 90/95 ソースコード解析機能を強化するためのパッチを配布しています. パッチを適用したパッケージも配布しています.

動作確認

このパッケージは Ruby 1.8.2 での動作を確認しています.

ダウンロード

最新版 (バージョン $Name: rdoc-f95-20060811 $)

過去のアーカイブ

パッチ・ TGZ パッケージ・ソースツリーのリスト

インストール

パッチファイルを利用する方法

パッチファイルを Ruby のオリジナル資源に適用する手順は以下の通りです.

まず, Ruby のホームページから ftp.ruby-lang.org/pub/ruby/ruby-1.8.4.tar.gz をダウンロードしてください
上記 TGZ ファイルを展開してください.
```
  % tar xvfz ruby-1.8.4.tar.gz
```
このコマンドを実行したディレクトリに上記のパッチファイル rdoc-f95-patch_for_ruby1.8.4 を置き, 以下のコマンドでパッチを適用してください.
```
  % patch -p0 < rdoc-f95-patch_for_ruby1.8.4
```
パッチを適用した後に, Ruby のインストール作業を行ってください. Ruby のインストール方法はオブジェクト指向スクリプト言語 Ruby のホームページを参照してください.

パッチが適用されたパッケージを利用する方法

パッチが適用された rdoc-f95.tgz パッケージを使用するには以下のようにします.

アーカイブファイル rdoc-f95.tgz をダウンロードした後に, 以下のように tar コマンドで展開後, install.rb でインストールを行ってください. 既に rdoc がインストールされている場合, 上書きする可能性があります.

  % tar xvfz rdoc-f95.tgz
  % cd rdoc-f95
  % ruby install.rb

インストール先のディレクトリや, 変更のためのオプションに関しては, 以下のコマンドで知ることが出来ます.

  % ruby install.rb --help

Debian GNU/Linux 用バイナリパッケージを利用する方法

debian パッケージをダウンロードし, 以下のようにインストールを行ないます.

  % dpkg -i rdoc-f95_20060809_i386.deb

オリジナルの rdoc パッケージが rdoc-f95 パッケージに置き換わります. 以下の URL を APT のソースリストに加えておくと, APT のコマンドで rdoc-f95 パッケージのインストールや更新が可能になります.

  deb http://www.gfd-dennou.org/library/cc-env/Linux/debian-dennou stable/

RDoc の使用方法

実行プログラムがインストールされた場所を環境変数 PATH に設定し, ライブラリがインストールされた場所を環境変数 RUBYLIB に設定してください.

Fortran 90/95 ファイルが置いてあるディレクトリまで移動し, 以下のコマンドを実行してください. doc ディレクトリ以下にドキュメントが作成されます.

  % rdoc --ignore-case --charset euc-jp --inline-source

拡張子が .f90, .F90, .f95, .F95 であるファイルは Fortran 90/95 プログラムとして解析されます. サブディレクトリ以下の全ての Fortran 90/95 プログラムも解析されます.

なお, オリジナルの RDoc と同様, 拡張子が .rb, .rbw であるファイルは Ruby プログラムとして, 拡張子が .c, .cc, .cpp, .CC, .cxx であるファイルは C プログラムとして解析されます.

doc ディレクトリ以外に出力したい場合は, —op オプションをつけてください. タイトルは —title オプションで変更できます. また, デフォルトでは Fortran 90/95 の private 属性のサブルーチンや関数などはドキュメントに出力されませんが, —all オプションをつけることで, 全てがドキュメントに出力されます. —charsetオプションは, ドキュメントに反映されるコメントに日本語など 2 バイト文字が含まれる場合に用います. コメントの文字コードに合わせ, euc-jp, Shift_JIS, iso-2022-jp などを指定してください.

一部のファイルのみをドキュメント化したい場合は, 引数に src/*.f90 などとファイル名を明示的に指定してください. 以下の例参照.

  % rdoc --ignore-case --charset euc-jp --inline-source  \
         --op rdoc --title "RDoc documentations" src/*.f90 test/*.f90

詳しいことは RDoc オリジナルの README を参照ください.

書法

parsers/parse_f95.rb を参照ください. ただし, ここに記述されるのは Fortran 90/95 に特有な部分なので, 一般的な部分に関しては RDoc オリジナルの README を参照ください. 大林さんによる日本語訳が www.kmc.gr.jp/~ohai/rdoc.ja.html にあります.

サンプル

オリジナルの RDoc との違い

ここで配布するパッチは, RDoc の Fortran 90/95 ソースコードの解析能力を大幅に向上させ, Fortran 90/95 プログラムから自動生成されるドキュメントの情報量を充実させます. 主に改良されているのは, 元々の RDoc に付属される Fortran 90/95 解析プログラム parse_f95.rb ですが, 他のいくつかのプログラムにも改良を施しています.

オリジナルの RDoc は Dave Thomas さんによって開発され, 現在では Ryan Davis さんによってメンテナンスされています. オリジナルの RDoc は Ruby の CVS レポジトリ www.ruby-lang.org/ja/20020106.html より取得できます. オリジナルの RDoc に関しては RDoc オリジナルの README を参照してください.

オリジナルからの変更点の主なものは以下の通りです. なお, 既にこのパッチ (2005/12/17 バージョン) は Ruby 本家の CVS リポジトリへとフィードバックされているので, 一部は既に「オリジナルとの変更点」ではなくなっていることに注意してください.

`—ignore-case` オプションの追加 :	Fortran 90/95 規格では大文字小文字の区別はありません. これに対して, オリジナルの rdoc はクラス名やメソッド名のクロスリファレンスの際に大文字小文字を区別します. このオプションを与えることにより, その区別を行わないようにします.
ファイルのクロスリファレンス :	クラスやモジュール, メソッドと同様に, ファイル名に関してもクロスリファレンスを可能にしました.
`—style` オプションの改良 :	オリジナルの rdoc では, 相対パスでスタイルシートを指定した場合, 各ドキュメントのスタイルシートへのパスが正しく設定されません. このパッチを適用することで, 正しく設定されるようになります.
TeX で書かれた数式の MathML への変換 :	ひらくの工房にて公開されている Ruby 用 MathML ライブラリのバージョン 0.5 をインストールすることで, TeX で書かれた数式を MathML に変換することが可能です. この機能を有効にするためには rdoc コマンドに —mathml オプションを指定してください. TeX で数式を書く際の書式に関しては Generators::TexParser を参照してください. ※ 注意 ※ —mathml オプションを使用した際に作成されるドキュメントは Mozilla Firefox および Internet Explorer (+ MathPlayer) では正しく表示されることを確認しています. その他のブラウザの MathML 対応に関しては, MathML 日本語情報や MathML Software - Browsers などを参照してください.

解析能力が向上されたのに伴い, ドキュメントに反映されるコメントの書法の多少変更されています. parsers/parse_f95.rb を参照してください.

使用上の注意

RDoc Fortran 90/95 ソースコード解析機能強化版のパッチもしくはパッケージ (以下, 本パッチもしくはパッケージ)は, 研究・教育の場で用いられることを前提としております. 教育現場においては自由に使用・改変していただいて結構です. ライセンス規定は本家 RDoc に準拠します. RDoc オリジナルの README を参照ください.

本パッチもしくはパッケージを利用して得られた科学技術的成果を論文や Web 等にて発表する際には, その旨を記し, リファレンスに挙げて頂きますようお願いします.

引用例 (和文)

  森川 靖大, 石渡 正樹, 堀之内 武, 小高 正嗣, 林 祥介,
  数値モデリングプロジェクト dcmodel, 2006:
  RDoc Fortran 90/95 ソースコード解析機能強化版,
  http://www.gfd-dennou.org/library/dcmodel/, 地球流体電脳倶楽部.

引用例 (英文)

  Morikawa,Y., Ishiwatari,M., Horinouchi,T., Odaka,M., Hayashi,Y.-Y.,
  dcmodel: Numerical Model Porject, 2006:
  Enhanced version of RDoc Fortran 90/95 parser,
  http://www.gfd-dennou.org/library/dcmodel/, GFD Dennou Club.

連絡先

数値モデリングプロジェクト dcmodel のページ末尾を参照ください.

履歴

2006/08/11

パッケージ名を rdoc-dennou から rdoc-f95 に変更.
公開アドレスを www.gfd-dennou.org/library/dcmodel/rdoc-dennou/ から www.gfd-dennou.org/library/dcmodel/rdoc-f95/ へ変更. (過去の URL もしばらく残しておきます).
README, README.ja の修正.
TeX で書かれた数式を MathML への変換する機能を追加.
style オプションの改良.
主プログラムも ‘Methods’ の欄に追加.
各ファイルに点在している NAMELIST 変数群を自動的に一箇所に集約して表示するよう改良.
F90 ファイルが提供するモジュール群の名前を, 自動的にファイルのドキュメントに追記するよう改良.

2006/02/24

英語版 README の作成
README.ja の修正.

2006/01/18

サブルーチン, 関数の引数の情報をコメントとして出力する際の書式を少しだけ修正.
- 引数情報をコメントに出力する際, 引数の後ろに空白を挿入した. これにより, メソッドの並び替えを行う際 (メソッドはメソッド名, 引数, コメントの順に大きさを比較し, 並べる順序を決める), "args" が "args(:)" よりも前に来るようになる.
本家 Ruby の CVS リポジトリ内の更新を受け, 最新版をこちらのパッケージ版にも移植.

2005/12/28

ruby 1.8.4 のリリースに伴い, パッチを 1.8.4 用に変更.

2005/12/17

同名の手続き同士で公開・非公開属性を誤って設定してしまうバグを修正.
以下のバグを修正
- program, module, subroutine, function の end 文は必ず end program, end module, end subroutine, end function のように記述しないと, 書法を正しく解析出来ない.
- program ～ end program 文の, 最初と最後の program という文字を省略した場合, program 文の内部で定義されるものは全て public だと認識される.
- ";" の文字をコメント内でも改行に変換してしまう
!— ～ !++ によるコメント削除の指定の際に, "!" よりも前に空白を含んでよいように修正.
interface 文で指定される外部手続きの解析を修正.
継続行の扱いを修正.

2005/12/13

parsers/parse_f95.rb に注意事項と Todo を追加.
「サンプル」を追加.
public, private 文を解析する部分のバグを修正.

2005/12/08

「使用上の注意」, 「連絡先」を追加.
公開アドレスを www.gfd-dennou.org/library/dcmodel/doc/rdoc-dennou/ から www.gfd-dennou.org/library/dcmodel/rdoc-dennou/ へ変更. (過去の URL もしばらく残しておきます).

2005/11/28

":nodoc:" の指定を可能にする.
サブルーチンや関数内の "contains" 文の処理方法を修正する.
表題を変更する.
過去のバージョンを公開する.

2005/11/17

一通り欲しい機能が揃い, ドキュメントのチェックも行ったので, タグをつけて公開する.

README.ja