content: /*******************************************************************************
   * Copyright (c) 2000, 2008 IBM Corporation 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
   *
   * Contributors:
   *     IBM Corporation - initial API and implementation
   *     Michel Ishizuka <cqw10305@nifty.com> - Bug 113266 [syntax highlighting] javadoc tag names including period is not highlighting correctly
   *******************************************************************************/
  package org.eclipse.wst.jsdt.internal.ui.text;
  
  
  import java.util.ArrayList;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  import java.util.StringTokenizer;
  
  import org.eclipse.core.runtime.Assert;
  import org.eclipse.core.runtime.Preferences;
  import org.eclipse.jface.preference.IPreferenceStore;
  import org.eclipse.jface.text.rules.ICharacterScanner;
  import org.eclipse.jface.text.rules.IToken;
  import org.eclipse.jface.text.rules.IWordDetector;
  import org.eclipse.jface.text.rules.Token;
  import org.eclipse.jface.util.PropertyChangeEvent;
  import org.eclipse.wst.jsdt.core.JavaScriptCore;
  import org.eclipse.wst.jsdt.internal.ui.text.CombinedWordRule.WordMatcher;
  import org.eclipse.wst.jsdt.ui.text.IColorManager;
  import org.eclipse.wst.jsdt.ui.text.IJavaScriptColorConstants;
  
  /**
   * AbstractJavaCommentScanner.java
   */
  public class JavaCommentScanner extends AbstractJavaScanner{
  
  	private static class AtJavaIdentifierDetector implements IWordDetector {
  
  		public boolean isWordStart(char c) {
  			return c == '@' || Character.isJavaIdentifierStart(c);
  		}
  
  		public boolean isWordPart(char c) {
  			return c == '.' || Character.isJavaIdentifierPart(c);
  		}
  	}
  
  	private class TaskTagMatcher extends CombinedWordRule.WordMatcher {
  
  		private IToken fToken;
  		/**
  		 * Uppercase words
  		 * 
  		 */
  		private Map fUppercaseWords= new HashMap();
  		/**
  		 * <code>true</code> if task tag detection is case-sensitive.
  		 * 
  		 */
  		private boolean fCaseSensitive= true;
  		/**
  		 * Buffer for uppercase word
  		 * 
  		 */
  		private CombinedWordRule.CharacterBuffer fBuffer= new CombinedWordRule.CharacterBuffer(16);
  
  		public TaskTagMatcher(IToken token) {
  			fToken= token;
  		}
  
  		/*
  		 * @see org.eclipse.wst.jsdt.internal.ui.text.CombinedWordRule.WordMatcher#clearWords()
  		 * 
  		 */
  		public synchronized void clearWords() {
  			super.clearWords();
  			fUppercaseWords.clear();
  		}
  
  		public synchronized void addTaskTags(String value) {
  			String[] tasks= split(value, ","); //$NON-NLS-1$
  			for (int i= 0; i < tasks.length; i++) {
  				if (tasks[i].length() > 0) {
  					addWord(tasks[i], fToken);
  				}
  			}
  		}
  
  		private String[] split(String value, String delimiters) {
  			StringTokenizer tokenizer= new StringTokenizer(value, delimiters);
  			int size= tokenizer.countTokens();
  			String[] tokens= new String[size];
  			int i= 0;
  			while (i < size)
  				tokens[i++]= tokenizer.nextToken();
  			return tokens;
  		}
  
  		/*
  		 * @see org.eclipse.wst.jsdt.internal.ui.text.CombinedWordRule.WordMatcher#addWord(java.lang.String, org.eclipse.jface.text.rules.IToken)
  		 * 
  		 */
  		public synchronized void addWord(String word, IToken token) {
  			Assert.isNotNull(word);
  			Assert.isNotNull(token);
  
  			super.addWord(word, token);
  			fUppercaseWords.put(new CombinedWordRule.CharacterBuffer(word.toUpperCase()), token);
  		}
  
  		/*
  		 * @see org.eclipse.wst.jsdt.internal.ui.text.CombinedWordRule.WordMatcher#evaluate(org.eclipse.jface.text.rules.ICharacterScanner, org.eclipse.wst.jsdt.internal.ui.text.CombinedWordRule.CharacterBuffer)
  		 * 
  		 */
  		public synchronized IToken evaluate(ICharacterScanner scanner, CombinedWordRule.CharacterBuffer word) {
  			if (fCaseSensitive)
  				return super.evaluate(scanner, word);
  
  			fBuffer.clear();
  			for (int i= 0, n= word.length(); i < n; i++)
  				fBuffer.append(Character.toUpperCase(word.charAt(i)));
  
  			IToken token= (IToken) fUppercaseWords.get(fBuffer);
  			if (token != null)
  				return token;
  			return Token.UNDEFINED;
  		}
  
  		/**
  		 * Is task tag detection case-senstive?
  		 *
  		 * @return <code>true</code> iff task tag detection is case-sensitive
  		 * 
  		 */
  		public boolean isCaseSensitive() {
  			return fCaseSensitive;
  		}
  
  		/**
  		 * Enables/disables the case-sensitivity of the task tag detection.
  		 *
  		 * @param caseSensitive <code>true</code> iff case-sensitivity should be enabled
  		 * 
  		 */
  		public void setCaseSensitive(boolean caseSensitive) {
  			fCaseSensitive= caseSensitive;
  		}
  	}
  
  	private static final String COMPILER_TASK_TAGS= JavaScriptCore.COMPILER_TASK_TAGS;
  	protected static final String TASK_TAG= IJavaScriptColorConstants.TASK_TAG;
  	/**
  	 * Preference key of a string preference, specifying if task tag detection is case-sensitive.
  	 * 
  	 */
  	private static final String COMPILER_TASK_CASE_SENSITIVE= JavaScriptCore.COMPILER_TASK_CASE_SENSITIVE;
  	/**
  	 * Preference value of enabled preferences.
  	 * 
  	 */
  	private static final String ENABLED= JavaScriptCore.ENABLED;
  
  	private TaskTagMatcher fTaskTagMatcher;
  	private Preferences fCorePreferenceStore;
  	private String fDefaultTokenProperty;
  	private String[] fTokenProperties;
  
  	public JavaCommentScanner(IColorManager manager, IPreferenceStore store, Preferences coreStore, String defaultTokenProperty) {
  		this(manager, store, coreStore, defaultTokenProperty, new String[] { defaultTokenProperty, TASK_TAG });
  	}
  
  	public JavaCommentScanner(IColorManager manager, IPreferenceStore store, Preferences coreStore, String defaultTokenProperty, String[] tokenProperties) {
  		super(manager, store);
  
  		fCorePreferenceStore= coreStore;
  		fDefaultTokenProperty= defaultTokenProperty;
  		fTokenProperties= tokenProperties;
  
  		initialize();
  	}
  
  	/**
  	 * Initialize with the given arguments.
  	 *
  	 * @param manager Color manager
  	 * @param store Preference store
  	 * @param defaultTokenProperty Default token property
  	 *
  	 * 
  	 */
  	public JavaCommentScanner(IColorManager manager, IPreferenceStore store, String defaultTokenProperty) {
  		this(manager, store, null, defaultTokenProperty, new String[] { defaultTokenProperty, TASK_TAG });
  	}
  
  	/**
  	 * Initialize with the given arguments.
  	 *
  	 * @param manager Color manager
  	 * @param store Preference store
  	 * @param defaultTokenProperty Default token property
  	 * @param tokenProperties Token properties
  	 *
  	 * 
  	 */
  	public JavaCommentScanner(IColorManager manager, IPreferenceStore store, String defaultTokenProperty, String[] tokenProperties) {
  		this(manager, store, null, defaultTokenProperty, tokenProperties);
  	}
  
  	/*
  	 * @see AbstractJavaScanner#createRules()
  	 */
  	protected List createRules() {
  		List list= new ArrayList();
  		Token defaultToken= getToken(fDefaultTokenProperty);
  
  		List matchers= createMatchers();
  		if (matchers.size() > 0) {
  			CombinedWordRule combinedWordRule= new CombinedWordRule(new AtJavaIdentifierDetector(), defaultToken);
  			for (int i= 0, n= matchers.size(); i < n; i++)
  				combinedWordRule.addWordMatcher((WordMatcher) matchers.get(i));
  			list.add(combinedWordRule);
  		}
  
  		setDefaultReturnToken(defaultToken);
  
  		return list;
  	}
  
  	/**
  	 * Creates a list of word matchers.
  	 *
  	 * @return the list of word matchers
  	 */
  	protected List createMatchers() {
  		List list= new ArrayList();
  
  		// Add rule for Task Tags.
  		boolean isCaseSensitive= true;
  		String tasks= null;
  		if (getPreferenceStore().contains(COMPILER_TASK_TAGS)) {
  			tasks= getPreferenceStore().getString(COMPILER_TASK_TAGS);
  			isCaseSensitive= ENABLED.equals(getPreferenceStore().getString(COMPILER_TASK_CASE_SENSITIVE));
  		} else if (fCorePreferenceStore != null) {
  			tasks= fCorePreferenceStore.getString(COMPILER_TASK_TAGS);
  			isCaseSensitive= ENABLED.equals(fCorePreferenceStore.getString(COMPILER_TASK_CASE_SENSITIVE));
  		}
  		if (tasks != null) {
  			fTaskTagMatcher= new TaskTagMatcher(getToken(TASK_TAG));
  			fTaskTagMatcher.addTaskTags(tasks);
  			fTaskTagMatcher.setCaseSensitive(isCaseSensitive);
  			list.add(fTaskTagMatcher);
  		}
  
  		return list;
  	}
  
  	/*
  	 * @see org.eclipse.wst.jsdt.internal.ui.text.AbstractJavaScanner#affectsBehavior(org.eclipse.jface.util.PropertyChangeEvent)
  	 */
  	public boolean affectsBehavior(PropertyChangeEvent event) {
  		return event.getProperty().equals(COMPILER_TASK_TAGS) || event.getProperty().equals(COMPILER_TASK_CASE_SENSITIVE) || super.affectsBehavior(event);
  	}
  
  	/*
  	 * @see org.eclipse.wst.jsdt.internal.ui.text.AbstractJavaScanner#adaptToPreferenceChange(org.eclipse.jface.util.PropertyChangeEvent)
  	 */
  	public void adaptToPreferenceChange(PropertyChangeEvent event) {
  		if (fTaskTagMatcher != null && event.getProperty().equals(COMPILER_TASK_TAGS)) {
  			Object value= event.getNewValue();
  			if (value instanceof String) {
  				synchronized (fTaskTagMatcher) {
  					fTaskTagMatcher.clearWords();
  					fTaskTagMatcher.addTaskTags((String) value);
  				}
  			}
  		} else if (fTaskTagMatcher != null && event.getProperty().equals(COMPILER_TASK_CASE_SENSITIVE)) {
  			Object value= event.getNewValue();
  			if (value instanceof String)
  				fTaskTagMatcher.setCaseSensitive(ENABLED.equals(value));
  		} else if (super.affectsBehavior(event))
  			super.adaptToPreferenceChange(event);
  	}
  
  	/*
  	 * @see org.eclipse.wst.jsdt.internal.ui.text.AbstractJavaScanner#getTokenProperties()
  	 */
  	protected String[] getTokenProperties() {
  		return fTokenProperties;
  	}
  
  }
  
  