Individuální zdrojové balíky

Tradičním formátem zdrojových balíků v Eclipse byla složka obsahující src.zip pro všechny moduly plug-in obsažené v dané funkci. Od verze 3.4 se Eclipse nyní dodává s jednotlivými zdrojovými balíky. Pro každý balík existuje odpovídající zdrojový balík, což je soubor jar obsahující zdroj pro tento balík. To umožňuje pružnější dodávání zdroje a také zmírňuje některé problémy s délkou cesty, s nimiž se lze setkat u některých platforem.

Eclipse-SourceBundle

Zdrojový balík je identifikován přítomností záhlaví Eclipse-SourceBundle v jeho souboru typu manifest. Formát záhlaví je:

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

ID balíku a verze označují balík, jemuž obsažený zdrojový kód odpovídá. Direktiva roots označuje složky ve zdrojovém balíku, které skutečně obsahují zdrojový kód. Pokud není žádná direktiva roots specifikována, předpokládá se hodnota ".".

Knihovny souboru třídy jsou mapovány na zdrojová umístění předvídatelným způsobem. Kořen modulu plug-in mapuje do kořene zdrojového balíku. Toto je hlavní případ pro většinu modulů plug-in se souborem jar. Pokud modul plug-in obsahuje další knihovny "foo/lib.jar", očekává se, že zdroj bude v příslušných složkách "foo/libsrc/" ve zdrojových balících.

Generování individuálních zdrojových balíků

PDE/Build může automaticky generovat individuální zdrojové balíky, ale pouze v sestavení bez hlavičky. Generování individuálního zdrojového balíku lze zapnout zadáním:

individualSourceBundles=true

To musí být zadáno v souboru nejvyšší úrovně konfigurace build.properties a řídí veškeré generování zdroje pro toto sestavení. Podrobnosti o generování tradičních modulů plug-in a funkcí zdroje najdete v tématu Generování funkcí a modulů plug-in zdroje, zbytek této stránky předpokládá obeznámenost s tradičním generováním zdroje.

generate.feature

Vlastnost generate.feature v souboru funkce build.properties sděluje, aby pde.build vygeneroval funkci zdroje.
generate.feature@<source feature id> = <feature id> [, feature@<feature id>]* [, plugin@<plugin id>]* [, exclude@<plugin id>]*

Při generování individuálních zdrojových balíků zůstává tato vlastnost stejná jako dříve a podporuje stejné atributy (např. verze, rozbalit, volitelné atd.), rozdíl lze zaznamenat ve výsledné funkci zdroje. Dříve by funkce zdroje obsahovala jeden modul plug-in zdroje + fragment zdroje pro každou sestavovanou platformu. V novém formátu bude funkce zdroje obsahovat zdrojový balík pro každý modul plug-in/fragment uvedený v původní funkci.

Moduly plug-in, které byly obsaženy ve funkci zdroje prostřednictvím syntaxe plugin@, nezískají odpovídající zdrojové svazky. To je užitečné pro přidávání modulů plug-in dokumentů k funkci zdroje.

Položka exclude@ je nová pro individuální generování zdroje. Některé moduly plug-in, které byly obsaženy v původní funkci (tj. moduly plug-in dokumentů nebo fragmenty, které obsahují pouze nativní kód) nemusejí mít zdroj a měly by být vyloučeny z generované funkce zdroje. Položka exclude@ podporuje atribut version.

Příklad:
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

Ve starém formátu vlastnost generate.plugin generuje modul plug-in zdroje na základě obsahu dané funkce. Při generování individuálních zdrojových balíků jsou tyto změny založeny na daném modulu plug-in:

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

Vlastnost generate.plugin byla funkcemi používána k zahrnutí zdroje bez funkce zdroje (i když v pozadí byla generována celá funkce zdroje). Při generování individuálního zdrojového balíku budou funkce muset zahrnovat balík *.source pro každý modul plug-in spolu s příslušnou vlastností generate.plugin pro každý z nich.

Příklad: Funkce sdk.examples dříve vypadala takto:

   	<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

To se mění na:

	<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

Specifické moduly plug-in nemusejí vyžadovat zdrojové balíky, protože ve skutečnosti neobsahují zdroj. K tomu může dojít u fragmentů specifických pro platformu, které obsahují pouze nativní knihovnu. V tomto případě mohou být balíky funkcí vyloučeny, jak je načrtnuto výše v generate.feature.

Nebo mohou balíky explicitně specifikovat ve svém vlastním souboru build.properties, že by pro ně neměl být generován žádný zdrojový balík:

generateSourceBundle=false

Vlastní obsah

Ke generovaným zdrojovým balíkům lze vždy přidat vlastní obsah pomocí vlastního zpětného volání post.gather.source v původním balíku. (Viz Kroky vlastního sestavení funkce a modulu plug-in).

Při tom nastavte vlastnost "src.additionalRoots" v souboru build.properties modulu plug-in tak, aby měl generovaný zdrojový balík správnou direktivu roots v záhlaví Eclipse-SourceBundle.

Příklad:

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>

Značení funkce zdroje

Generovaný modul plug-in zdroje dříve sloužil jako modul plug-in značení pro generovanou funkci zdroje. Soubory značení (about.properties, eclipse32.gif atd.) byly v původní funkci poskytovány pomocí adresáře sourceTemplatePlugin.

Při generování individuálních zdrojových balíků bude modulem plug-in značení balík zdroje odpovídající původnímu modulu plug-in značení. To znamená, že soubory značení pro modul plug-in značení funkce zdroje mohou být přidány pomocí vlastnosti src.includes v původním modulu plug-in značení.

Složka sourceTemplatePlugin funkce, pro které generujeme zdroj, také přispívá soubory k modulu plug-in značení.

sourceTemplatePlugin versus sourceTemplateBundle

Dříve byl obsah adresáře sourceTemplatePlugin původní funkce kopírován do modulu plug-in zdroje. Při generování individuálních zdrojových balíků to je nadále pravda pouze pro zdrojový balík značení (viz výše).

Pro všechny ostatní zdrojové balíky bude kopírován obsah adresáře sourceTemplateBundle.