Generera källfunktioner och källinsticksprogram

Från och med 3.4 levereras Eclipse med enskilda källsamlingspaket så att källan kan levereras på ett mer flexibelt sätt. Mer information finns på sidan "Individual Source Bundles". Vanliga källinsticksprogram i form av mappar kan fortfarande byggas (se beskrivningen nedan).

Studera följande SDK-funktion:


  features/
org.foo.sdk/
feature.xml: <includes id="org.foo.rcp" />
<includes id="org.foo.rcp.source" />
build.properties: generate.feature@org.foo.rcp.source = org.foo.rcp
org.foo.rcp/
feature.xml: <plugin id="org.foo.BundleA" />
<plugin id="org.foo.BundleB" />
<plugin id="org.foo.BundleB.win32" fragment="true" os="win32" />

Idén med SDK är att den innehåller både en funktion och källan till den funktionen. Observera egenskapen generate.feature i funktionens build.properties-fil. Den här egenskapen säger åt PDE-byggfunktionen att generera en funktion med namnet org.foo.rcp.source" baserad på innehållet i funktionen org.foo.rcp". PDE-byggfunktionen kommer att generera en org.foo.rcp.source-funktion, ett insticksprogram som kommer att innehålla källkoden och fragment som innehåller källan för eventuella plattformsspecifika paket som inkluderades i funktionen:


  features/
org.foo.rcp.source/
feature.xml: <plugin id="org.foo.rcp.source"/>
<plugin id="org.foo.rcp.source.win32" fragment="true" os="win32" />
plugins/
org.foo.rcp.source/src/
org.foo.BundleA/src.zip
org.foo.BundleB/src.zip
org.foo.rcp.source.win32/src/
org.foo.BundleB.win32/src.zip

Anpassa den genererade källfunktionen

Egenskapen generate.feature har följande format:

generate.feature@<source feature id> = <feature id> [, feature@<feature id>[;attribute=value]*]* [, plugin@<plugin id>[;attribute=value]*]*

Använd plugin@ när du vill lägga till ytterligare insticksprogram som inte ingick i den ursprungliga funktionen till den genererade källfunktionen. Det är användbart för dokumentationsinsticksprogram. feature@ tillsammans med en källmall kan användas för att nästla källfunktioner (se nedan).

Källmallar

Den funktion som källfunktionen genereras från kan tillhandahålla mallfiler som ska tas med i de genererade källfunktionerna:


  features/
org.foo.rcp/
sourceTemplateFeature/<filer som ska inkluderas i genererad källfunktion>
sourceTemplatePlugin/<filer som ska inkluderas i genererat källinsticksprogram>
sourceTemplateFragment/<filer som ska inkluderas i genererad plattforms specifika fragment>

Alla filer som finns i mappen sourceTemplate kommer att inkluderas i lämplig genererad funktion/insticksprogram/fragment. Närmare bestämt kommer filer från de här katalogerna att ersätta filer som genererats av PDE-byggfunktionen. Det här kan användas för att tillhandahålla en anpassad feature.xml om det finns krav för källfunktionen som PDE-byggfunktionen inte uppfyller.

Nästla genererade källfunktioner

Du kan nästla källfunktioner genom att tillhandahålla en sourceTemplateFeature/build.properties-fil för den genererade källfunktionen som innehåller en generate.feature-egenskap för den nästlade källfunktionen. Du behöver också se till att den översta feature.xml-källfilen innehåller den nästlade källfunktionen. Det gör du antingen genom att använda feature@ eller genom att tillhandahålla en feature.xml-mallfil:

  features/
org.foo.sdk/
sourceTemplateFeature/
build.properties: generate.feature@org.foo.nested.source = org.foo.nested

feature.xml: <includes id="org.foo.rcp" />
<includes id="org.foo.rcp.source" />

build.properties: generate.feature@org.foo.rcp.source = org.foo.rcp, feature@org.foo.nested.source

org.foo.rcp/...
org.foo.nested/...
I ovanstående exempel innehåller org.foo.sdk en genererad källfunktion med namnet org.foo.rcp.source. Den här genererade källfunktionen kommer att hämta mallfilen sourceTemplateFeature/build.properties.  Den kommer också att inkludera org.foo.nested.source i sin feature.xml. Så när PDE-byggfunktionen bearbetar den genererade org.foo.rcp.source, ser den att funktionen org.foo.nested.source och egenskapen generate.feature inkluderats och genererar sedan org.foo.nested.source.

Generera ett källinsticksprogram

Det är också möjligt att generera ett enskilt källinsticksprogram baserat på en funktion i stället för att generera en hel källfunktion. Egenskapen för att göra det är:

generate.plugin@<source plug-in id>=<feature-in id>

Kom ihåg att dessa källinsticksprogram av äldre typ (ett insticksprogram innehåller källan för alla insticksprogram för funktionen) måste installeras i form av mappar. Därför måste du ange unpack="true" för attributet i filen feature.xml.

Exempel:
  features/
org.foo.sdk/
feature.xml: <plugin id="org.foo.rcp" />
<plugin id="org.foo.sdk.source" unpack="true" />

build.properties: generate.plugin@org.foo.sdk.source = org.foo.sdk