| /******************************************************************************* |
| * Copyright (c) 2004, 2009 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 |
| * Frits Jalvingh - contributions for bug 150794 |
| *******************************************************************************/ |
| package org.eclipse.jst.jsp.ui.internal.style.java; |
| |
| import java.util.Collection; |
| |
| import org.eclipse.jdt.ui.PreferenceConstants; |
| import org.eclipse.jface.preference.IPreferenceStore; |
| import org.eclipse.jface.preference.PreferenceConverter; |
| import org.eclipse.jface.text.ITypedRegion; |
| import org.eclipse.jface.text.TextAttribute; |
| import org.eclipse.jface.text.rules.IToken; |
| import org.eclipse.jface.text.rules.Token; |
| import org.eclipse.jface.util.PropertyChangeEvent; |
| import org.eclipse.jst.jsp.ui.internal.JSPUIPlugin; |
| import org.eclipse.jst.jsp.ui.internal.style.IStyleConstantsJSP; |
| import org.eclipse.swt.SWT; |
| import org.eclipse.swt.custom.StyleRange; |
| import org.eclipse.swt.graphics.Color; |
| import org.eclipse.swt.graphics.RGB; |
| import org.eclipse.wst.html.ui.internal.style.IStyleConstantsHTML; |
| import org.eclipse.wst.sse.core.internal.provisional.text.ITextRegion; |
| import org.eclipse.wst.sse.ui.internal.provisional.style.AbstractLineStyleProvider; |
| import org.eclipse.wst.sse.ui.internal.provisional.style.LineStyleProvider; |
| import org.eclipse.wst.xml.ui.internal.style.IStyleConstantsXML; |
| |
| // Note: many of the methods in this class were based on (or copied from) those |
| // found in the example Java Editor |
| public class LineStyleProviderForJava extends AbstractLineStyleProvider implements LineStyleProvider{ |
| |
| /** The scanner it uses */ |
| private JavaCodeScanner fScanner; |
| |
| public LineStyleProviderForJava() { |
| super(); |
| fScanner = new JavaCodeScanner(); |
| loadColors(); // Make sure we have rules before we start parsing |
| } |
| |
| /** |
| * Adds style information to the given text presentation. |
| * |
| * @param presentation the text presentation to be extended |
| * @param offset the offset of the range to be styled |
| * @param length the length of the range to be styled |
| * @param attr the attribute describing the style of the range to be styled |
| */ |
| private void addRange(Collection presentation, int offset, int length, TextAttribute attr) { |
| // support for user defined backgroud for JSP scriptlet regions |
| TextAttribute ta = (TextAttribute)getTextAttributes().get(IStyleConstantsJSP.JSP_CONTENT); |
| Color bgColor = ta.getBackground(); |
| if (bgColor == null) |
| bgColor = attr.getBackground(); |
| StyleRange result = new StyleRange(offset, length, attr.getForeground(), bgColor, attr.getStyle()); |
| if((attr.getStyle() & TextAttribute.STRIKETHROUGH) != 0) { |
| result.strikeout = true; |
| } |
| if((attr.getStyle() & TextAttribute.UNDERLINE) != 0) { |
| result.underline = true; |
| } |
| presentation.add(result); |
| } |
| |
| /** |
| * Looks up the colorKey in the preference store and adds the style |
| * information to list of TextAttributes |
| * |
| * @param colorKey |
| */ |
| private void addJavaTextAttribute(String colorKey) { |
| IPreferenceStore store = getJavaColorPreferences(); |
| if (store != null && colorKey != null) { |
| TextAttribute ta = null; |
| if (colorKey == IStyleConstantsJSPJava.JAVA_KEYWORD) { |
| // keyword |
| RGB foreground = PreferenceConverter.getColor(store, PreferenceConstants.EDITOR_JAVA_KEYWORD_COLOR); |
| boolean bold = store.getBoolean(PreferenceConstants.EDITOR_JAVA_KEYWORD_BOLD); |
| boolean italics = store.getBoolean(PreferenceConstants.EDITOR_JAVA_KEYWORD_ITALIC); |
| boolean strikethrough = store.getBoolean(PreferenceConstants.EDITOR_JAVA_KEYWORD_STRIKETHROUGH); |
| boolean underline = store.getBoolean(PreferenceConstants.EDITOR_JAVA_KEYWORD_UNDERLINE); |
| int style = SWT.NORMAL; |
| if (bold) { |
| style = style | SWT.BOLD; |
| } |
| if (italics) { |
| style = style | SWT.ITALIC; |
| } |
| if (strikethrough) { |
| style = style | TextAttribute.STRIKETHROUGH; |
| } |
| if (underline) { |
| style = style | TextAttribute.UNDERLINE; |
| } |
| |
| ta = createTextAttribute(foreground, null, style); |
| } else if (colorKey == IStyleConstantsJSPJava.JAVA_STRING) { |
| // string |
| RGB foreground = PreferenceConverter.getColor(store, PreferenceConstants.EDITOR_STRING_COLOR); |
| boolean bold = store.getBoolean(PreferenceConstants.EDITOR_STRING_BOLD); |
| boolean italics = store.getBoolean(PreferenceConstants.EDITOR_STRING_ITALIC); |
| boolean strikethrough = store.getBoolean(PreferenceConstants.EDITOR_STRING_STRIKETHROUGH); |
| boolean underline = store.getBoolean(PreferenceConstants.EDITOR_STRING_UNDERLINE); |
| int style = SWT.NORMAL; |
| if (bold) { |
| style = style | SWT.BOLD; |
| } |
| if (italics) { |
| style = style | SWT.ITALIC; |
| } |
| if (strikethrough) { |
| style = style | TextAttribute.STRIKETHROUGH; |
| } |
| if (underline) { |
| style = style | TextAttribute.UNDERLINE; |
| } |
| |
| ta = createTextAttribute(foreground, null, style); |
| } else if (colorKey == IStyleConstantsJSPJava.JAVA_SINGLE_LINE_COMMENT) { |
| // single line comment |
| RGB foreground = PreferenceConverter.getColor(store, PreferenceConstants.EDITOR_SINGLE_LINE_COMMENT_COLOR); |
| boolean bold = store.getBoolean(PreferenceConstants.EDITOR_SINGLE_LINE_COMMENT_BOLD); |
| boolean italics = store.getBoolean(PreferenceConstants.EDITOR_SINGLE_LINE_COMMENT_ITALIC); |
| boolean strikethrough = store.getBoolean(PreferenceConstants.EDITOR_SINGLE_LINE_COMMENT_STRIKETHROUGH); |
| boolean underline = store.getBoolean(PreferenceConstants.EDITOR_SINGLE_LINE_COMMENT_UNDERLINE); |
| int style = SWT.NORMAL; |
| if (bold) { |
| style = style | SWT.BOLD; |
| } |
| if (italics) { |
| style = style | SWT.ITALIC; |
| } |
| if (strikethrough) { |
| style = style | TextAttribute.STRIKETHROUGH; |
| } |
| if (underline) { |
| style = style | TextAttribute.UNDERLINE; |
| } |
| |
| ta = createTextAttribute(foreground, null, style); |
| } else if (colorKey == IStyleConstantsJSPJava.JAVA_DEFAULT) { |
| // default |
| RGB foreground = PreferenceConverter.getColor(store, PreferenceConstants.EDITOR_JAVA_DEFAULT_COLOR); |
| boolean bold = store.getBoolean(PreferenceConstants.EDITOR_JAVA_DEFAULT_BOLD); |
| boolean italics = store.getBoolean(PreferenceConstants.EDITOR_JAVA_DEFAULT_ITALIC); |
| boolean strikethrough = store.getBoolean(PreferenceConstants.EDITOR_JAVA_DEFAULT_STRIKETHROUGH); |
| boolean underline = store.getBoolean(PreferenceConstants.EDITOR_JAVA_DEFAULT_UNDERLINE); |
| int style = SWT.NORMAL; |
| if (bold) { |
| style = style | SWT.BOLD; |
| } |
| if (italics) { |
| style = style | SWT.ITALIC; |
| } |
| if (strikethrough) { |
| style = style | TextAttribute.STRIKETHROUGH; |
| } |
| if (underline) { |
| style = style | TextAttribute.UNDERLINE; |
| } |
| |
| ta = createTextAttribute(foreground, null, style); |
| } |
| if (ta != null) { |
| getTextAttributes().put(colorKey, ta); |
| fScanner.setTokenData(colorKey, ta); |
| } |
| } |
| } |
| |
| /** |
| * Returns a text attribute encoded in the given token. If the token's |
| * data is not <code>null</code> and a text attribute it is assumed that |
| * it is the encoded text attribute. It returns the default text attribute |
| * if there is no encoded text attribute found. |
| * |
| * @param token the token whose text attribute is to be determined |
| * @return the token's text attribute |
| */ |
| private TextAttribute getTokenTextAttribute(IToken token) { |
| TextAttribute ta = null; |
| |
| Object data = token.getData(); |
| if (data instanceof TextAttribute) |
| ta = (TextAttribute)data; |
| else { |
| ta = (TextAttribute)getTextAttributes().get(IStyleConstantsJSPJava.JAVA_DEFAULT); |
| } |
| return ta; |
| } |
| |
| protected void loadColors() { |
| addTextAttribute(IStyleConstantsHTML.SCRIPT_AREA_BORDER); |
| addTextAttribute(IStyleConstantsXML.TAG_ATTRIBUTE_NAME); |
| addTextAttribute(IStyleConstantsXML.TAG_ATTRIBUTE_VALUE); |
| addTextAttribute(IStyleConstantsJSP.JSP_CONTENT); |
| |
| addJavaTextAttribute(IStyleConstantsJSPJava.JAVA_KEYWORD); |
| addJavaTextAttribute(IStyleConstantsJSPJava.JAVA_STRING); |
| addJavaTextAttribute(IStyleConstantsJSPJava.JAVA_SINGLE_LINE_COMMENT); |
| addJavaTextAttribute(IStyleConstantsJSPJava.JAVA_DEFAULT); |
| |
| fScanner.initializeRules(); |
| } |
| |
| protected void handlePropertyChange(PropertyChangeEvent event) { |
| String styleKey = null; |
| String javaStyleKey = null; |
| |
| if (event != null) { |
| String prefKey = event.getProperty(); |
| // check if preference changed is a style preference |
| if (IStyleConstantsHTML.SCRIPT_AREA_BORDER.equals(prefKey)) { |
| styleKey = IStyleConstantsHTML.SCRIPT_AREA_BORDER; |
| } |
| else if (IStyleConstantsXML.TAG_ATTRIBUTE_NAME.equals(prefKey)) { |
| styleKey = IStyleConstantsXML.TAG_ATTRIBUTE_NAME; |
| } |
| else if (IStyleConstantsXML.TAG_ATTRIBUTE_VALUE.equals(prefKey)) { |
| styleKey = IStyleConstantsXML.TAG_ATTRIBUTE_VALUE; |
| } else if (IStyleConstantsJSP.JSP_CONTENT.equals(prefKey)) { |
| styleKey = IStyleConstantsJSP.JSP_CONTENT; |
| } else if (PreferenceConstants.EDITOR_JAVA_KEYWORD_COLOR.equals(prefKey) || (PreferenceConstants.EDITOR_JAVA_KEYWORD_BOLD.equals(prefKey))|| (PreferenceConstants.EDITOR_JAVA_KEYWORD_ITALIC.equals(prefKey))) { |
| javaStyleKey = IStyleConstantsJSPJava.JAVA_KEYWORD; |
| } else if (PreferenceConstants.EDITOR_STRING_COLOR.equals(prefKey) || (PreferenceConstants.EDITOR_STRING_BOLD.equals(prefKey))|| (PreferenceConstants.EDITOR_STRING_ITALIC.equals(prefKey))) { |
| javaStyleKey = IStyleConstantsJSPJava.JAVA_STRING; |
| } else if (PreferenceConstants.EDITOR_SINGLE_LINE_COMMENT_COLOR.equals(prefKey) || (PreferenceConstants.EDITOR_SINGLE_LINE_COMMENT_BOLD.equals(prefKey))|| (PreferenceConstants.EDITOR_SINGLE_LINE_COMMENT_ITALIC.equals(prefKey))) { |
| javaStyleKey = IStyleConstantsJSPJava.JAVA_SINGLE_LINE_COMMENT; |
| } else if (PreferenceConstants.EDITOR_JAVA_DEFAULT_COLOR.equals(prefKey) || (PreferenceConstants.EDITOR_JAVA_DEFAULT_BOLD.equals(prefKey))|| (PreferenceConstants.EDITOR_JAVA_DEFAULT_ITALIC.equals(prefKey))) { |
| javaStyleKey = IStyleConstantsJSPJava.JAVA_DEFAULT; |
| } |
| } |
| |
| if (styleKey != null) { |
| // overwrite style preference with new value |
| addTextAttribute(styleKey); |
| } |
| if (javaStyleKey != null) { |
| // overwrite style preference with new value |
| addJavaTextAttribute(javaStyleKey); |
| fScanner.initializeRules(); |
| } |
| if (styleKey != null || javaStyleKey != null) { |
| // force a full update of the text viewer |
| fRecHighlighter.refreshDisplay(); |
| } |
| } |
| |
| public boolean prepareRegions(ITypedRegion typedRegion, int ssssrequestedStart, int ssssrequestedLength, Collection holdResults) { |
| boolean result = true; |
| /* Initialize the text attributes. Also load the colors and initialize the rules of the scanner */ |
| getTextAttributes(); |
| try { |
| // ideally, eventually, we'll have a "virtualDocument" we can |
| // refer to, but for now ... we'll simple rescan the one region. |
| // use simple adjustment (since "sub-content" starts at 0 |
| int lastStart = typedRegion.getOffset(); |
| int length = 0; |
| IToken lastToken = Token.UNDEFINED; |
| fScanner.setRange(getDocument(), lastStart, typedRegion.getLength()); |
| while (true) { |
| IToken token = fScanner.nextToken(); |
| if (token.isEOF()) { |
| if (!lastToken.isUndefined() && length != 0) { |
| addRange(holdResults, lastStart, length, getTokenTextAttribute(lastToken)); |
| } |
| break; |
| } |
| if (token.isWhitespace()) { |
| length += fScanner.getTokenLength(); |
| continue; |
| } |
| if (lastToken.isUndefined()) { |
| lastToken = token; |
| length += fScanner.getTokenLength(); |
| continue; |
| } |
| if (token != lastToken) { |
| addRange(holdResults, lastStart, length, getTokenTextAttribute(lastToken)); |
| lastToken = token; |
| lastStart = fScanner.getTokenOffset(); |
| length = fScanner.getTokenLength(); |
| continue; |
| } |
| length += fScanner.getTokenLength(); |
| } |
| } catch (Exception e) { |
| // shouldn't happen, but we don't want it to stop other |
| // highlighting, if it does. |
| result = false; |
| } |
| return result; |
| } |
| |
| protected IPreferenceStore getColorPreferences() { |
| return JSPUIPlugin.getDefault().getPreferenceStore(); |
| } |
| |
| private IPreferenceStore getJavaColorPreferences() { |
| return PreferenceConstants.getPreferenceStore(); |
| } |
| |
| protected void registerPreferenceManager() { |
| getColorPreferences().addPropertyChangeListener(fPreferenceListener); |
| getJavaColorPreferences().addPropertyChangeListener(fPreferenceListener); |
| } |
| |
| protected void unRegisterPreferenceManager() { |
| getColorPreferences().removePropertyChangeListener(fPreferenceListener); |
| getJavaColorPreferences().removePropertyChangeListener(fPreferenceListener); |
| } |
| |
| protected TextAttribute getAttributeFor(ITextRegion region) { |
| return null; |
| } |
| } |