RelaxNGCC ( RELAX NG Compiler Compiler)

$Revision: 1.8 $ By RelaxNGCC SourceForge Project / 岡嶋大介 Daisuke OKAJIMA

　RelaxNGCCは、RELAX NGで書かれたスキーマからJavaのソースコードを生成するツールです。入力XMLの各エレメントやアトリビュートを読んだときのアクションを、yaccやJavaCCと同様の手法でユーザが直接スキーマに追加記述します。 RelaxNGCC is a tool for generating Java source code from a given RELAX NG grammar. By embedding code fragments in the grammar like yacc or JavaCC, you can take appropriate actions while parsing valid XML documents against the grammar.

マニュアル
初歩的な使い方を示すチュートリアル１
もうちょっと高度な使い方を示すチュートリアル２
略記法とASTに関するチュートリアル３(英語)
ASTに関して更に解説したチュートリアル４(英語)
ランタイムを活用するチュートリアル５(英語)
生成されたコードを駆動するには？チュートリアル６(英語)
どのような原理で動いているかの内部的な説明(これを読むにはRELAX NGとオートマトンについての予備知識が必要です。)
ダウンロード

Tutorial 1(get your feet wet)
Tutorial 2(basic usage)
Tutorial 3(text-based syntax and AST)
Tutorial 4(more about AST)
Tutorial 5(making the most out of runtime)
Tutorial 6(bootstrapping)
Manual
Document about the internal algorithm
Download

　コンパイラの実行にはJRE1.2以降が必要です。 JRE 1.2 or later is required to run the compiler.

　生成されたコードの実行にはSAXパーサが必要です。 Generated code will only need a SAX parser to run.

主な特徴Feature Highlights

　スキーマからソースコードを生成するツールとしてはRelaxerが有名ですが、RelaxNGCCは次のような違いがあります。 Relaxer is another famous tool for generating Java source code from a given grammar, but RelaxNGCC is different from Relaxer at following points.

RelaxNGCCは、もとのXML文書の木構造にとらわれない処理が簡単です。RelaxerがXML文書全体について各部分に対応するオブジェクトを生成するのに対し、XML文書から必要なデータだけを抽出・加工する処理が得意です。The code generated by RelaxNGCC can ignore unnecessary parts of the input XML document while Relaxer retrieves all information in the document. It is powerful especially when you want to extract necessary data from XML instances.
RelaxNGCCは、XML文書を読み込むだけの機能です。XML文書を出力する機能はありません。XML->Javaの一方通行のツールです。RelaxNGCC focuses on reading XML instances. Generation of XML documents from Java objects is outside the scope of RelaxNGCC.
一からDOMやSAXのプログラムを書くよりも簡単にXMLを読む機能が実装できます。RelaxNGCC makes programming easy for reading XML in comparison with writing raw DOM or SAX code.

問い合わせYour Comment

　RelaxNGCCに関する質問・要望は、開発者全員がモニターしているRelax開発者メーリングリストへお願いします。まだ安定した実装になっているとはいえないので、使ってみておかしいと思ったらお気軽にご連絡ください。できる限りすみやかに対処します。ユーザの声が僕らのモチベーションを引き出すのでよろしくお願いします。 If you hava any comments, questions, or requests, please post them to reldeve mailing list, where all the developers are monitoring. We always welcome your comments, as those are the ultimate motivation that drives us to further development.

ライセンスLicense

　RelaxNGCC本体はGNU GENERAL PUBLIC LICENSE(GPL)に従って配布されます。RelaxNGCCが生成したJavaソースコードについては我々は著作権を放棄します。 RelaxNGCC is licensed under GNU GENERAL PUBLIC LICENSE(GPL). For the code generated by RelaxNGCC, we waive our copyrights, so they are all yours.

AttributesImpl.javaについて注意Note about AttributesImpl.java

