DartDocScanner.java example

Explorer
eclipse3-master
/*
 * Copyright (c) 2012, the Dart project authors.
 * 
 * Licensed under the Eclipse Public License v1.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 * 
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.dart.tools.ui.internal.text.dartdoc;

import com.google.dart.tools.ui.internal.text.functions.DartCommentScanner;
import com.google.dart.tools.ui.text.IColorManager;
import com.google.dart.tools.ui.text.IDartColorConstants;

import org.eclipse.core.runtime.Preferences;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.text.rules.IRule;
import org.eclipse.jface.text.rules.MultiLineRule;
import org.eclipse.jface.text.rules.SingleLineRule;
import org.eclipse.jface.text.rules.Token;

import java.util.List;

/**
 * A scanner to syntax highlight dartdoc text.
 */
@SuppressWarnings("deprecation")
public class DartDocScanner extends DartCommentScanner {

  private static String[] fgTokenProperties = {
      IDartColorConstants.JAVADOC_KEYWORD, IDartColorConstants.JAVADOC_TAG,
      IDartColorConstants.JAVADOC_LINK, IDartColorConstants.JAVADOC_DEFAULT, TASK_TAG};

  public DartDocScanner(IColorManager manager, IPreferenceStore store) {
    this(manager, store, null);
  }

  public DartDocScanner(IColorManager manager, IPreferenceStore store, Preferences coreStore) {
    super(manager, store, coreStore, IDartColorConstants.JAVADOC_DEFAULT, fgTokenProperties);
  }

  @Override
  protected List<IRule> createRules() {
    // available styles are: JAVADOC_KEYWORD, JAVADOC_TAG, TASK_TAG, 

    List<IRule> rules = super.createRules();

    Token codeToken = getToken(IDartColorConstants.JAVADOC_TAG);

    // in-line code
    // 4 spaces == a code indent, plus a 5th space for the [* ]
    rules.add(new SingleLineRule("     ", null, codeToken));

    // in-line code
    // TODO(devoncarew): handle the case where bracket-colons are nested?
    rules.add(new MultiLineRule("[:", ":]", codeToken));

    // identifier reference
    rules.add(new SingleLineRule("[", "]", codeToken));

    // TODO(devoncarew): possibily show headers in bold
    //rules.add(new SingleLineRule("# ", null, codeToken));

    return rules;
  }
}