源捆绑软件通过其清单中出现的 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>]*
当生成单独的源捆绑软件时,此属性保持不变并且支持相同的属性(例如,version、unpack 和 optional 等),在结果源功能部件中将公告存在的差别。以前,对于构建的每个平台,源功能部件将包含一个源插件和一个源段。 采用新格式时,对于原始功能部件中所列示的每个插件/段,源功能部件都将包含一个源捆绑软件。
通过 plugin@ 语法而包含在源功能部件中的插件将不会获得相应的源捆绑软件。这对于将文档插件添加至源功能部件很有用。
对于生成单个源,新增了 exclude@ 条目。包含在发起功能部件中的某些插件(即,仅包含本机代码的文档插件或段)可能没有源,应将它从生成的源功能部件中排除。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 头中具有正确的 roots 伪指令。
示例:
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>
以前,已生成的源插件充当已生成的源功能部件的标记插件。标记文件(about.properties 和 eclipse32.gif 等)是使用原始功能部件中的 sourceTemplatePlugin 目录提供的。
生成单独的源捆绑软件时,源功能部件的标记插件将是与原始标记插件相对应的源捆绑软件。这就意味着,可以使用原始标记插件中的 src.includes 属性来添加源功能部件的标记插件的标记文件。
要为其生成源的功能部件的 sourceTemplatePlugin 文件夹也会将文件添加至标记插件。
以前,原始功能部件的 sourceTemplatePlugin 目录中的内容被复制到源插件中。当生成单独的源捆绑软件时,仅对于标记源捆绑软件才会出现这种情况(请参阅上面的描述)。
对于所有其他源捆绑软件,将复制 sourceTemplateBundle 目录中的内容。