diff options
Diffstat (limited to 'core/org.eclipse.cdt.core/schema/CIndex.exsd')
| -rw-r--r-- | core/org.eclipse.cdt.core/schema/CIndex.exsd | 119 |
1 files changed, 91 insertions, 28 deletions
diff --git a/core/org.eclipse.cdt.core/schema/CIndex.exsd b/core/org.eclipse.cdt.core/schema/CIndex.exsd index e51d98216fc..3525095e945 100644 --- a/core/org.eclipse.cdt.core/schema/CIndex.exsd +++ b/core/org.eclipse.cdt.core/schema/CIndex.exsd @@ -14,6 +14,7 @@ <complexType> <choice minOccurs="1" maxOccurs="unbounded"> <element ref="ExportProjectProvider"/> + <element ref="ReadOnlyPDOMProvider"/> </choice> <attribute name="point" type="string" use="required"> <annotation> @@ -45,7 +46,9 @@ <element name="ExportProjectProvider"> <annotation> <documentation> - This element allows contribution of alternate IExportProjectProvider implementations. These can then be referenced by fully qualified class name in the command line tool (see option -pprovider). + <h2>ExportProjectProvider</h2> +<p> +This subelement of CIndex allows contribution of alternate IExportProjectProvider implementations. These can then be referenced by fully qualified class name in the command line tool (see option -pprovider). <p> <b>Invoking the application as a headless application</b> @@ -53,30 +56,30 @@ This example ant file shows how to invoke the tool headlessly, the same approach <pre> <project name="Generate PDOM" default="generate"> - <target name="generate"> - <!-- This script shows how to invoke the default project provider (ExternalExportProjectProvider) --> - <property name="pprovider" value="org.eclipse.cdt.core.index.export.ExternalExportProjectProvider"/> - <property name="target" value="C:\ExportedPDOMs\acmeSDK_2_5.pdom"/> <!-- Where the output pdom is to go --> - <property name="source" value="E:\AcmeSDK\v2.5\inc"/> <!-- e.g. the directory to source content from --> - <property name="id" value="com.acme.mysdk.v2.5"/> <!-- the id to store in the generate pdom --> - - <property name="eclipse.home" value="C:\eclipse"/> <!-- e.g. The eclipse installation to use. This installation must contain CDT 4.0+ plugins --> - - <java classname="org.eclipse.equinox.launcher.Main"> - <classpath> - <fileset dir="${eclipse.home}/plugins"> - <include name="*equinox.launcher*.jar"/> - </fileset> - </classpath> - <arg value="-nosplash"/> - <arg value="-exitdata"/> - <arg value="-application"/><arg value="org.eclipse.cdt.core.GeneratePDOM"/> - <arg value="-pprovider"/><arg value="${pprovider}"/> - <arg value="-source"/><arg value="${source}"/> - <arg value="-target"/><arg value="${target}"/> - <arg value="-id"/><arg value="${id}"/> - </java> - </target> + <target name="generate"> + <!-- This script shows how to invoke the default project provider (ExternalExportProjectProvider) --> + <property name="pprovider" value="org.eclipse.cdt.core.index.export.ExternalExportProjectProvider"/> + <property name="target" value="C:\ExportedPDOMs\acmeSDK_2_5.pdom"/> <!-- Where the output pdom is to go --> + <property name="source" value="E:\AcmeSDK\v2.5\inc"/> <!-- e.g. the directory to source content from --> + <property name="id" value="com.acme.mysdk.v2.5"/> <!-- the id to store in the generate pdom --> + + <property name="eclipse.home" value="C:\eclipse"/> <!-- e.g. The eclipse installation to use. This installation must contain CDT 4.0+ plugins --> + + <java classname="org.eclipse.equinox.launcher.Main"> + <classpath> + <fileset dir="${eclipse.home}/plugins"> + <include name="*equinox.launcher*.jar"/> + </fileset> + </classpath> + <arg value="-nosplash"/> + <arg value="-exitdata"/> + <arg value="-application"/><arg value="org.eclipse.cdt.core.GeneratePDOM"/> + <arg value="-pprovider"/><arg value="${pprovider}"/> + <arg value="-source"/><arg value="${source}"/> + <arg value="-target"/><arg value="${target}"/> + <arg value="-id"/><arg value="${id}"/> + </java> + </target> </project> </pre> <p> @@ -85,15 +88,15 @@ This example ant file shows how to invoke the tool headlessly, the same approach Specify "org.eclipse.cdt.core.GeneratePDOM" as the application to launch <p> In the Argument tabs provide (for example) - -target C:\ExportedPDOMs\acmeSDK_2_5.pdom -source E:\AcmeSDK\v2.5\inc -include E:\this.h -id com.acme.mysdk.v2.5 + -target C:\ExportedPDOMs\acmeSDK_2_5.pdom -source E:\AcmeSDK\v2.5\inc -include E:\this.h -id com.acme.mysdk.v2.5 <p> </documentation> </annotation> <complexType> - <attribute name="class" type="string"> + <attribute name="class" type="string" use="required"> <annotation> <documentation> - + the fully qualified name of the IExportProjectProvider implementation to register </documentation> <appInfo> <meta.attribute kind="java"/> @@ -103,6 +106,66 @@ In the Argument tabs provide (for example) </complexType> </element> + <element name="ReadOnlyPDOMProvider"> + <annotation> + <documentation> + <h2>ReadOnlyPDOMProvider</h2> +<p> +This subelement of CIndex allows ISVs to contribute read-only prebuilt PDOM files to the CDT Index. The only information needed is the fully qualified class name of an implementatin of org.eclipse.cdt.core.index.IOfflinePDOMProvider. This implementation will be consulted during the eclipse session for the appropriate read-only content to make add to the logical index. The logical index is accessible via the org.eclipse.core.index.IIndex API. + + An example of contributing a prebuilt read-only pdom: +<pre> +<CIndex> + <ReadOnlyPDOMProvider class="com.acme.ide.index.AcmeSDKProvider"/> +</CIndex> +</pre> + +and the corresponding implementation + +<pre> +package com.acme.ide.index.sdk; + +import org.eclipse.core.index.provider.IReadOnlyPDOMProvider; +import org.eclipse.core.index.provider.IPDOMDescriptor; +import org.eclipse.core.index.IIndexLocationConverter; +import org.eclipse.core.index.URIRelativeLocationConverter; + +public class AcmeSDKProvider implements IReadOnlyPDOMProvider { + public boolean providesFor(ICProject project) { + // e.g. decide by looking for acme project nature + return AcmeNature.isAcmeProject(project); + } + + public IPDOMDescriptor[] getDescriptors(ICProject cproject, ICConfigurationDescription config) { + final IPath sdkBase = AcmeSDKAPI.getSDKBase(cproject, config); + return new IPDOMDescriptor[] { new IPDOMDescriptor() { + public IIndexLocationConverter getIndexLocationConverter() { + return new URIRelativeLocationConverter(URIUtil.toURI(sdkBase)); + } + public IPath getLocation() { + IPath path = sdkBase.append(AcmeSDKAPI.getPrebuiltPDOMFilename(config)); + return path; + } + }}; + } +} +</pre> + </documentation> + </annotation> + <complexType> + <attribute name="class" type="string" use="required"> + <annotation> + <documentation> + the fully qualified name of the IReadOnlyPDOMProvider implementation to register + </documentation> + <appInfo> + <meta.attribute kind="java" basedOn="org.eclipse.cdt.core.index.provider.IReadOnlyPDOMProvider"/> + </appInfo> + </annotation> + </attribute> + </complexType> + </element> + <annotation> <appInfo> <meta.section type="since"/> |