Un regroupement source est identifié par la présence de l'en-tête Eclipse-SourceBundle dans son manifeste. Le format de cet en-tête est le suivant :
Eclipse-SourceBundle: <ID-regroupement>;version=<version>;roots:="root1, root2"
L'ID et la version indiquent le regroupement auquel correspond le code source inclus. La directive roots indique les dossiers du regroupement source qui contiennent effectivement le code source. Si aucune directive roots n'est spécifiée, alors une valeur "." est adoptée.
Les bibliothèques de fichiers classe sont mappées sur les emplacements source et ce, de façon prévisible. La racine du plug-in est mappée sur celle du regroupement source. C'est le cas le plus fréquent pour la plupart des plug-in rassemblés dans des fichiers JAR. Si le plug-in contient des bibliothèques "foo/lib.jar" supplémentaires, la source doit normalement se trouver dans les dossiers "foo/libsrc/" correspondants des regroupements source.
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/Build peut générer automatiquement des regroupements source individuels, mais uniquement dans le cadre d'une génération sans interface graphique. Vous pouvez activer la génération de regroupements source individuels en spécifiant :
individualSourceBundles=true
Ce paramètre doit être spécifié dans le fichier de configuration de génération de niveau supérieur appelé build.properties ; il contrôle toute la création de source pour cette génération. Pour plus d'informations, voir Génération des dispositifs et des plug-in source. Le reste de cette page présuppose une bonne connaissance de la génération de source traditionnelle.
generate.feature@<ID dispositif source> = <ID dispositif> [, feature@<ID dispositif>]* [, plugin@<ID plug-in>]* [, exclude@<ID plug-in>]*
Lors de la génération de regroupements source individuels, cette propriété ne change pas et prend en charge les mêmes attributs (version, unpack, optional, etc), la différence apparaissant dans le dispositif source obtenu. Précédemment, le dispositif source aurait inclus un plug-in source + un fragment source pour chaque plateforme en cours de génération. Dans le nouveau format, le dispositif source inclura un regroupement source pour chaque plug-in/fragment répertorié dans le dispositif d'origine.
Les plug-in inclus dans le dispositif source via la syntaxe plugin@ n'obtiendront aucun regroupement source correspondant. Cela s'avère utile pour l'ajout de plug-in de document au dispositif source.
L'entrée exclude@ est nouvelle pour la génération de source individuelle. Certains plug-in inclus dans le dispositif d'origine (c'est-à-dire, les plug-ins de document ou les fragments qui contiennent uniquement du code natif) peuvent ne pas avoir de source et doivent être exclus du dispositif source généré. L'entrée exclude@ prend en charge un attribut version.
Exemple :generate.feature@org.eclipse.jdt.source=org.eclipse.jdt, plugin@org.eclipse.jdt.doc.isv;unpack="false",exclude@org.eclipse.jdt.doc.user
Dans l'ancien format, la propriété generate.plugin générait un plug-in source en fonction du contenu d'un dispositif donné. Désormais, lors de la génération de regroupements source individuels, cette opération s'effectue en fonction d'un plug-in donné :
generate.plugin@<ID plug-in source>=<ID plug-in>
La propriété generate.plugin était utilisée par les dispositifs pour inclure du code source sans avoir de dispositif source (même si en réalité, un dispositif source entier était généré). Lors de la génération de regroupements source individuels, les dispositifs auront besoin d'inclure un regroupement *.source pour chaque plug-in, ainsi qu'une propriété generate.plugin correspondante pour chacun.
Exemple : Le dispositif sdk.examples ressemblait à ce qui suit :
<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
Il ressemble désormais à ceci :
<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
Des plug-in spécifiques peuvent ne pas nécessiter de regroupements source, étant donné qu'ils ne contiennent pas réellement de code source. Cela peut être le cas avec des fragments spécifiques à une plateforme qui contiennent uniquement une bibliothèque native. Dans ce cas, les regroupements peuvent être exclus par le dispositif, comme décrit plus haut dans la section concernant generate.feature.
Les regroupements peuvent également spécifier dans leur propre fichier build.properties, de façon explicite, qu'aucun regroupement source ne doit être généré pour eux :
generateSourceBundle=false
Du contenu personnalisé peut toujours être ajouté à des regroupements source générés à l'aide du rappel personnalisé post.gather.source dans le regroupement d'origine (voir Etapes de la génération des dispositifs et des plug-in).
Pour ce faire, définissez la propriété "src.additionalRoots" dans le fichier build.properties du plug-in de sorte que le regroupement source généré présente la directive roots correcte sur l'en-tête Eclipse-SourceBundle.
Exemple :
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>
Précédemment, le plug-in source généré servait de plug-in d'image de marque pour le dispositif source généré. Les fichiers d'image de marque (about.properties, eclipse32.gif, etc.) étaient fournis à l'aide du répertoire sourceTemplatePlugin dans le dispositif d'origine.
Lors de la génération de regroupements source individuels, le plug-in d'image de marque du dispositif source sera le regroupement source correspondant au plug-in d'image de marque d'origine. Cela signifie que les fichiers d'image de marque du plug-in d'image de marque du dispositif source peuvent être fournis à l'aide de la propriété src.includes du plug-in d'image de marque d'origine.
Le dossier sourceTemplatePlugin du dispositif pour lequel on génère du code source fournit également des fichiers au plug-in d'image de marque.
Précédemment, le contenu du répertoire sourceTemplatePlugin du dispositif d'origine était copié dans le plug-in source d'origine. Lors de la génération de regroupements source individuels, cela reste vrai uniquement pour le regroupement source d'image de marque (voir plus haut).
Pour tous les autres regroupements source, le contenu d'un répertoire sourceTemplateBundle sera remplacé.