Paquetes fuente individuales

El formato tradicional de los paquetes fuente en Eclipse era una carpeta que contenía los src.zip de todos los plug-ins incluidos en una característica dada. A partir de 3.4, Eclipse se envía con paquetes fuente individuales. Para cada paquete hay un paquete fuente correspondiente que es un jar que contiene el código fuente de ese paquete. Esto permite tener más flexibilidad de fuente y también mitiga algunos problemas de vía de acceso que pueden experimentarse en algunas plataformas.

Eclipse-SourceBundle

Un paquete fuente está identificado por la presencia de la cabecera Eclipse-SourceBundle en su manifiesto. El formato de esta cabecera es:

Eclipse-SourceBundle: <id-de-paquete>;version=<versión>;roots:="root1, root2"

El id-de-paquete y la versión indican el paquete al que corresponde el código fuente incluido. La directiva roots indica las carpetas del paquete fuente que realmente contienen código fuente. Si no se especifica ninguna directiva roots, se presupone el valor ".".

Las bibliotecas de archivo de clases se correlacionan con las ubicaciones fuente de forma predecible. La raíz de las correlaciones de plug-in se correlacionan con la raíz del paquete fuente. Este es el caso principal para la mayoría de plug-ins en jar. Si el plug-in contiene bibliotecas "foo/lib.jar" adicionales, se espera que el fuente esté en las carpetas "foo/libsrc/" correspondientes de los paquetes fuente.

Generar paquetes fuente individuales

PDE/Construcción puede generar automáticamente paquetes fuente individuales, pero solo en una construcción autónoma. La generación de paquetes fuente puede activarse especificando:

individualSourceBundles=true

Esto debe especificarse en el archivo build.properties de nivel superior de la configuración de construcción y controla toda la generación de fuente para esa construcción. Consulte la sección Generar características y plug-ins fuente para obtener detalles sobre la generación de plug-ins y características fuente tradicionales, en el el resto de esta página se presupone que está familiarizado con la generación de fuente tradicional.

generate.feature

En el archivo build.properties de una característica, la propiedad generate.feature indica a pde.build que genere una característica fuente.
generate.feature@<id de característica fuente> = <id de característica> [, feature@<id de característica>]* [, plugin@<id de plug-in>]* [, exclude@<id de plug-in>]*

Al generar paquetes fuente individuales, esta propiedad permanece como antes y soporta los mismos atributos (por ejemplo version, unpack, opcional, etc), la diferencia se notará en la característica fuente resultante. Antes, la característica fuente habría incluido un plug-in fuente más un fragmento de fuente para cada plataforma que se construyera. En el formato nuevo, la característica nueva incluirá un paquete fuente para cada plug-in/fragmento listado en la característica original.

Los plug-ins incluidos en la característica fuente a través de la sintaxis plugin@ no obtendrán paquetes fuente correspondientes. Esto es útil para añadir plug-ins de doc a la característica fuente.

La entrada exclude@ es nueva para la generación de fuente individual. Algunos plug-ins incluidos en la característica originante (es decir, plug-ins de documento o fragmentos que solo contienen código nativo) no pueden tener código fuente y deben excluirse de la característica de fuente generada. La entrada exclude@ soporta un atributo version.

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

En el formato antiguo, la propiedad generate.plugin genera un plug-in fuente basado en el contenido de una característica dada. Al generar paquetes fuente individuales, esto pasa a estar basado en un plug-in dado:

generate.plugin@<id de plug-in fuente>=<id de plug-in>

Las características utilizaban la propiedad generate.plugin para incluir fuente sin tener una característica fuente (incluso aunque se generara toda una característica fuente entre bastidores. Al generar un paquete fuente individual, las características deberán incluir un paquete *.source para cada plug-in conjuntamente con una propiedad generate.plugin correspondiente para cada uno.

Ejemplo: la característica sdk.examples solía tener este aspecto:

   	<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

Esto cambia a:

	<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

Los plug-ins específicos no necesitan paquetes fuente porque realmente no contienen código fuente. Esto puede producirse con fragmentos específicos de plataforma que solo contienen una biblioteca nativa. En este caso, la característica puede excluir los paquetes tal como se resalta más arriba, en generate.feature.

O bien, los paquetes pueden especificar explícitamente en su propio archivo build.properties que no se debe generar ningún paquete fuente para ellos:

generateSourceBundle=false

Contenido personalizado

El contenido personalizado siempre puede añadirse a los paquetes fuente generados mediante la devolución de llamada personalizada post.gather.source en el paquete originante. (Consulte la sección Pasos de construcción personalizados de característica y plug-in).

Al hacer esto, establezca la propiedad "src.additionalRoots" en el archivo build.properties del plug-in de modo que el paquete fuente generado tenga la directiva roots correcta en la cabecera Eclipse-SourceBundle.

Ejemplo:

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>

Marcar la característica fuente

Anteriormente, el plug-in fuente generado servía como plug-in de marca para la característica fuente generada. Los archivos de marca (about.properties, eclipse32.gif, etc) se proporcionaban mediante el directorio sourceTemplatePlugin en la característica original.

Al generar paquetes fuente individuales, el plug-in de marca para la característica fuente será el paquete fuente correspondiente al plug-in de marca original. Esto significa que los archivos de marca para el plug-in de marca de la característica fuente pueden aportarse mediante la propiedad src.includes en el plug-in de marca original.

La carpeta sourceTemplatePlugin de la característica para la que estamos generando código fuente también aporta archivos al plug-in de marca.

sourceTemplatePlugin vs sourceTemplateBundle

Anteriormente, el contenido del directorio sourceTemplatePlugin de la característica original se copiaba en el plug-in fuente. Cuando se generan paquetes fuente, esto sigue siendo válido sólo para el paquete fuente de marca (ver más arriba).

Para el resto de paquetes fuente, se copiará el contenido de un directorio sourceTemplateBundle.