plugins/org.eclipse.mylyn.docs.intent.client.ui/src/org/eclipse/mylyn/docs/intent/client/ui/editor/scanner/IntentDescriptionUnitScanner.java

/*******************************************************************************
 * Copyright (c) 2010, 2011 Obeo.
 * 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
 * 
 * Contributors:
 *     Obeo - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.docs.intent.client.ui.editor.scanner;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import org.eclipse.jface.text.TextAttribute;
import org.eclipse.jface.text.rules.EndOfLineRule;
import org.eclipse.jface.text.rules.IRule;
import org.eclipse.jface.text.rules.IToken;
import org.eclipse.jface.text.rules.SingleLineRule;
import org.eclipse.jface.text.rules.Token;
import org.eclipse.jface.text.rules.WhitespaceRule;
import org.eclipse.jface.text.rules.WordRule;
import org.eclipse.mylyn.docs.intent.client.ui.editor.configuration.ColorManager;
import org.eclipse.mylyn.docs.intent.client.ui.editor.configuration.IntentColorConstants;
import org.eclipse.mylyn.docs.intent.client.ui.editor.configuration.IntentFontConstants;
import org.eclipse.mylyn.docs.intent.parser.IntentKeyWords;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Color;

/**
 * Scanner for detecting Description Units.
 * 
 * @author <a href="mailto:alex.lagarde@obeo.fr">Alex Lagarde</a>
 */
public class IntentDescriptionUnitScanner extends AbstractIntentScanner {

	public static final String[] KEYWORDS = new String[] {
			IntentKeyWords.INTENT_FCT_EXPLICIT_LABEL_DECLARATION,
			IntentKeyWords.INTENT_FCT_LAZY_LABEL_DECLARATION, IntentKeyWords.INTENT_FCT_REFERENCE,
	};

	/**
	 * IntentDescriptionUnitScanner constructor.
	 * 
	 * @param colorManager
	 *            the color manage to use
	 */
	public IntentDescriptionUnitScanner(ColorManager colorManager) {
		super(colorManager);
		Color backgroundColor = colorManager.getColor(IntentColorConstants.getDuBackground());

		Color defaultforeGroundColor = colorManager.getColor(IntentColorConstants.getDuDefaultForeground());
		IToken defaultToken = new Token(new TextAttribute(defaultforeGroundColor, null, SWT.NONE,
				IntentFontConstants.getDescriptionFont()));

		Color keyWordForeGroundColor = colorManager.getColor(IntentColorConstants.getDuKeywordForeground());
		IToken keyWordToken = new Token(new TextAttribute(keyWordForeGroundColor, backgroundColor, SWT.BOLD));

		Color stringforeGroundColor = colorManager.getColor(IntentColorConstants.getMuStringForeground());

		setDefaultReturnToken(defaultToken);
		List<IRule> rules = new ArrayList<IRule>();
		rules.addAll(computeCustomRules(defaultforeGroundColor));
		rules.add(computeKeyWordRule(defaultToken, keyWordToken));
		rules.addAll(computeStringRules(stringforeGroundColor));
		rules.add(new WhitespaceRule(new IntentWhiteSpaceDetector()));
		setRules(rules.toArray(new IRule[rules.size()]));
	}

	/**
	 * Create all the rules related to description unit keyWords.
	 * 
	 * @return a list containing all the rules related to modeling unit keyWords
	 */
	protected IRule computeKeyWordRule(IToken defaultToken, IToken keyWordToken) {
		WordRule keyWordsRule = new WordRule(new IntentWordDetector(), defaultToken);
		for (int i = 0; i < KEYWORDS.length; i++) {
			keyWordsRule.addWord(KEYWORDS[i], keyWordToken);
		}
		return keyWordsRule;
	}

	/**
	 * Create all the rules related to Strings (for example : "example" or 'example').
	 * 
	 * @return a list containing all the rules related to related to Strings
	 */
	private Collection<? extends IRule> computeStringRules(Color stringforeGroundColor) {
		IToken stringToken = new Token(new TextAttribute(stringforeGroundColor, null, SWT.ITALIC));
		List<IRule> rules = new ArrayList<IRule>();
		rules.add(new SingleLineRule("\"", "\"", stringToken, '\\'));
		return rules;
	}

	/**
	 * Create all the custom rules, currently related to Textile.
	 * 
	 * @return a list containing all the rules
	 */
	private Collection<? extends IRule> computeCustomRules(Color foreGroundColor) {
		List<IRule> rules = new ArrayList<IRule>();
		// Italic
		rules.add(new SingleLinePatternRule("_", "_", new Token(new TextAttribute(foreGroundColor, null,
				SWT.ITALIC))));
		rules.add(new SingleLinePatternRule("__", "__", new Token(new TextAttribute(foreGroundColor, null,
				SWT.ITALIC))));
		// Bold
		rules.add(new SingleLinePatternRule("*", "*", new Token(new TextAttribute(foreGroundColor, null,
				SWT.BOLD))));
		rules.add(new SingleLinePatternRule("**", "**", new Token(new TextAttribute(foreGroundColor, null,
				SWT.BOLD))));
		// Underline
		rules.add(new SingleLinePatternRule("+", "+", new Token(new TextAttribute(foreGroundColor, null,
				TextAttribute.UNDERLINE, IntentFontConstants.getDescriptionFont()))));
		rules.add(new SingleLinePatternRule("-", "-", new Token(new TextAttribute(foreGroundColor, null,
				TextAttribute.STRIKETHROUGH, IntentFontConstants.getDescriptionFont()))));
		// Lists
		Color listColor = colorManager.getColor(IntentColorConstants.getDUListForeground());
		rules.add(new EndOfLineRule("#", new Token(new TextAttribute(listColor, null, SWT.NONE)), '\\'));
		rules.add(new EndOfLineRule("*", new Token(new TextAttribute(listColor, null, SWT.NONE,
				IntentFontConstants.getDescriptionFont())), '\\'));
		// Other font decorations
		rules.add(new SingleLinePatternRule("^", "^", new Token(new TextAttribute(foreGroundColor, null,
				SWT.ITALIC))));
		rules.add(new SingleLinePatternRule("%", "%", new Token(new TextAttribute(foreGroundColor, null,
				SWT.ITALIC))));
		rules.add(new SingleLinePatternRule("??", "??", new Token(new TextAttribute(foreGroundColor, null,
				SWT.ITALIC))));
		rules.add(new SingleLinePatternRule("@", "@", new Token(new TextAttribute(colorManager
				.getColor(IntentColorConstants.getMuStringForeground()), null, SWT.NONE, IntentFontConstants
				.getModelingUnitFont()))));

		// Images
		rules.add(new SingleLinePatternRule("!", "!", new Token(new TextAttribute(foreGroundColor, null,
				SWT.NONE, IntentFontConstants.getModelingUnitFont()))));
		return rules;
	}

	/**
	 * {@inheritDoc}
	 * 
	 * @see org.eclipse.mylyn.docs.intent.client.ui.editor.scanner.AbstractIntentScanner#getConfiguredContentType()
	 */
	@Override
	public String getConfiguredContentType() {
		return IntentPartitionScanner.INTENT_DESCRIPTIONUNIT;
	}
}