1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
|
<?xml version='1.0' encoding='UTF-8'?>
<!-- Schema file written by PDE -->
<schema targetNamespace="org.eclipse.cdt.core" xmlns="http://www.w3.org/2001/XMLSchema">
<annotation>
<appInfo>
<meta.schema plugin="org.eclipse.cdt.core" id="CIndex" name="CIndex"/>
</appInfo>
<documentation>
This extension point groups extensions to the index functionality in CDT
</documentation>
</annotation>
<element name="extension">
<annotation>
<appInfo>
<meta.element />
</appInfo>
</annotation>
<complexType>
<choice minOccurs="1" maxOccurs="unbounded">
<element ref="ExportProjectProvider"/>
<element ref="ReadOnlyPDOMProvider"/>
<element ref="ReadOnlyIndexFragmentProvider"/>
</choice>
<attribute name="point" type="string" use="required">
<annotation>
<documentation>
</documentation>
</annotation>
</attribute>
<attribute name="id" type="string">
<annotation>
<documentation>
</documentation>
</annotation>
</attribute>
<attribute name="name" type="string">
<annotation>
<documentation>
</documentation>
<appInfo>
<meta.attribute translatable="true"/>
</appInfo>
</annotation>
</attribute>
</complexType>
</element>
<element name="ExportProjectProvider">
<annotation>
<documentation>
<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>
This example ant file shows how to invoke the tool headlessly, the same approach would work from a shell or batch file.
<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>
</project>
</pre>
<p>
<b>Invoking the tool via an Eclipse Launch Configuration</b>
<p>
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
<p>
</documentation>
</annotation>
<complexType>
<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" basedOn=":org.eclipse.cdt.core.index.export.IExportProjectProvider"/>
</appInfo>
</annotation>
</attribute>
</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(ICConfigurationDescription config) {
final IPath sdkBase = AcmeSDKAPI.getSDKBase(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>
<sequence minOccurs="0" maxOccurs="1">
<element ref="FragmentProviderUsage"/>
</sequence>
<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>
<element name="ReadOnlyIndexFragmentProvider">
<annotation>
<documentation>
<h2>ReadOnlyIndexFragmentProvider</h2>
<p>
This subelement of CIndex allows ISVs to contribute read-only index fragments to the CDT Index. This extension point imposes no limitations on how the index information is collected and stored. The index fragments may, for example, be based on data dynamically fetched from a remote server.
<p>
The only information needed for this extension point is the fully qualified name of a class implementing the org.eclipse.cdt.core.index.IIndexFragmentProvider interface. This class will be consulted during the eclipse session for the appropriate read-only content to add to the logical index. The logical index is accessible via the org.eclipse.core.index.IIndex API.
</documentation>
</annotation>
<complexType>
<sequence minOccurs="0" maxOccurs="1">
<element ref="FragmentProviderUsage"/>
</sequence>
<attribute name="class" type="string" use="required">
<annotation>
<documentation>
The fully qualified name of a class implementing IIndexFragmentProvider.
</documentation>
<appInfo>
<meta.attribute kind="java" basedOn=":org.eclipse.cdt.internal.core.index.provider.IIndexFragmentProvider"/>
</appInfo>
</annotation>
</attribute>
</complexType>
</element>
<element name="FragmentProviderUsage">
<annotation>
<documentation>
Defines for which tools the fragment provider shall be used.
</documentation>
</annotation>
<complexType>
<attribute name="navigation" type="boolean" use="required">
<annotation>
<documentation>
Whether the fragment provider shall be used for performing 'Open Declaration' and 'Open Element'.
</documentation>
</annotation>
</attribute>
<attribute name="content_assist" type="boolean" use="required">
<annotation>
<documentation>
Whether the fragment provider shall be used for performing content-assist.
</documentation>
</annotation>
</attribute>
<attribute name="add_import" type="boolean" use="required">
<annotation>
<documentation>
Whether the fragment provider shall be used for performing 'Add Import'.
</documentation>
</annotation>
</attribute>
<attribute name="call_hierarchy" type="boolean" use="required">
<annotation>
<documentation>
Whether the fragment provider shall be used for populating the call hierarchy.
</documentation>
</annotation>
</attribute>
<attribute name="type_hierarchy" type="boolean" use="required">
<annotation>
<documentation>
Whether the fragment provider shall be used for populating the type hierarchy.
</documentation>
</annotation>
</attribute>
<attribute name="include_browser" type="boolean" use="required">
<annotation>
<documentation>
Whether the fragment provider shall be used for populating the include browser.
</documentation>
</annotation>
</attribute>
<attribute name="search" type="boolean" use="required">
<annotation>
<documentation>
Whether the fragment provider shall be used for C/C++ searches.
</documentation>
</annotation>
</attribute>
<attribute name="editor" type="boolean">
<annotation>
<documentation>
Whether the fragment provider shall be used for C/C++ editor.
</documentation>
</annotation>
</attribute>
</complexType>
</element>
<annotation>
<appInfo>
<meta.section type="since"/>
</appInfo>
<documentation>
4.0
</documentation>
</annotation>
<annotation>
<appInfo>
<meta.section type="examples"/>
</appInfo>
<documentation>
See subelement documentation
</documentation>
</annotation>
<annotation>
<appInfo>
<meta.section type="implementation"/>
</appInfo>
<documentation>
See subelement documentation
</documentation>
</annotation>
<annotation>
<appInfo>
<meta.section type="copyright"/>
</appInfo>
<documentation>
Copyright (c) 2007, 2011 Symbian Software Systems and others.
This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
</documentation>
</annotation>
<annotation>
<appInfo>
<meta.section type="apiInfo"/>
</appInfo>
<documentation>
Index content provided by ISVs under this extension point will be accessible via the logical index org.eclipse.core.index.IIndex API
For export functionality, see package org.eclipse.cdt.core.index.export
</documentation>
</annotation>
</schema>
|