Individuelle kildebundter

Det traditionelle format på kildebundter i Eclipse var en folder med src.zip-filer for alle de plugins, der var inkluderet i en given funktion. Fra og med 3.4 leveres Eclipse med individuelle kildebundter. For hvert bundt er der et tilhørende kildebundt, som er en jar med kilden til det pågældende bundt. Det gør leveringen af kildefiler mere fleksibel og afhjælper også nogle problemer med stilængder, som kunne forekomme på visse platforme.

Eclipse-SourceBundle

Et kildebundt angives af tilstedeværelsen af topteksten Eclipse-SourceBundle i dets manifest. Toptekstens format er:

Eclipse-SourceBundle: <bundle-id>;version=<version>;roots:="root1, root2"

bundle-id og version angiver det bundt, som den inkluderede kildekode svarer til. Direktivet roots angiver de foldere i kildebundtet, som faktisk indeholder kildekode. Hvis roots-direktivet ikke angives, antages, at værdien er ".".

Classfile-biblioteker tilknyttes vha. mapping til kildeplaceringer på en forudsigelig måde. Roden af plugin'en tilknyttes vha. mapping til roden af kildebundtet. Det er tilfældet for de fleste plugins i jar-format. Hvis plugin'en indeholder yderligere biblioteker, "foo/lib.jar", forventes kilden at være i tilsvarende "foo/libsrc/"-foldere i kildebundterne.

Generér individuelle kildebundter

PDE/Build kan automatisk generere individuelle kildebundter, men kun i et hovedløst byg. Generering af individuelle kildebundter kan aktiveres ved at angive følgende:

individualSourceBundles=true

Det skal angives i byggekonfigurationens build.properties-fil på øverste niveau, og det styrer al kildegenerering for det pågældende byg. Under Generér kildefunktioner og -plugins er der oplysninger om generering af traditionelle kilde-plugins og -funktioner. På resten af denne side antages det, at du er bekendt med traditionel kildegenerering.

generate.feature

I filen build.properties til en funktion informeres pde.build af egenskaben generate.feature om, at der skal genereres en kildefunktion.
generate.feature@<source feature id> = <feature id> [, feature@<feature id>]* [, plugin@<plugin id>]* [, exclude@<plugin id>]*

Når der genereres individuelle kildebundter, er egenskaben den samme som før og understøtter samme attributter (f.eks. version, unpack, optional osv.). Forskellen kan ses i den kildefunktion, der er resultatet. Før ville kildefunktionen have inkluderet 1 kilde-plugin + et kildefragment for hver platform, der blev bygget. I det nye format vil kildefunktionen inkludere et kildebundt for hver plugin/hvert fragment, der er opgivet i den oprindelige funktion.

Plugins, der blev inkluderet i kildefunktionen via syntaksen plugin@, vil ikke få tilsvarende kildebundter. Det er nyttigt, når man vil tilføje doc-plugins til kildefunktionen.

Indgangen exclude@ er ny for individuel kildegenerering. Nogle plugins, der var inkluderet i oprindelsesfunktionen (dvs. doc-plugins eller fragmenter, der kun indeholder indbygget kode), kan ikke have kilde og skal udelades i den genererede kildefunktion. Indgangen exclude@ understøtter attributten version.

Eksempel:
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

I det gamle format genererer egenskaben generate.plugin en kilde-plugin på grundlag af en givet funktions indhold. Ved generering af individuelle kildebundter ændres dette, så det baseres på en given plugin:

generate.plugin@<kilde-plugin-id>=<plugin-id>

Egenskaben generate.plugin blev brugt af funktioner til at inkludere kilde uden tilstedeværelse af en kildefunktion (selvom der i baggrunden blev genereret en hel kildefunktion). Ved generering af individuelle kildebundter skal funktioner inkludere et *.source-bundt for hver plugin sammen med en tilsvarende generate.plugin-egenskab for hver.

Eksempel: Funktionen sdk.examples så tidligere sådan ud:

   	<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

Det ændres til:

	<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

generateSourceBundle

Visse plugins kræver måske ikke kildebundter, fordi de i virkeligheden ikke indeholder kilde. Det kan forekomme med platformspecifikke fragmenter, som kun indeholder et indbygget bibliotek. I det tilfælde kan bundterne blive udeladt af funktionen som skitseret ovenfor i generate.feature.

For bundter kan det også udtrykkeligt angives i deres egen build.properties-fil, at der ikke skal genereres et kildebundt for dem:

generateSourceBundle=false

Tilpasset indhold

Der kan altid tilføjes tilpasset indhold til genererede kildebundter ved hjælp af tilpasset tilbagekald post.gather.source i oprindelsesbundtet. (Se Tilpas bygning af funktioner og plugins).

Hvis det gøres, skal egenskaben "src.additionalRoots" i plugin'ens build.properties-fil angives sådan, at generateSourceBundle har det rigtige roots-direktiv i Eclipse-SourceBundle-topteksten.

Eksempel:

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>

Mærkning af kildefunktionen

Tidligere fungerede den genererede kilde-plugin som en mærknings-plugin for den genererede kildefunktion. Mærkningsfiler (about.properties, eclipse32.gif osv.) blev leveret via biblioteket sourceTemplatePlugin i den oprindelige funktion.

Ved generering af individuelle kildebundter vil mærknings-plugin'en for kildefunktionen være det kildebundt, der svarer til den oprindelige mærknings-plugin. Det betyder, at der kan bidrages med mærkningsfilerne til kildefunktionens mærknings-plugin via egenskaben src.includes i den oprindelige mærknings-plugin.

Folderen sourceTemplatePlugin for den funktion, der genereres kilde til, bidrager også med filer til mærknings-plugin'en.

sourceTemplatePlugin sammenlignet med sourceTemplateBundle

Tidligere blev indholdet af biblioteket sourceTemplatePlugin for den oprindelige funktion kopieret ind i kilde-plugin'en. Ved generering af individuelle kildebundter er dette kun sandt for mærkningskildebundtet (se ovenfor).

For alle de andre kildebundter vil indholdet af biblioteket sourceTemplateBundle blive overskrevet.