Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "PDT/Dev2Dev/Semantic"

< PDT
(API)
(API)
Line 23: Line 23:
 
</source>  
 
</source>  
  
The given class must extend ''org.eclipse.php.internal.ui.editor.highlighter.AbstractSemanticHighlighting''.  
+
The given class must extend ''org.eclipse.php.internal.ui.editor.highlighter.AbstractSemanticHighlighting''. <source lang="java">
<source lang="java">
+
 
public class ParameterVariableHighlighting extends AbstractSemanticHighlighting {
 
public class ParameterVariableHighlighting extends AbstractSemanticHighlighting {
  
Line 47: Line 46:
 
@HighlightingPriority(Priority.HIGH)
 
@HighlightingPriority(Priority.HIGH)
 
public class InternalClassHighlighting extends AbstractSemanticHighlighting {
 
public class InternalClassHighlighting extends AbstractSemanticHighlighting {
</source>
+
</source>  
  
The AbstractSemanticApply is simple visitor of PHP AST model. Once a node to be colored is matched, it can be added to the semantic coloring using the ''highlight'' method.
+
The AbstractSemanticApply is simple visitor of PHP AST model. Once a node to be colored is matched, it can be added to the semantic coloring using the ''highlight'' method. <source lang="java">
<source lang="java">
+
 
protected class InterfaceApply extends AbstractSemanticApply {
 
protected class InterfaceApply extends AbstractSemanticApply {
  
Line 70: Line 68:
 
   }
 
   }
 
}
 
}
</source>
+
</source>
 +
 
 +
<br> The following table describes the semantic rules that have been implemented so far and their default style.
 +
 
 +
<br>
 +
 
 +
{| cellspacing="1" cellpadding="1" border="1" style="width: 622px; height: 338px;"
 +
|-
 +
| '''Rule<br>'''
 +
| '''Style<br>'''
 +
| '''Enabled by default'''<br>
 +
|-
 +
| Constants<br>
 +
| <br>
 +
| <br>
 +
|-
 +
| Field<br>
 +
| <br>
 +
| <br>
 +
|-
 +
| Function<br>
 +
| <br>
 +
| <br>
 +
|-
 +
| Internal Function<br>
 +
| <br>
 +
| <br>
 +
|-
 +
| Global Variable<br>
 +
| <br>
 +
| <br>
 +
|-
 +
| Local variable<br>
 +
| <br>
 +
| <br>
 +
|-
 +
| Method<br>
 +
| <br>
 +
| <br>
 +
|-
 +
| Static Field<br>
 +
| <br>
 +
| <br>
 +
|-
 +
| Static Method<br>
 +
| <br>
 +
| <br>
 +
|-
 +
| Classes<br>
 +
| <br>
 +
| <br>
 +
|-
 +
| Internal Classes<br>
 +
| <br>
 +
| <br>
 +
|-
 +
| Internal Interfaces<br>
 +
| <br>
 +
| <br>
 +
|-
 +
| Interfaces<br>
 +
| <br>
 +
| <br>
 +
|-
 +
| Parameter Variables<br>
 +
| <br>
 +
| <br>
 +
|-
 +
| Super Globales<br>
 +
| <br>
 +
| <br>
 +
|}
 +
 
 +
<br>
  
 
=== UI ===
 
=== UI ===

Revision as of 04:45, 26 August 2009

Semantic Highlighting

Overview

Following the improvements done by the Web tools project (232752) on semantic highlighting, the PHP Source Editor can now set semantic rules for better coloring techniques that will improve its performance and functionality. For example, currently, all variables are highlighted in the same color. Although members / static / constants variables should be colored in separate colors just like the Java editor does.

The following screenshot demonstrate the power of the semantic coloring:

Pdt semantic editor.png

The latest version of the patch is available at 271430.

API

The PHP semantic highlighting API is used to define semantic rules for PHP coloring. It's also useful for plugin developpers who would like to extends PHP highlighting with specific semantic rules.

The first step is to use the org.eclipse.wst.sse.ui.semanticHighlighting extension point with the org.eclipse.php.core.phpsource target. By using the PHP source target, PHP UI plugin is automatically registering this contributor as a semantic highlighter.
<extension point="org.eclipse.wst.sse.ui.semanticHighlighting">
  <highlighting
    class="org.eclipse.php.internal.ui.editor.highlighting.ParameterVariableHighlighting"
    target="org.eclipse.php.core.phpsource">
  </highlighting>
</extension>
The given class must extend org.eclipse.php.internal.ui.editor.highlighter.AbstractSemanticHighlighting.
public class ParameterVariableHighlighting extends AbstractSemanticHighlighting {
 
  @Override
  public AbstractSemanticApply getSemanticApply() {
    return new ParameterVariableApply();
  }
 
  @Override
  public void initDefaultPreferences() {
    getStyle().setUnderlineByDefault(true)
              .setDefaultTextColor(new RGB(102, 0, 0));
  }
 
  public String getDisplayName() {
    return "Local variables";
  }
}
Since some rules might be conflicting between each other, you can define the priority rules. For instance, the InternalClassHighlighting rule has to override the ClassHighlighting rule. You can use the @HighlightingPriority annotation to define the application order of the semantic rules.
@HighlightingPriority(Priority.HIGH)
public class InternalClassHighlighting extends AbstractSemanticHighlighting {
The AbstractSemanticApply is simple visitor of PHP AST model. Once a node to be colored is matched, it can be added to the semantic coloring using the highlight method.
protected class InterfaceApply extends AbstractSemanticApply {
 
  @Override
  public boolean visit(ClassDeclaration classDecl) {
    for (Identifier type: classDecl.interfaces()) {
      highlight(type);
    }
    return true;
  }
 
  @Override
  public boolean visit(InterfaceDeclaration interfaceDecl) {
    highlight(interfaceDecl.getName());
    for (Identifier type: classDecl.interfaces()) {
      highlight(type);
    }
    return true;
  }
}


The following table describes the semantic rules that have been implemented so far and their default style.


Rule
Style
Enabled by default
Constants


Field


Function


Internal Function


Global Variable


Local variable


Method


Static Field


Static Method


Classes


Internal Classes


Internal Interfaces


Interfaces


Parameter Variables


Super Globales



UI

The rules are automatically added to the Syntax Coloring preference page:

Pdt semantic preferences.png

Performances

Work in progress...

Back to the top