　生成されるAttributesImpl.javaはorg.xml.sax.Attributesの実装として使っています。このソースコードはXerces等とともに配布されているorg.xml.sax.helpers.AttributesImplのソースコードを元にしていますが、現在のところこれにはremoveAttributeメソッドにバグがあるため、それを避ける目的でバグを修正したものをrelaxngcc.runtimeパッケージに配置して使用しています。なので当面の間、relaxngcc.runtime.AttributesImpl.javaだけはorg.xml.sax.helpers.AttributesImplに倣ってpublic domainのライセンスとします。なおこのバグはJRE1.4でも同様の模様です。 The generated AttributesImpl.java is used as an implementation of org.xml.sax.Attributes. It is based on the source code of org.xml.sax.helpers.AttributesImpl distributed with some products such as Xerces, but the original org.xml.sax.helpers.AttributesImpl has a bug in removeAttribute method. To avoid the bug, I modified the original and located at relaxngcc.runtime package. relaxngcc.runtime.AttributesImpl.java is in the public domain like the original for this reason. The bug has not been fixed in JRE1.4.

リリースRelease Notes

2002/03/03 バージョン0.51を公開しました。Mar 3, 2002 Version 0.51 is released.

JDK1.4上での動作確認と、開発環境のEclipseへの移行をしました。RelaxNGCCの機能自体は変わっていません。Tested with JDK1.4 and changed my development environment into Eclipse. The feature of RelaxNGCC is same as version 0.5.

2002/03/17 バージョン0.6を公開しました。Mar 17, 2002 Version 0.6 is released.

RelaxNGCCで処理できない文法が入力された場合のエラーメッセージを強化しました。Enhanced error messages when RelaxNGCC can not process the input grammar.
listにaliasアトリビュートをつけることができるようにしました。Added feature for alias attributes with list element.

2002/05/03 バージョン0.7を公開しました。May 3, 2002 Version 0.7 is released.

inlineアトリビュートを導入し、スコープの展開ができるようになりました。Added inline attribute for expanding a scope into other scopes.
マニュアルを改訂しました。Revised manuals.

2002/06 バージョン1.0を公開しました。Jun, 2002 Version 1.0 is released
- Kohsuke Kawaguchi joined the development and the project is now hosted at SourceForge.
- RelaxNGCC became self-sufficient; now it uses itself to parse RELAX NG grammars.
- Replaced the compiler algorithm so that it generates code that works correctly
- Implemented an experimental text-based shorthand syntax.
- Added new features represented by c:with-params, c:params, c:return-type, and c:return-value attributes.
- Runtime code is refactored. The compiler now generates NGCCRuntime class, which coordinates the entire processing.
- The RELAX NG compact syntax support was pulled out.
- The compiler is now smart enough to handle multiple aliases with the same name, and aliases colliding with fields defined in c:java-body elements.
- 川口耕介が開発に参加したのに伴い、プロジェクトをSourceForgeに移管しました
- RelaxNGCC自身を使って作ったパーサを使ってRELAX NG文法を読み込むように書き換えました
- コンパイラのアルゴリズムを全面的に変更し、正しいコードが生成されるようにしました
- 属性によらない簡易記法を試験的に実装しました
- 新しい機能を追加し、それに伴いc:with-params, c:params, c:return-typeやc:return-value といった属性を追加しました
- ランタイムを再デザインしなおしました。処理をつかさどるNGCCRuntimeクラスが生成されるようになりました
- RELAX NG コンパクト文法サポートは取り除かれました
- コンパイラはc:java-body内のJavaコードを正しく解析するようになりました。これに伴い、宣言されたエイリアスの取り扱いがスマートになりました

さらに前のリリース履歴はこちらです。Earlier release notes are available here.

将来のバージョンで行う予定のことWish list for future versions

Token looking ahead support to handle ambiguous schemas トークンの先読みをしてより広いスキーマに対応
Supporting code generation in other languages, such as C# C#のコード生成
Enhancing documents, especially internal algorithm ドキュメント整備、特に内部的なアルゴリズムについて

To file a feature request, please visit the project website at SourceForge. この他の機能の提案などがあれば、SourceForgeのウェブサイトに書き込んでください.