Ruby 1.8.7 リファレンスマニュアル > ライブラリ一覧 > rdoc/parsers/parserfactoryライブラリ

library rdoc/parsers/parserfactory

要約

rdoc で解析できるファイルの種類を追加するためのサブライブラリです。

以下のメソッドを定義したクラスを作成する事で、新しいパーサクラスを作成する事ができます。

#initialize(top_level, file_name, body, options, stats)
#scan

initialize メソッドは以下の引数を受け取ります。

top_level RDoc::TopLevel オブジェクトを指定します。
file_name: file_name ファイル名を文字列で指定します。
body: ソースコードの内容を文字列で指定します。
options: Options オブジェクトを指定します。
stats: RDoc::Stats オブジェクトを指定します。

scan メソッドは引数を受け取りません。処理の後は必ず RDoc::TopLevel オブジェクトを返す必要があります。

また、RDoc::ParserFactory はファイル名からパーサクラスを取得するのにも使われます。このために、新しく作成するパーサクラスでは RDoc::ParserFactory を extend し、parse_files_matching メソッドで自身が解析できるファイル名のパターンを登録しておく必要があります。

例:

require "rdoc/parsers/parserfactory"

module RDoc

  class XyzParser
    extend ParserFactory
    parse_files_matching /\.xyz$/

    def initialize(top_level, file_name, body, options, stats)
      ...
    end

    def scan
      ...
    end
  end
end

モジュール

RDoc::ParserFactory

ソースコードを解析するパーサを生成するためのファクトリクラスです。

同時にrequireされるライブラリ

rdoc/parsers/parse_simple

ソースコード以外のファイルを解析するためのサブライブラリです。