ソース・バンドルは、マニフェストに Eclipse-SourceBundle ヘッダーが含まれているかどうかによって識別することができます。このヘッダーの形式は以下のとおりです。
Eclipse-SourceBundle: <bundle-id>;version=<version>;roots:="root1, root2"
bundle-id と version は、含まれているソース・コードに対応するバンドルを示します。roots ディレクティブは、実際にソース・コードを含んでいるソース・バンドルが格納されているフォルダーを示します。roots ディレクティブが指定されない場合は、値 "." が想定されます。
クラス・ファイル・ライブラリーは、予測可能な方法でソース・ロケーションにマップされます。プラグインのルートはソース・バンドルのルートにマップされます。これが、JAR にまとめられるほとんどのプラグインで一般的に考えられるケースです。プラグインに追加ライブラリー "foo/lib.jar" が含まれている場合、ソースはソース・バンドル内の対応する "foo/libsrc/" フォルダーにあると考えられます。
org.eclipse.pde.core.jar org.eclipse.pde.core.source.jar - org/**/*.class - org/**/*.java - ant_tasks/pde-ant.jar - ant_tasks/pde-antsrc/org/**/*.java
Eclipse-SourceBundle: org.eclipse.pde.core;version="3.4.0.N20071128-0010";roots:="ant_tasks/pde-antsrc,."
org.eclipse.pde.build/ org.eclipse.pde.build.source.jar - pdebuild.jar - pdebuildsrc/org/**/*.java - lib/pdebuild-ant.jar - lib/pdebuild-antsrc/org/**/*.java
Eclipse-SourceBundle: org.eclipse.pde.build;version="3.4.0.N20071128-0010";roots:="pdebuildsrc,lib/pdebuild-antsrc"
PDE ビルドでは個々のソース・バンドルを自動的に生成することができます。ただし、ヘッドレス・バンドルでのみ生成可能です。個々のソース・バンドルの生成は、次のように指定するとオンにできます。
individualSourceBundles=true
これは、ビルド構成のトップレベルの build.properties ファイルで指定します。そうすることで、そのビルドのすべてのソース生成を制御できます。従来のソース・プラグインおよびフィーチャーの生成の詳細については、ソースのフィーチャーおよびプラグインの生成を参照してください。このページの以降の内容を理解するには、従来のソース生成について精通していることが前提となります。
generate.feature@<source feature id> = <feature id> [, feature@<feature id>]* [, plugin@<plugin id>]* [, exclude@<plugin id>]*
個々のソース・バンドルの生成に関しては、このプロパティーは従来どおりであり、以前と同じ属性 (eg version、unpack、optional など) をサポートします。違いは、生成されるソース・フィーチャーにあります。以前は、ソース・フィーチャーには、ソース・プラグインが 1 つと、ビルドされる各プラットフォームのソース・フラグメントが含まれていました。新しいフォーマットでは、オリジナルのフィーチャーでリストされている各プラグインまたは各フラグメントのソース・バンドルがソース・フィーチャーに含まれます。
plugin@ 構文を通じてソース・フィーチャーに組み込まれていたプラグインは、対応するソース・バンドルを取得しません。これは、そのソース・フィーチャーに doc プラグインを追加する場合に便利です。
exclude@ は、個別ソースの生成のための新しいエントリーです。起点であるフィーチャーに含まれていた一部のプラグイン (ネイティブ・コードのみを含む doc プラグインまたはフラグメント) にソースがなく、そのため、生成されるソース・フィーチャーから除外しなければならないことがあります。exclude@ エントリーは、version 属性をサポートしています。
例:generate.feature@org.eclipse.jdt.source=org.eclipse.jdt, plugin@org.eclipse.jdt.doc.isv;unpack="false",exclude@org.eclipse.jdt.doc.user
旧フォーマットでは、generate.plugin プロパティーは指定のフィーチャー・コンテンツに基づいてソース・プラグインを生成していましたが、個々のソース・バンドルの生成に関しては、次のように、指定のプラグインに基づいた生成に変更されました。
generate.plugin@<source plug-in id>=<plug-in id>
generate.plugin プロパティーは、ソース・フィーチャーがないソースを組み込む目的で (結果的にはソース・フィーチャー全体が生成されることになるとしても) フィーチャーによって使用されていました。個々のソース・バンドルを生成する場合、フィーチャーには、各プラグインの *.source バンドルと generate.plugin プロパティーを組み込む必要があります。
例: 従来の sdk.examples フィーチャーは次のようなものでした。
<feature id="org.eclipse.sdk.examples" ... > .... <plugin id="org.eclipse.sdk.examples.source" version="0.0.0"/> <plugin id="org.eclipse.sdk.examples.source.win32.win32.x86" version="0.0.0"/> </feature>
generate.plugin@org.eclipse.sdk.examples.source=org.eclipse.sdk.examples
これが以下のように変わります。
<feature id="org.eclipse.sdk.examples" ...> ... <plugin id="org.eclipse.compare.examples.source" version="0.0.0"/> <plugin id="org.eclipse.debug.examples.core.source" version="0.0.0"/> <plugin id="org.eclipse.swt.examples.source" version="0.0.0"/> </feature>
generate.plugin@org.eclipse.compare.examples.source=org.eclipse.compare.examples generate.plugin@org.eclipse.debug.examples.core.source=org.eclipse.debug.examples.core generate.plugin@org.eclipse.swt.examples.source=org.eclipse.swt.examples
プラグインによっては、実際にはソースが含まれないこともあるので、ソース・バンドルが必要ない場合もあります。ネイティブ・ライブラリーのみを含む、プラットフォーム固有のフラグメントなどがこれに該当します。この場合、上記の generate.feature に関する説明で概説したように、バンドルがフィーチャーによって除外されることがあります。
あるいは、バンドルの build.properties ファイルで次のように明示的に指定して、そのバンドルのソース・バンドルが生成されないようにすることもできます。
generateSourceBundle=false
起点となるバンドルで post.gather.source カスタム・コールバックを使用すると、生成されたソース・バンドルにカスタム・コンテンツを常時追加することができます (フィーチャーおよびプラグインのカスタム・ビルド・ステップを参照)。
その場合は、プラグインの build.properties ファイルで「src.additionalRoots」プロパティーを設定して、生成されたソース・バンドルの Eclipse-SourceBundle ヘッダーに正しいルート・ディレクティブが含まれるようにします。
例:
org.junit4 :
build.properties src.includes = about.html,junitsrc.zip
src.additionalRoots=junitsrc
customBuildCallbacks=customBuildCallbacks.xml
customBuildCallbacks.xml
<target name="post.gather.sources" >
<mkdir dir="${target.folder}/junitsrc"/>
<unzip src="${target.folder}/junitsrc.zip" dest="${target.folder}/junitsrc" overwrite="false"/>
<delete file="${destination.temp.folder}/junitsrc.zip" />
</target>
以前は、生成されたソース・プラグインは、生成されたソース・フィーチャーのブランド・プラグインとして機能していました。オリジナルのフィーチャーの sourceTemplatePlugin ディレクトリーを使用して、ブランド・ファイル (about.properties, eclipse32.gif など) が提供されていました。
個々のソース・バンドルの生成の場合、ソース・フィーチャーのブランド・プラグインは、オリジナル・ブランド・プラグインに対応するソース・バンドルです。つまり、オリジナル・ブランド・プラグインの src.includes プロパティーを使用して、ソース・フィーチャーのブランド・プラグインのブランド・ファイルを提供することができるということです。
ソースを生成中であるフィーチャーの sourceTemplatePlugin フォルダーも、ブランド・プラグインにファイルを提供します。
以前は、オリジナル・フィーチャーの sourceTemplatePlugin ディレクトリーの内容がソース・プラグインにコピーされていました。個々のソース・バンドルを生成している場合、このことはブランド・ソース・ファイルについてのみ、依然として該当します (上記を参照)。
他のすべてのソース・バンドルについては、sourceTemplateBundle ディレクトリーの内容がコピーされます。