Semantic Highlighting

Identifier:
org.eclipse.cdt.ui.semanticHighligher

Since:
8.2

Description:
This extension point allows extensions to contribute to the semantic highlighting.

Extensions specify the priority of the highlighting, which determines the order in which the highlighting is invoked.

This extension point supports the enablement tag. Properties to test on are:

  • projectNatures: type Collection; all project natures of the current project
  • languageId: type String; the result if ILanguage.getId on the token's ITranslationUnit
  • Contributed highlightings will be visible in the Code tree of the 'C/C++ - Editor - Syntax Colouring' preference page.

    Configuration Markup:

    <!ELEMENT extension (semanticHighlighting+)>

    <!ATTLIST extension

    point CDATA #REQUIRED

    id    CDATA #IMPLIED

    name  CDATA #IMPLIED>


    <!ELEMENT semanticHighlighting (enablement?)>

    <!ATTLIST semanticHighlighting

    id                   IDREF #REQUIRED

    name                 CDATA #IMPLIED

    class                CDATA #REQUIRED

    priority             CDATA #REQUIRED

    preferenceKey        CDATA #REQUIRED

    displayName          CDATA #REQUIRED

    defaultTextColor     CDATA #IMPLIED

    defaultBold          (true | false)

    defaultItalic        (true | false)

    defaultStrikethrough (true | false)

    defaultUnderline     (true | false)

    defaultEnabled       (true | false) >


    Examples:
    The following is an example of a Semantic Highligher contribution:

    
    <extension
        point="org.eclipse.cdt.ui.semanticHighlighting"
        name="%extensionName"
        id="com.example.ui.semanticHighlightings">
        <semanticHighlighting
            id="com.example.ui.keywordHighlighting"
            priority="5"
            class="com.example.internal.ui.ExampleHighlighting"
            preferenceKey="example-keywords"
            displayName="%exampleHighlighting.displayName"
            defaultTextColor="127,0,85"
            defaultBold="true"
            defaultEnabled="true">
            <enablement>
                <with variable="projectNatures">
                    <iterate operator="or">
                        <equals value="org.eclipse.cdt.core.ccnature"/>
                    </iterate>
                </with>
                <with variable="languageId">
                 <or>
                  <equals value="org.eclipse.cdt.core.g++"/>
                  <equals value="org.eclipse.cdt.core.gcc"/>
                 </or>
                </with>
            </enablement>
        </semanticHighlighting>
    </extension>
    

    API Information:
    The contributed class must implement org.eclipse.cdt.ui.text.ISemanticHighlighter


    Copyright (c) 2013 QNX Software Systems 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