Difference between revisions of "PDT/Dev2Dev/Semantic"

Latest revision as of 05:50, 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:

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.

<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>

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";
  }
}

@HighlightingPriority(Priority.HIGH)
public class InternalClassHighlighting extends AbstractSemanticHighlighting {

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.

UI

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

Performances

Work in progress...