diff options
Diffstat (limited to 'core/org.eclipse.cdt.core/schema/LanguageSettingsProvider.exsd')
| -rw-r--r-- | core/org.eclipse.cdt.core/schema/LanguageSettingsProvider.exsd | 538 |
1 files changed, 258 insertions, 280 deletions
diff --git a/core/org.eclipse.cdt.core/schema/LanguageSettingsProvider.exsd b/core/org.eclipse.cdt.core/schema/LanguageSettingsProvider.exsd index 692e5d9098d..ab7adac15c2 100644 --- a/core/org.eclipse.cdt.core/schema/LanguageSettingsProvider.exsd +++ b/core/org.eclipse.cdt.core/schema/LanguageSettingsProvider.exsd @@ -1,280 +1,258 @@ -<?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="LanguageSettingsProvider" name="LanguageSettingsProvider"/>
- </appInfo>
- <documentation>
- This extension point is used to contribute a new Language Settings Provider. A Language Settings Provider is used to get additions to compiler options such as include paths (-I) or preprocessor defines (-D) and others into the project model.
- </documentation>
- </annotation>
-
- <element name="extension">
- <annotation>
- <appInfo>
- <meta.element />
- </appInfo>
- <documentation>
- This extension point is used to contribute a new Language Settings Provider. A Language Settings Provider is used to get additions to compiler options such as include paths (-I) or preprocessor defines (-D) and others into the project model.
- </documentation>
- </annotation>
- <complexType>
- <sequence minOccurs="1" maxOccurs="unbounded">
- <element ref="provider"/>
- </sequence>
- <attribute name="point" type="string" use="required">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="id" type="string">
- <annotation>
- <documentation>
- ID of the extension point, not used
- </documentation>
- </annotation>
- </attribute>
- <attribute name="name" type="string">
- <annotation>
- <documentation>
- Name of the extension point, not used
- </documentation>
- <appInfo>
- <meta.attribute translatable="true"/>
- </appInfo>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="provider">
- <annotation>
- <documentation>
- The definition of a language settings provider.
- </documentation>
- </annotation>
- <complexType>
- <sequence>
- <element ref="language-scope" minOccurs="0" maxOccurs="unbounded"/>
- <element ref="entry" minOccurs="0" maxOccurs="unbounded"/>
- </sequence>
- <attribute name="class" type="string">
- <annotation>
- <documentation>
- A fully qualified name of the Java class that implements <samp>org.eclipse.cdt.core.language.settings.providers</samp> interface. If empty, <samp>org.eclipse.cdt.core.language.settings.providers.LanguageSettingsBaseProvider</samp> is used by default which provides basic functionality defined by this extension point.<br>
-In case the provider ever needs to be non-shared, set per project/configuration, or editable in UI - the provider must implement <samp>org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsEditableProvider</samp>. There is a generic implementation <samp>org.eclipse.cdt.core.language.settings.providers.LanguageSettingsGenericProvider</samp> that can be used in most cases.<br>
-If there is a need to configure a provider in more deliberate way, attribute <samp>parameter</samp> could be used in a class extending <samp>LanguageSettingsBaseProvider</samp>.<br>
-Default constructor (constructor without arguments) of this class must be public and the package be exported in order to be able to instantiate via extension point.
- </documentation>
- <appInfo>
- <meta.attribute kind="java" basedOn="org.eclipse.cdt.core.language.settings.providers.LanguageSettingsBaseProvider:org.eclipse.cdt.core.settings.model.ILanguageSettingsProvider"/>
- </appInfo>
- </annotation>
- </attribute>
- <attribute name="id" type="string" use="required">
- <annotation>
- <documentation>
- Unique ID of the provider.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="name" type="string" use="required">
- <annotation>
- <documentation>
- Name of the provider. This name will be presented to a user in UI.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="parameter" type="string">
- <annotation>
- <documentation>
- A custom parameter to initialize provider. For example, used to deliver command for GCCBuiltinSpecsDetector.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="prefer-non-shared" type="boolean" use="default" value="false">
- <annotation>
- <documentation>
- A flag indicating that the provider should be owned by a configuration rather than be global in workspace and shared between projects (when the choice has not been indicated yet by other means). This preference is consulted in order to initially set the "shared" attribute, for example when a user adds a provider from the list of extension providers.
-The value "true" of this attribute is meaningful only for providers capable of being non-shared, i.e. providers extending ILanguageSettingsEditableProvider.
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="language-scope">
- <annotation>
- <documentation>
- The definition of language scope. Includes the list of language ID this provider is applicable to. If a language scope is not present, the provider will provide for any language.
- </documentation>
- </annotation>
- <complexType>
- <attribute name="id" type="string" use="required">
- <annotation>
- <documentation>
- ID of the language for which this provider provides the entries. As an example, those are languages contributed by CDT (see extension org.eclipse.cdt.core.language):
-<p>- "<samp>org.eclipse.cdt.core.gcc</samp>" for C,</p>
-<p>- "<samp>org.eclipse.cdt.core.g++</samp>" for C++.</p>
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="entry">
- <annotation>
- <documentation>
- The Language Settings Entries used to provide additions to compiler options such as include paths (-I) or preprocessor defines (-D) and others into the project model.
- </documentation>
- </annotation>
- <complexType>
- <sequence>
- <element ref="flag" minOccurs="0" maxOccurs="unbounded"/>
- </sequence>
- <attribute name="kind" use="required">
- <annotation>
- <documentation>
- Kind of language settings entry which maps to compiler options. For example, following mapping is used for gcc options:
-
-<br>"<samp>-I</samp>" : includePath
-<br>"<samp>-D</samp>" : macro
-<br>"<samp>-include</samp>" : includeFile
-<br>"<samp>-L</samp>" : libraryPath
-<br>"<samp>-l</samp>" : libraryFile
-<br>"<samp>-imacros</samp>" : macroFile
- </documentation>
- </annotation>
- <simpleType>
- <restriction base="string">
- <enumeration value="includePath">
- </enumeration>
- <enumeration value="macro">
- </enumeration>
- <enumeration value="includeFile">
- </enumeration>
- <enumeration value="libraryPath">
- </enumeration>
- <enumeration value="libraryFile">
- </enumeration>
- <enumeration value="macroFile">
- </enumeration>
- </restriction>
- </simpleType>
- </attribute>
- <attribute name="name" type="string" use="required">
- <annotation>
- <documentation>
- "name" attribute maps to path for the entries representing a path to a folder or file and to name for <samp>macro</samp> kind representing name-value pair. For example:
-<br>"<samp>/usr/include/</samp>"
-<br>"<samp>MACRO</samp>" (for <samp>#define MACRO value</samp>)
-<br>Note that relative paths are treated as rooted in build working directory (when applicable).
- </documentation>
- </annotation>
- </attribute>
- <attribute name="value" type="string">
- <annotation>
- <documentation>
- "value" attribute is used for <samp>macro</samp> kind representing name-value pair only. It is not used for the entries representing a path. For example:
-<br>"<samp>value</samp>" (for <samp>#define MACRO value</samp>)
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="flag">
- <annotation>
- <documentation>
- Combination of flags for the entry.
- </documentation>
- </annotation>
- <complexType>
- <attribute name="value" use="required">
- <annotation>
- <documentation>
- A value of the flag. Corresponds to <samp>ICSettingEntry</samp> flags, see JavaDoc there for more details. Here is an excerpt from the Javadoc for the flags intended to be used with this extension point (the others might be not supported):
- <br>- <samp>BUILTIN</samp> : Indicates settings built in a tool (compiler) itself. That kind of settings are not passed as options to a compiler but indexer or other clients might need them.
- <br>- <samp>LOCAL</samp> : Applicable for <samp>includePath</samp> only which could be local (#include "...") or system (#include <...>). If an <samp>includePath</samp> is not marked as <samp>LOCAL</samp> it is treated as system.
- <br>- <samp>RESOLVED</samp> : Indicates that the entries do not need to be resolved such as expansion of environment variables, normalizing the path against build working directory etc.
- <br>- <samp>VALUE_WORKSPACE_PATH</samp> : is used to indicate that the entry is a resource managed by eclipse in the workspace. The path is rooted in the workspace root.
- <br>- <samp>UNDEFINED</samp> : indicates that the entry should not be defined, corresponds to <samp>-U</samp> option of gcc compiler. If this flag is defined it will negate entries with the same name (and kind) for all providers down the list.
- <br>- <samp>EXPORTED</samp> : indicates that the entry is exported to referencing projects. It will be passed to the projects configurations referencing the configuration the entry belongs to.
- </documentation>
- </annotation>
- <simpleType>
- <restriction base="string">
- <enumeration value="BUILTIN">
- </enumeration>
- <enumeration value="LOCAL">
- </enumeration>
- <enumeration value="RESOLVED">
- </enumeration>
- <enumeration value="VALUE_WORKSPACE_PATH">
- </enumeration>
- <enumeration value="UNDEFINED">
- </enumeration>
- <enumeration value="EXPORTED">
- </enumeration>
- </restriction>
- </simpleType>
- </attribute>
- </complexType>
- </element>
-
- <annotation>
- <appInfo>
- <meta.section type="since"/>
- </appInfo>
- <documentation>
- CDT 8.1
- </documentation>
- </annotation>
-
- <annotation>
- <appInfo>
- <meta.section type="examples"/>
- </appInfo>
- <documentation>
- [Enter extension point usage example here.]
- </documentation>
- </annotation>
-
- <annotation>
- <appInfo>
- <meta.section type="apiinfo"/>
- </appInfo>
- <documentation>
- Plug-ins that want to extend this extension point must implement <samp>org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider</samp> interface.
-<br/>
-For those cases where contributed settings entries (representing the compiler options) are not changed dynamically it is sufficient to configure existing class LanguageSettingsBaseProvider which is provided by default.
-<br/>
- </documentation>
- </annotation>
-
- <annotation>
- <appInfo>
- <meta.section type="implementation"/>
- </appInfo>
- <documentation>
- [Enter information about supplied implementation of this extension point.]
- </documentation>
- </annotation>
-
- <annotation>
- <appInfo>
- <meta.section type="copyright"/>
- </appInfo>
- <documentation>
- Copyright (c) 2009, 2013 Andrew Gvozdev and others.
-All rights reserved. This program and the accompanying materials
-are made available under the terms of the Eclipse Public License v1.0
-which accompanies this distribution, and is available at
-http://www.eclipse.org/legal/epl-v10.html
- </documentation>
- </annotation>
-
-</schema>
+<?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="LanguageSettingsProvider" name="LanguageSettingsProvider"/> + </appInfo> + <documentation> + This extension point is used to contribute a new Language Settings Provider. A Language Settings Provider is used to get additions to compiler options such as include paths (-I) or preprocessor defines (-D) and others into the project model. + </documentation> + </annotation> + <element name="extension"> + <annotation> + <appInfo> + <meta.element /> + </appInfo> + <documentation> + This extension point is used to contribute a new Language Settings Provider. A Language Settings Provider is used to get additions to compiler options such as include paths (-I) or preprocessor defines (-D) and others into the project model. + </documentation> + </annotation> + <complexType> + <sequence minOccurs="1" maxOccurs="unbounded"> + <element ref="provider"/> + </sequence> + <attribute name="point" type="string" use="required"> + <annotation> + <documentation> + + </documentation> + </annotation> + </attribute> + <attribute name="id" type="string"> + <annotation> + <documentation> + ID of the extension point, not used + </documentation> + </annotation> + </attribute> + <attribute name="name" type="string"> + <annotation> + <documentation> + Name of the extension point, not used + </documentation> + <appInfo> + <meta.attribute translatable="true"/> + </appInfo> + </annotation> + </attribute> + </complexType> + </element> + <element name="provider"> + <annotation> + <documentation> + The definition of a language settings provider. + </documentation> + </annotation> + <complexType> + <sequence> + <element ref="language-scope" minOccurs="0" maxOccurs="unbounded"/> + <element ref="entry" minOccurs="0" maxOccurs="unbounded"/> + </sequence> + <attribute name="class" type="string"> + <annotation> + <documentation> + A fully qualified name of the Java class that implements <samp>org.eclipse.cdt.core.language.settings.providers</samp> interface. If empty, <samp>org.eclipse.cdt.core.language.settings.providers.LanguageSettingsBaseProvider</samp> is used by default which provides basic functionality defined by this extension point.<br> +In case the provider ever needs to be non-shared, set per project/configuration, or editable in UI - the provider must implement <samp>org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsEditableProvider</samp>. There is a generic implementation <samp>org.eclipse.cdt.core.language.settings.providers.LanguageSettingsGenericProvider</samp> that can be used in most cases.<br> +If there is a need to configure a provider in more deliberate way, attribute <samp>parameter</samp> could be used in a class extending <samp>LanguageSettingsBaseProvider</samp>.<br> +Default constructor (constructor without arguments) of this class must be public and the package be exported in order to be able to instantiate via extension point. + </documentation> + <appInfo> + <meta.attribute kind="java" basedOn="org.eclipse.cdt.core.language.settings.providers.LanguageSettingsBaseProvider:org.eclipse.cdt.core.settings.model.ILanguageSettingsProvider"/> + </appInfo> + </annotation> + </attribute> + <attribute name="id" type="string" use="required"> + <annotation> + <documentation> + Unique ID of the provider. + </documentation> + <appInfo> + <meta.attribute kind="identifier"/> + </appInfo> + </annotation> + </attribute> + <attribute name="name" type="string" use="required"> + <annotation> + <documentation> + Name of the provider. This name will be presented to a user in UI. + </documentation> + <appInfo> + <meta.attribute translatable="true"/> + </appInfo> + </annotation> + </attribute> + <attribute name="parameter" type="string"> + <annotation> + <documentation> + A custom parameter to initialize provider. For example, used to deliver command for GCCBuiltinSpecsDetector. + </documentation> + </annotation> + </attribute> + <attribute name="prefer-non-shared" type="boolean" use="default" value="false"> + <annotation> + <documentation> + A flag indicating that the provider should be owned by a configuration rather than be global in workspace and shared between projects (when the choice has not been indicated yet by other means). This preference is consulted in order to initially set the "shared" attribute, for example when a user adds a provider from the list of extension providers. +The value "true" of this attribute is meaningful only for providers capable of being non-shared, i.e. providers extending ILanguageSettingsEditableProvider. + </documentation> + </annotation> + </attribute> + </complexType> + </element> + <element name="language-scope"> + <annotation> + <documentation> + The definition of language scope. Includes the list of language ID this provider is applicable to. If a language scope is not present, the provider will provide for any language. + </documentation> + </annotation> + <complexType> + <attribute name="id" type="string" use="required"> + <annotation> + <documentation> + ID of the language for which this provider provides the entries. As an example, those are languages contributed by CDT (see extension org.eclipse.cdt.core.language): +<p>- "<samp>org.eclipse.cdt.core.gcc</samp>" for C,</p> +<p>- "<samp>org.eclipse.cdt.core.g++</samp>" for C++.</p> + </documentation> + </annotation> + </attribute> + </complexType> + </element> + <element name="entry"> + <annotation> + <documentation> + The Language Settings Entries used to provide additions to compiler options such as include paths (-I) or preprocessor defines (-D) and others into the project model. + </documentation> + </annotation> + <complexType> + <sequence> + <element ref="flag" minOccurs="0" maxOccurs="unbounded"/> + </sequence> + <attribute name="kind" use="required"> + <annotation> + <documentation> + Kind of language settings entry which maps to compiler options. For example, following mapping is used for gcc options: +<br>"<samp>-I</samp>" : includePath +<br>"<samp>-D</samp>" : macro +<br>"<samp>-include</samp>" : includeFile +<br>"<samp>-L</samp>" : libraryPath +<br>"<samp>-l</samp>" : libraryFile +<br>"<samp>-imacros</samp>" : macroFile + </documentation> + </annotation> + <simpleType> + <restriction base="string"> + <enumeration value="includePath"> + </enumeration> + <enumeration value="macro"> + </enumeration> + <enumeration value="includeFile"> + </enumeration> + <enumeration value="libraryPath"> + </enumeration> + <enumeration value="libraryFile"> + </enumeration> + <enumeration value="macroFile"> + </enumeration> + </restriction> + </simpleType> + </attribute> + <attribute name="name" type="string" use="required"> + <annotation> + <documentation> + "name" attribute maps to path for the entries representing a path to a folder or file and to name for <samp>macro</samp> kind representing name-value pair. For example: +<br>"<samp>/usr/include/</samp>" +<br>"<samp>MACRO</samp>" (for <samp>#define MACRO value</samp>) +<br>Note that relative paths are treated as rooted in build working directory (when applicable). + </documentation> + </annotation> + </attribute> + <attribute name="value" type="string"> + <annotation> + <documentation> + "value" attribute is used for <samp>macro</samp> kind representing name-value pair only. It is not used for the entries representing a path. For example: +<br>"<samp>value</samp>" (for <samp>#define MACRO value</samp>) + </documentation> + </annotation> + </attribute> + </complexType> + </element> + <element name="flag"> + <annotation> + <documentation> + Combination of flags for the entry. + </documentation> + </annotation> + <complexType> + <attribute name="value" use="required"> + <annotation> + <documentation> + A value of the flag. Corresponds to <samp>ICSettingEntry</samp> flags, see JavaDoc there for more details. Here is an excerpt from the Javadoc for the flags intended to be used with this extension point (the others might be not supported): + <br>- <samp>BUILTIN</samp> : Indicates settings built in a tool (compiler) itself. That kind of settings are not passed as options to a compiler but indexer or other clients might need them. + <br>- <samp>LOCAL</samp> : Applicable for <samp>includePath</samp> only which could be local (#include "...") or system (#include <...>). If an <samp>includePath</samp> is not marked as <samp>LOCAL</samp> it is treated as system. + <br>- <samp>RESOLVED</samp> : Indicates that the entries do not need to be resolved such as expansion of environment variables, normalizing the path against build working directory etc. + <br>- <samp>VALUE_WORKSPACE_PATH</samp> : is used to indicate that the entry is a resource managed by eclipse in the workspace. The path is rooted in the workspace root. + <br>- <samp>UNDEFINED</samp> : indicates that the entry should not be defined, corresponds to <samp>-U</samp> option of gcc compiler. If this flag is defined it will negate entries with the same name (and kind) for all providers down the list. + <br>- <samp>EXPORTED</samp> : indicates that the entry is exported to referencing projects. It will be passed to the projects configurations referencing the configuration the entry belongs to. + </documentation> + </annotation> + <simpleType> + <restriction base="string"> + <enumeration value="BUILTIN"> + </enumeration> + <enumeration value="LOCAL"> + </enumeration> + <enumeration value="RESOLVED"> + </enumeration> + <enumeration value="VALUE_WORKSPACE_PATH"> + </enumeration> + <enumeration value="UNDEFINED"> + </enumeration> + <enumeration value="EXPORTED"> + </enumeration> + </restriction> + </simpleType> + </attribute> + </complexType> + </element> + <annotation> + <appInfo> + <meta.section type="since"/> + </appInfo> + <documentation> + CDT 8.1 + </documentation> + </annotation> + <annotation> + <appInfo> + <meta.section type="apiinfo"/> + </appInfo> + <documentation> + Plug-ins that want to extend this extension point must implement <samp>org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider</samp> interface. +<br/> +For those cases where contributed settings entries (representing the compiler options) are not changed dynamically it is sufficient to configure existing class LanguageSettingsBaseProvider which is provided by default. +<br/> + </documentation> + </annotation> + <annotation> + <appInfo> + <meta.section type="copyright"/> + </appInfo> + <documentation> + Copyright (c) 2009, 2013 Andrew Gvozdev and others. +All rights reserved. This program and the accompanying materials +are made available under the terms of the Eclipse Public License v1.0 +which accompanies this distribution, and is available at +http://www.eclipse.org/legal/epl-v10.html + </documentation> + </annotation> +</schema> |