module RDoc::ParserFactory
クラスの継承リスト: RDoc::ParserFactory
要約
ソースコードを解析するパーサを生成するためのファクトリクラスです。
新しいパーサを作成する場合には extend して使用します。
[注意] 1.9 系では、require 先やクラス名が以下のように変更になりました。
- require 先: rdoc/parser
- クラス名: RDoc::Parser
特異メソッド
alias_extension(old_ext, new_ext) -> bool
-
old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登 録します。
- [PARAM] old_ext:
- 拡張子を文字列で指定します。
- [PARAM] new_ext:
- 拡張子を文字列で指定します。
- [RETURN]
- エイリアスが登録された場合は true を返します。old_ext にパーサ が登録されていない場合、エイリアスが登録されずに false を返しま す。
can_parse(file_name) -> RDoc::C_Parser | RDoc::RubyParser | RDoc::Fortran95parser | nil
-
file_name を解析できるパーサクラスを返します。見つからなかった場合は nil を返します。
- [PARAM] file_name:
- 解析するファイルの名前を指定します。
parser_for(top_level, file_name, body, options, stats) -> RDoc::C_Parser | RDoc::RubyParser | RDoc::Fortran95parser | RDoc::SimpleParser
-
file_name を解析できるパーサのインスタンスを返します。 見つからなかった場合は RDoc::SimpleParser のインスタンスを返します。
- [PARAM] top_level:
- RDoc::TopLevel オブジェクトを指定します。
- [PARAM] file_name:
- ファイル名を文字列で指定します。
- [PARAM] body:
- ソースコードの内容を文字列で指定します。
- [PARAM] options:
- Options オブジェクトを指定します。
- [PARAM] stats:
- RDoc::Stats オブジェクトを指定します。
インスタンスメソッド
parse_files_matching(regexp) -> ()
-
regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、 自身を登録します。
- [PARAM] regexp:
- 正規表現を指定します。
新しいパーサを作成する時に使用します。
例:
class XyzParser extend ParserFactory parse_files_matching /\.xyz$/ ... end
module RDoc::ParserFactory