brackets
CEditorPreferencePage_closeBraces={B&races}
CEditorPreferencePage_wrapStrings=&Wrap automatically
CEditorPreferencePage_escapeStrings=Escape text w&hen pasting into a string literal
+CEditorPreferencePage_GeneralAppearanceGroupTitle=General appearance
+CEditorPreferencePage_SelectDocToolDescription=Select the documentation tool to be used to determine editor behaviors when no project preference overrides exist
CEditorPreferencePage_smartPaste=Adjust &indentation
CEditorPreferencePage_typing_smartTab= &Tab key indents the current line
+CEditorPreferencePage_WorkspaceDefaultLabel=Workspace default:
# Code Formatting
CodeFormatterPreferencePage_title=Code Style
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/preferences/formatter/CPreview.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/preferences/formatter/CPreview.java
index ba00559ef60..ce41d04a76b 100644
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/preferences/formatter/CPreview.java
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/preferences/formatter/CPreview.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2006 IBM Corporation and others.
+ * 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
@@ -9,6 +9,7 @@
* IBM Corporation - initial API and implementation
* Sergey Prigogin, Google
* Anton Leherbauer (Wind River Systems)
+ * Andrew Ferguson (Symbian)
*******************************************************************************/
package org.eclipse.cdt.internal.ui.preferences.formatter;
@@ -110,7 +111,7 @@ public abstract class CPreview {
CTextTools tools= CUIPlugin.getDefault().getTextTools();
fPreviewDocument= new Document();
fWorkingValues= workingValues;
- tools.setupCDocumentPartitioner( fPreviewDocument, ICPartitions.C_PARTITIONING);
+ tools.setupCDocumentPartitioner(fPreviewDocument, ICPartitions.C_PARTITIONING, null);
PreferenceStore prioritizedSettings= new PreferenceStore();
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/AbstractCScanner.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/AbstractCScanner.java
index cf8795db61b..31c9aaab485 100644
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/AbstractCScanner.java
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/AbstractCScanner.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2006 IBM Corporation and others.
+ * 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
@@ -8,358 +8,96 @@
* Contributors:
* IBM Corporation - initial API and implementation
* QNX Software System
+ * Andrew Ferguson (Symbian)
*******************************************************************************/
package org.eclipse.cdt.internal.ui.text;
-
-import java.util.HashMap;
+import java.util.ArrayList;
+import java.util.Iterator;
import java.util.List;
-import java.util.Map;
import org.eclipse.jface.preference.IPreferenceStore;
-import org.eclipse.jface.preference.PreferenceConverter;
-import org.eclipse.jface.resource.StringConverter;
-import org.eclipse.jface.text.TextAttribute;
import org.eclipse.jface.text.rules.BufferedRuleBasedScanner;
import org.eclipse.jface.text.rules.IRule;
import org.eclipse.jface.text.rules.IToken;
-import org.eclipse.jface.text.rules.Token;
import org.eclipse.jface.util.PropertyChangeEvent;
-import org.eclipse.swt.SWT;
-import org.eclipse.swt.graphics.Color;
-import org.eclipse.swt.graphics.RGB;
-import org.eclipse.swt.widgets.Display;
-
-import org.eclipse.cdt.ui.PreferenceConstants;
+import org.eclipse.cdt.ui.IPropertyChangeParticipant;
+import org.eclipse.cdt.ui.text.ICTokenScanner;
+import org.eclipse.cdt.ui.text.ITokenStore;
/**
- * Initialized with a color manager and a preference store, its subclasses are
- * only responsible for providing a list of preference keys for based on which tokens
- * are generated and to use this tokens to define the rules controlling this scanner.
- *
- * This scanner stores the color defined by the color preference key into
- * the color manager under the same key.
- *
- *
- * Preference color key + {@link PreferenceConstants#EDITOR_BOLD_SUFFIX} are used
- * to retrieve whether the token is rendered in bold.
- *
- *
- * Preference color key + {@link PreferenceConstants#EDITOR_ITALIC_SUFFIX} are used
- * to retrieve whether the token is rendered in italic.
- *
- *
- * Preference color key + {@link PreferenceConstants#EDITOR_STRIKETHROUGH_SUFFIX} are used
- * to retrieve whether the token is rendered in strikethrough.
- *
- *
- * Preference color key + {@link PreferenceConstants#EDITOR_UNDERLINE_SUFFIX} are used
- * to retrieve whether the token is rendered in underline.
- *
+ * Convenience implementation.
*/
-public abstract class AbstractCScanner extends BufferedRuleBasedScanner {
-
-
- private IColorManager fColorManager;
- private IPreferenceStore fPreferenceStore;
-
- private Map fTokenMap= new HashMap();
- private String[] fPropertyNamesColor;
- /**
- * Preference keys for boolean preferences which are true,
- * iff the corresponding token should be rendered bold.
- */
- private String[] fPropertyNamesBold;
- /**
- * Preference keys for boolean preferences which are true,
- * iff the corresponding token should be rendered italic.
- *
- * @since 4.0
- */
- private String[] fPropertyNamesItalic;
- /**
- * Preference keys for boolean preferences which are true,
- * iff the corresponding token should be rendered strikethrough.
- *
- * @since 4.0
- */
- private String[] fPropertyNamesStrikethrough;
- /**
- * Preference keys for boolean preferences which are true,
- * iff the corresponding token should be rendered underline.
- *
- * @since 4.0
- */
- private String[] fPropertyNamesUnderline;
-
-
- private boolean fNeedsLazyColorLoading;
-
- /**
- * Returns an array of preference keys which define the tokens
- * used in the rules of this scanner.
- *
- * The preference key is used access the color in the preference
- * store and in the color manager.
- *
- *
- * Preference key + {@link PreferenceConstants#EDITOR_BOLD_SUFFIX} is used
- * to retrieve whether the token is rendered in bold.
- *
- *
- * Preference key + {@link PreferenceConstants#EDITOR_ITALIC_SUFFIX} is used
- * to retrieve whether the token is rendered in italic.
- *
- *
- * Preference key + {@link PreferenceConstants#EDITOR_UNDERLINE_SUFFIX} is used
- * to retrieve whether the token is rendered underlined.
- *
- *
- * Preference key + {@link PreferenceConstants#EDITOR_STRIKETHROUGH_SUFFIX} is used
- * to retrieve whether the token is rendered stricken out.
- *
- */
- abstract protected String[] getTokenProperties();
-
- /**
- * Creates the list of rules controlling this scanner.
- */
- abstract protected List createRules();
-
-
- /**
- * Creates an abstract C scanner.
- */
- public AbstractCScanner(IColorManager manager, IPreferenceStore store) {
- super();
- fColorManager= manager;
- fPreferenceStore= store;
- }
-
- /**
- * Creates an abstract C scanner.
- */
- public AbstractCScanner(IColorManager manager, IPreferenceStore store, int bufsize) {
- super(bufsize);
- fColorManager= manager;
- fPreferenceStore= store;
- }
-
- /**
- * Must be called after the constructor has been called.
- */
- public final void initialize() {
-
- fPropertyNamesColor= getTokenProperties();
- int length= fPropertyNamesColor.length;
- fPropertyNamesBold= new String[length];
- fPropertyNamesItalic= new String[length];
- fPropertyNamesStrikethrough= new String[length];
- fPropertyNamesUnderline= new String[length];
-
- for (int i= 0; i < length; i++) {
- fPropertyNamesBold[i]= getBoldKey(fPropertyNamesColor[i]);
- fPropertyNamesItalic[i]= getItalicKey(fPropertyNamesColor[i]);
- fPropertyNamesStrikethrough[i]= getStrikethroughKey(fPropertyNamesColor[i]);
- fPropertyNamesUnderline[i]= getUnderlineKey(fPropertyNamesColor[i]);
- }
-
- fNeedsLazyColorLoading= Display.getCurrent() == null;
- for (int i= 0; i < length; i++) {
- if (fNeedsLazyColorLoading)
- addTokenWithProxyAttribute(fPropertyNamesColor[i], fPropertyNamesBold[i], fPropertyNamesItalic[i], fPropertyNamesStrikethrough[i], fPropertyNamesUnderline[i]);
- else
- addToken(fPropertyNamesColor[i], fPropertyNamesBold[i], fPropertyNamesItalic[i], fPropertyNamesStrikethrough[i], fPropertyNamesUnderline[i]);
- }
-
- initializeRules();
+public abstract class AbstractCScanner extends BufferedRuleBasedScanner implements ICTokenScanner {
+ private List pcps;
+ final protected ITokenStore fTokenStore;
+
+ public AbstractCScanner(ITokenStore tokenStore, int size) {
+ this(tokenStore);
+ setBufferSize(size);
}
- protected String getBoldKey(String colorKey) {
- return colorKey + PreferenceConstants.EDITOR_BOLD_SUFFIX;
- }
-
- protected String getItalicKey(String colorKey) {
- return colorKey + PreferenceConstants.EDITOR_ITALIC_SUFFIX;
+ public AbstractCScanner(ITokenStore tokenStore) {
+ fTokenStore= tokenStore;
+ pcps= new ArrayList();
}
- protected String getStrikethroughKey(String colorKey) {
- return colorKey + PreferenceConstants.EDITOR_STRIKETHROUGH_SUFFIX;
+ protected void addPropertyChangeParticipant(IPropertyChangeParticipant participant) {
+ pcps.add(participant);
}
- protected String getUnderlineKey(String colorKey) {
- return colorKey + PreferenceConstants.EDITOR_UNDERLINE_SUFFIX;
- }
-
- public IToken nextToken() {
- if (fNeedsLazyColorLoading)
- resolveProxyAttributes();
- return super.nextToken();
- }
-
- private void resolveProxyAttributes() {
- if (fNeedsLazyColorLoading && Display.getCurrent() != null) {
- for (int i= 0; i < fPropertyNamesColor.length; i++) {
- addToken(fPropertyNamesColor[i], fPropertyNamesBold[i], fPropertyNamesItalic[i], fPropertyNamesStrikethrough[i], fPropertyNamesUnderline[i]);
- }
- fNeedsLazyColorLoading= false;
- }
- }
-
- private void addTokenWithProxyAttribute(String colorKey, String boldKey, String italicKey, String strikethroughKey, String underlineKey) {
- fTokenMap.put(colorKey, new Token(createTextAttribute(null, boldKey, italicKey, strikethroughKey, underlineKey)));
- }
-
- private void addToken(String colorKey, String boldKey, String italicKey, String strikethroughKey, String underlineKey) {
- if (fColorManager != null && colorKey != null && fColorManager.getColor(colorKey) == null) {
- RGB rgb= PreferenceConverter.getColor(fPreferenceStore, colorKey);
- if (fColorManager instanceof IColorManagerExtension) {
- IColorManagerExtension ext= (IColorManagerExtension) fColorManager;
- ext.unbindColor(colorKey);
- ext.bindColor(colorKey, rgb);
- }
- }
-
- if (!fNeedsLazyColorLoading)
- fTokenMap.put(colorKey, new Token(createTextAttribute(colorKey, boldKey, italicKey, strikethroughKey, underlineKey)));
- else {
- Token token= ((Token)fTokenMap.get(colorKey));
- if (token != null)
- token.setData(createTextAttribute(colorKey, boldKey, italicKey, strikethroughKey, underlineKey));
- }
- }
-
/**
- * Create a text attribute based on the given color, bold, italic, strikethrough and underline preference keys.
- *
- * @param colorKey the color preference key
- * @param boldKey the bold preference key
- * @param italicKey the italic preference key
- * @param strikethroughKey the strikethrough preference key
- * @param underlineKey the italic preference key
- * @return the created text attribute
- * @since 3.0
+ * Convenience method for setting the scanner rules with a list rather
+ * than an array.
+ * @param rules
*/
- private TextAttribute createTextAttribute(String colorKey, String boldKey, String italicKey, String strikethroughKey, String underlineKey) {
- Color color= null;
- if (colorKey != null)
- color= fColorManager.getColor(colorKey);
-
- int style= fPreferenceStore.getBoolean(boldKey) ? SWT.BOLD : SWT.NORMAL;
- if (fPreferenceStore.getBoolean(italicKey))
- style |= SWT.ITALIC;
-
- if (fPreferenceStore.getBoolean(strikethroughKey))
- style |= TextAttribute.STRIKETHROUGH;
-
- if (fPreferenceStore.getBoolean(underlineKey))
- style |= TextAttribute.UNDERLINE;
-
- return new TextAttribute(color, null, style);
- }
-
- protected Token getToken(String key) {
- if (fNeedsLazyColorLoading)
- resolveProxyAttributes();
- return (Token) fTokenMap.get(key);
- }
-
- private void initializeRules() {
- List rules= createRules();
- if (rules != null) {
+ public final void setRules(List rules) {
+ if(rules==null) {
+ setRules((IRule[])null);
+ } else {
IRule[] result= new IRule[rules.size()];
rules.toArray(result);
- setRules(result);
+ setRules(result);
}
}
- private int indexOf(String property) {
- if (property != null) {
- int length= fPropertyNamesColor.length;
- for (int i= 0; i < length; i++) {
- if (property.equals(fPropertyNamesColor[i]) || property.equals(fPropertyNamesBold[i]) || property.equals(fPropertyNamesItalic[i]) || property.equals(fPropertyNamesStrikethrough[i]) || property.equals(fPropertyNamesUnderline[i]))
- return i;
- }
- }
- return -1;
- }
-
- public boolean affectsBehavior(PropertyChangeEvent event) {
- return indexOf(event.getProperty()) >= 0;
- }
-
- public void adaptToPreferenceChange(PropertyChangeEvent event) {
- String p= event.getProperty();
- int index= indexOf(p);
- Token token= getToken(fPropertyNamesColor[index]);
- if (fPropertyNamesColor[index].equals(p))
- adaptToColorChange(token, event);
- else if (fPropertyNamesBold[index].equals(p))
- adaptToStyleChange(token, event, SWT.BOLD);
- else if (fPropertyNamesItalic[index].equals(p))
- adaptToStyleChange(token, event, SWT.ITALIC);
- else if (fPropertyNamesStrikethrough[index].equals(p))
- adaptToStyleChange(token, event, TextAttribute.STRIKETHROUGH);
- else if (fPropertyNamesUnderline[index].equals(p))
- adaptToStyleChange(token, event, TextAttribute.UNDERLINE);
- }
-
- private void adaptToColorChange(Token token, PropertyChangeEvent event) {
- RGB rgb= null;
-
- Object value= event.getNewValue();
- if (value instanceof RGB)
- rgb= (RGB) value;
- else if (value instanceof String)
- rgb= StringConverter.asRGB((String) value);
-
- if (rgb != null) {
-
- String property= event.getProperty();
- Color color= fColorManager.getColor(property);
-
- if ((color == null || !rgb.equals(color.getRGB())) && fColorManager instanceof IColorManagerExtension) {
- IColorManagerExtension ext= (IColorManagerExtension) fColorManager;
-
- ext.unbindColor(property);
- ext.bindColor(property, rgb);
-
- color= fColorManager.getColor(property);
- }
-
- Object data= token.getData();
- if (data instanceof TextAttribute) {
- TextAttribute oldAttr= (TextAttribute) data;
- token.setData(new TextAttribute(color, oldAttr.getBackground(), oldAttr.getStyle()));
- }
- }
- }
-
- private void adaptToStyleChange(Token token, PropertyChangeEvent event, int styleAttribute) {
- boolean eventValue= false;
- Object value= event.getNewValue();
- if (value instanceof Boolean)
- eventValue= ((Boolean) value).booleanValue();
- else if (IPreferenceStore.TRUE.equals(value))
- eventValue= true;
-
- Object data= token.getData();
- if (data instanceof TextAttribute) {
- TextAttribute oldAttr= (TextAttribute) data;
- boolean activeValue= (oldAttr.getStyle() & styleAttribute) == styleAttribute;
- if (activeValue != eventValue)
- token.setData(new TextAttribute(oldAttr.getForeground(), oldAttr.getBackground(), eventValue ? oldAttr.getStyle() | styleAttribute : oldAttr.getStyle() & ~styleAttribute));
- }
- }
- /**
- * Returns the preference store.
- *
- * @return the preference store.
- *
- * @since 3.0
+ /*
+ * @see org.eclipse.jface.text.rules.RuleBasedScanner#nextToken()
*/
- protected IPreferenceStore getPreferenceStore() {
- return fPreferenceStore;
+ public IToken nextToken() {
+ fTokenStore.ensureTokensInitialised();
+ return super.nextToken();
}
-}
+
+ public IToken getToken(String key) {
+ return fTokenStore.getToken(key);
+ }
+
+ public IPreferenceStore getPreferenceStore() {
+ return fTokenStore.getPreferenceStore();
+ }
+
+ /*
+ * @see org.eclipse.cdt.ui.IPropertyChangeParticipant#adaptToPreferenceChange(org.eclipse.jface.util.PropertyChangeEvent)
+ */
+ public void adaptToPreferenceChange(PropertyChangeEvent event) {
+ if(fTokenStore.affectsBehavior(event)) {
+ fTokenStore.adaptToPreferenceChange(event);
+ }
+ for(Iterator i= pcps.iterator(); i.hasNext(); ) {
+ ((IPropertyChangeParticipant)i.next()).adaptToPreferenceChange(event);
+ }
+ }
+
+ /*
+ * @see org.eclipse.cdt.ui.IPropertyChangeParticipant#affectsBehavior(org.eclipse.jface.util.PropertyChangeEvent)
+ */
+ public boolean affectsBehavior(PropertyChangeEvent event) {
+ boolean result= fTokenStore.affectsBehavior(event);
+ for(Iterator i= pcps.iterator(); !result && i.hasNext(); ) {
+ result |= ((IPropertyChangeParticipant)i.next()).affectsBehavior(event);
+ }
+ return result;
+ }
+}
\ No newline at end of file
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CAutoIndentStrategy.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CAutoIndentStrategy.java
index aa60713d07c..208825fb6d4 100644
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CAutoIndentStrategy.java
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CAutoIndentStrategy.java
@@ -9,7 +9,8 @@
* IBM Corporation - initial API and implementation
* QNX Software System
* Anton Leherbauer (Wind River Systems)
- * Sergey Prigogin, Google
+ * Sergey Prigogin (Google)
+ * Andrew Ferguson (Symbian)
*******************************************************************************/
package org.eclipse.cdt.internal.ui.text;
@@ -44,7 +45,6 @@ import org.eclipse.cdt.internal.ui.editor.IndentUtil;
* Auto indent strategy sensitive to brackets.
*/
public class CAutoIndentStrategy extends DefaultIndentLineAutoEditStrategy {
- private static final String MULTILINE_COMMENT_CLOSE = "*/"; //$NON-NLS-1$
/** The line comment introducer. Value is "{@value}" */
private static final String LINE_COMMENT= "//"; //$NON-NLS-1$
// private static final GCCScannerExtensionConfiguration C_GNU_SCANNER_EXTENSION = new GCCScannerExtensionConfiguration();
@@ -1120,43 +1120,20 @@ public class CAutoIndentStrategy extends DefaultIndentLineAutoEditStrategy {
super.customizeDocumentCommand(d, c);
return;
}
-
- if (c.length == 0 && c.text != null && isLineDelimiter(d, c.text)) {
- if (isAppendToOpenMultilineComment(d, c)) {
- // special case: multi-line comment at end of document (bug 48339)
- CCommentAutoIndentStrategy.commentIndentAfterNewLine(d, c);
- } else {
- smartIndentAfterNewLine(d, c);
- }
- } else if ("/".equals(c.text) && isAppendToOpenMultilineComment(d, c)) { //$NON-NLS-1$
- // special case: multi-line comment at end of document (bug 48339)
- CCommentAutoIndentStrategy.commentIndentForCommentEnd(d, c);
+
+ /*
+ * I removed the workaround for 48339 as I believe the recent changes to
+ * FastCPartitioner are enough to fix this.
+ */
+ boolean isNewLine= c.length == 0 && c.text != null && isLineDelimiter(d, c.text);
+ if (isNewLine) {
+ smartIndentAfterNewLine(d, c);
} else if (c.text.length() == 1) {
smartIndentOnKeypress(d, c);
} else if (c.text.length() > 1 && getPreferenceStore().getBoolean(PreferenceConstants.EDITOR_SMART_PASTE)) {
smartPaste(d, c); // no smart backspace for paste
}
}
-
- /**
- * Check, if the command appends to an open multi-line comment.
- * @param d the document
- * @param c the document command
- * @return true, if the command appends to an open multi-line comment.
- */
- private boolean isAppendToOpenMultilineComment(IDocument d, DocumentCommand c) {
- if (d.getLength() >= 2 && c.offset == d.getLength()) {
- try {
- String contentType = TextUtilities.getContentType(d, fPartitioning, c.offset - 1, false);
- if (ICPartitions.C_MULTI_LINE_COMMENT.equals(contentType)) {
- return !d.get(c.offset - 2, 2).equals(MULTILINE_COMMENT_CLOSE);
- }
- } catch (BadLocationException exc) {
- // see below
- }
- }
- return false;
- }
private static IPreferenceStore getPreferenceStore() {
return CUIPlugin.getDefault().getCombinedPreferenceStore();
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CCodeScanner.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CCodeScanner.java
index 4820b3627e3..5354ebf1932 100644
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CCodeScanner.java
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CCodeScanner.java
@@ -9,19 +9,20 @@
* IBM Corporation - initial API and implementation
* QNX Software System
* Anton Leherbauer (Wind River Systems)
+ * Andrew Ferguson (Symbian)
*******************************************************************************/
package org.eclipse.cdt.internal.ui.text;
import java.util.ArrayList;
import java.util.List;
-import org.eclipse.jface.preference.IPreferenceStore;
-import org.eclipse.jface.text.rules.Token;
+import org.eclipse.jface.text.rules.IRule;
+import org.eclipse.jface.text.rules.IToken;
import org.eclipse.jface.text.rules.WhitespaceRule;
import org.eclipse.jface.text.rules.WordRule;
-import org.eclipse.jface.util.PropertyChangeEvent;
import org.eclipse.cdt.core.model.ICLanguageKeywords;
+import org.eclipse.cdt.ui.text.ITokenStoreFactory;
import org.eclipse.cdt.internal.ui.text.util.CWhitespaceDetector;
import org.eclipse.cdt.internal.ui.text.util.CWordDetector;
@@ -45,31 +46,22 @@ public final class CCodeScanner extends AbstractCScanner {
/**
* Creates a C/C++ code scanner.
- *
- * @param manager the color manager
- * @param store the reference store
+ * @param factory
* @param keywords the keywords defined by the language dialect
*/
- public CCodeScanner(IColorManager manager, IPreferenceStore store, ICLanguageKeywords keywords) {
- super(manager, store);
+ public CCodeScanner(ITokenStoreFactory factory, ICLanguageKeywords keywords) {
+ super(factory.createTokenStore(fgTokenProperties));
fKeywords= keywords;
- initialize();
+ setRules(createRules());
}
-
- /*
- * @see AbstractCScanner#getTokenProperties()
- */
- protected String[] getTokenProperties() {
- return fgTokenProperties;
- }
-
+
/*
* @see AbstractCScanner#createRules()
*/
- protected List createRules() {
+ protected List createRules() {
- List rules= new ArrayList();
- Token token;
+ List rules= new ArrayList();
+ IToken token;
// Add generic white space rule.
rules.add(new WhitespaceRule(new CWhitespaceDetector()));
@@ -105,13 +97,4 @@ public final class CCodeScanner extends AbstractCScanner {
setDefaultReturnToken(getToken(ICColorConstants.C_DEFAULT));
return rules;
}
-
- /*
- * @see AbstractCScanner#adaptToPreferenceChange(PropertyChangeEvent)
- */
- public void adaptToPreferenceChange(PropertyChangeEvent event) {
- if (super.affectsBehavior(event)) {
- super.adaptToPreferenceChange(event);
- }
- }
}
\ No newline at end of file
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CCommentAutoIndentStrategy.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CCommentAutoIndentStrategy.java
deleted file mode 100644
index ef5a2b4166a..00000000000
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CCommentAutoIndentStrategy.java
+++ /dev/null
@@ -1,122 +0,0 @@
-/*******************************************************************************
- * Copyright (c) 2000, 2006 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
- * QNX Software System
- * Anton Leherbauer (Wind River Systems) - Fixed bug 48339
- *******************************************************************************/
-package org.eclipse.cdt.internal.ui.text;
-
-import org.eclipse.jface.text.BadLocationException;
-import org.eclipse.jface.text.DefaultIndentLineAutoEditStrategy;
-import org.eclipse.jface.text.DocumentCommand;
-import org.eclipse.jface.text.IDocument;
-import org.eclipse.jface.text.IRegion;
-
-/**
- * Auto indent strategy for C/C++ multiline comments
- */
-public class CCommentAutoIndentStrategy extends DefaultIndentLineAutoEditStrategy {
-
- public CCommentAutoIndentStrategy() {
- }
-
- /**
- * Returns whether the text ends with one of the given search strings.
- */
- private boolean endsWithDelimiter(IDocument d, String txt) {
- String[] delimiters= d.getLegalLineDelimiters();
-
- for (int i= 0; i < delimiters.length; i++) {
- if (txt.endsWith(delimiters[i]))
- return true;
- }
-
- return false;
- }
-
- /**
- * Copies the indentation of the previous line and adds a star.
- * If the comment just started on this line adds also a blank.
- *
- * @param d the document to work on
- * @param c the command to deal with
- */
- static void commentIndentAfterNewLine(IDocument d, DocumentCommand c) {
-
- if (c.offset == -1 || d.getLength() == 0)
- return;
-
- try {
- // find start of line
- IRegion info= d.getLineInformationOfOffset(c.offset);
- int start= info.getOffset();
-
- // find white spaces
- int end= findEndOfWhiteSpaceAt(d, start, c.offset);
-
- StringBuffer buf= new StringBuffer(c.text);
- if (end >= start) { // 1GEYL1R: ITPJUI:ALL - java doc edit smartness not work for class comments
- // append to input
- buf.append(d.get(start, end - start));
- if (end < c.offset) {
- if (d.getChar(end) == '/') {
- // comment started on this line
- buf.append(" * "); //$NON-NLS-1$
- } else if (d.getChar(end) == '*') {
- buf.append("* "); //$NON-NLS-1$
- }
- }
- }
-
-
- c.text= buf.toString();
-
- } catch (BadLocationException excp) {
- // stop work
- }
- }
-
- static int findEndOfWhiteSpaceAt(IDocument document, int offset, int end) throws BadLocationException {
- while (offset < end) {
- char c= document.getChar(offset);
- if (c != ' ' && c != '\t') {
- return offset;
- }
- offset++;
- }
- return end;
- }
-
- static void commentIndentForCommentEnd(IDocument d, DocumentCommand c) {
- if (c.offset < 2 || d.getLength() == 0) {
- return;
- }
- try {
- if ("* ".equals(d.get(c.offset - 2, 2))) { //$NON-NLS-1$
- // modify document command
- c.length++;
- c.offset--;
- }
- } catch (BadLocationException excp) {
- // stop work
- }
- }
-
- /*
- * @see IAutoIndentStrategy#customizeDocumentCommand
- */
- public void customizeDocumentCommand(IDocument d, DocumentCommand c) {
- if (c.length == 0 && c.text != null && endsWithDelimiter(d, c.text))
- commentIndentAfterNewLine(d, c);
- else if ("/".equals(c.text)) { //$NON-NLS-1$
- commentIndentForCommentEnd(d, c);
- }
- }
-}
-
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CCommentScanner.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CCommentScanner.java
index b3eb10ff8ee..350fd6e91ec 100644
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CCommentScanner.java
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CCommentScanner.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * 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
@@ -8,152 +8,49 @@
* Contributors:
* IBM Corporation - initial API and implementation
* Anton Leherbauer (Wind River Systems)
+ * Andrew Ferguson (Symbian)
*******************************************************************************/
package org.eclipse.cdt.internal.ui.text;
-
-import java.util.ArrayList;
+import java.util.Collections;
import java.util.List;
-import java.util.StringTokenizer;
-import org.eclipse.cdt.core.CCorePreferenceConstants;
import org.eclipse.core.runtime.Preferences;
import org.eclipse.jface.preference.IPreferenceStore;
-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.text.rules.WordRule;
-import org.eclipse.jface.util.PropertyChangeEvent;
+import org.eclipse.jface.text.rules.IRule;
+import org.eclipse.cdt.ui.PreferenceConstants;
+import org.eclipse.cdt.ui.text.ITokenStoreFactory;
+import org.eclipse.cdt.ui.text.TaskTagRule;
/**
- * CCommentScanner.java
+ * Default token-scanner used for plain (non-documentation-comment) single and multi-line comments, with awareness of
+ * task tags.
*/
-public class CCommentScanner extends AbstractCScanner
-{
- private static class TaskTagDetector implements IWordDetector {
+public class CCommentScanner extends AbstractCScanner {
+ private static String TASK_TAG_KEY= PreferenceConstants.EDITOR_TASK_TAG_COLOR;
+ private Preferences fCorePreferenceStore;
+
+ public CCommentScanner(ITokenStoreFactory tokenStoreFactory, String defaultTokenProperty) {
+ this(tokenStoreFactory, null, defaultTokenProperty, new String[] { defaultTokenProperty, TASK_TAG_KEY });
+ }
- public boolean isWordStart(char c) {
- return Character.isLetter(c);
- }
+ public CCommentScanner(ITokenStoreFactory tokenStoreFactory, Preferences coreStore, String defaultTokenProperty) {
+ this(tokenStoreFactory, coreStore, defaultTokenProperty, new String[] { defaultTokenProperty, TASK_TAG_KEY });
+ }
- public boolean isWordPart(char c) {
- return Character.isLetter(c);
- }
- }
-
- private class TaskTagRule extends WordRule {
-
- private IToken fToken;
-
- public TaskTagRule(IToken token) {
- super(new TaskTagDetector(), Token.UNDEFINED);
- fToken= token;
- }
-
- public void clearTaskTags() {
- fWords.clear();
- }
-
- public 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];
- for (int i = 0; i < size; i++)
- tokens[i] = tokenizer.nextToken();
- return tokens;
- }
- }
-
- private static final String TODO_TASK_TAGS= CCorePreferenceConstants.TODO_TASK_TAGS;
- protected static final String TASK_TAG= ICColorConstants.TASK_TAG;
-
- private TaskTagRule fTaskTagRule;
- private Preferences fCorePreferenceStore;
- private String fDefaultTokenProperty;
- private String[] fTokenProperties;
-
- public CCommentScanner(IColorManager manager, IPreferenceStore store, String defaultTokenProperty) {
- this(manager, store, null, defaultTokenProperty, new String[] { defaultTokenProperty, TASK_TAG });
- }
-
- public CCommentScanner(IColorManager manager, IPreferenceStore store, Preferences coreStore, String defaultTokenProperty) {
- this(manager, store, coreStore, defaultTokenProperty, new String[] { defaultTokenProperty, TASK_TAG });
- }
-
- public CCommentScanner(IColorManager manager, IPreferenceStore store, Preferences coreStore, String defaultTokenProperty, String[] tokenProperties) {
- super(manager, store);
-
- fCorePreferenceStore= coreStore;
- fDefaultTokenProperty= defaultTokenProperty;
- fTokenProperties= tokenProperties;
-
- initialize();
- }
-
- /*
- * @see AbstractCScanner#createRules()
- */
- protected List createRules() {
- List list= new ArrayList();
-
- String tasks= null;
- if (getPreferenceStore().contains(TODO_TASK_TAGS)) {
- tasks= getPreferenceStore().getString(TODO_TASK_TAGS);
- } else if (fCorePreferenceStore != null) {
- tasks= fCorePreferenceStore.getString(TODO_TASK_TAGS);
- }
-
- if (tasks != null) {
- // Add rule for Task Tags.
- fTaskTagRule= new TaskTagRule(getToken(TASK_TAG));
- fTaskTagRule.addTaskTags(tasks);
- list.add(fTaskTagRule);
- }
-
- setDefaultReturnToken(getToken(fDefaultTokenProperty));
-
- return list;
- }
-
- /*
- * @see org.eclipse.cdt.internal.ui.text.AbstractJavaScanner#affectsBehavior(org.eclipse.jface.util.PropertyChangeEvent)
- */
- public boolean affectsBehavior(PropertyChangeEvent event) {
- return event.getProperty().equals(TODO_TASK_TAGS) || super.affectsBehavior(event);
- }
-
- /*
- * @see org.eclipse.cdt.internal.ui.text.AbstractJavaScanner#adaptToPreferenceChange(org.eclipse.jface.util.PropertyChangeEvent)
- */
- public void adaptToPreferenceChange(PropertyChangeEvent event) {
- if (fTaskTagRule != null && event.getProperty().equals(TODO_TASK_TAGS)) {
- Object value= event.getNewValue();
-
- if (value instanceof String) {
- fTaskTagRule.clearTaskTags();
- fTaskTagRule.addTaskTags((String) value);
- }
-
- } else if (super.affectsBehavior(event)) {
- super.adaptToPreferenceChange(event);
- }
- }
-
- /*
- * @see org.eclipse.cdt.internal.ui.text.AbstractJavaScanner#getTokenProperties()
- */
- protected String[] getTokenProperties() {
- return fTokenProperties;
- }
+ private CCommentScanner(ITokenStoreFactory tokenStoreFactory, Preferences coreStore, String defaultTokenProperty, String[] tokenProperties) {
+ super(tokenStoreFactory.createTokenStore(tokenProperties));
+ fCorePreferenceStore= coreStore;
+ setRules(createRules(defaultTokenProperty));
+ }
+ protected List createRules(String defaultTokenProperty) {
+ setDefaultReturnToken(getToken(defaultTokenProperty));
+ IPreferenceStore store= fTokenStore.getPreferenceStore();
+ String taskWords= TaskTagRule.getTaskWords(store, fCorePreferenceStore);
+ TaskTagRule taskTagRule= new TaskTagRule(getToken(TASK_TAG_KEY), taskWords);
+ addPropertyChangeParticipant(taskTagRule);
+ return Collections.singletonList((IRule)taskTagRule);
+ }
}
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CPreprocessorScanner.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CPreprocessorScanner.java
index 1cb52299a58..45ee69b1108 100644
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CPreprocessorScanner.java
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CPreprocessorScanner.java
@@ -7,20 +7,21 @@
*
* Contributors:
* Anton Leherbauer (Wind River Systems) - initial API and implementation
+ * Andrew Ferguson (Symbian)
*******************************************************************************/
package org.eclipse.cdt.internal.ui.text;
import java.util.ArrayList;
import java.util.List;
-import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.text.rules.IRule;
+import org.eclipse.jface.text.rules.IToken;
import org.eclipse.jface.text.rules.PatternRule;
-import org.eclipse.jface.text.rules.Token;
import org.eclipse.jface.text.rules.WhitespaceRule;
import org.eclipse.jface.text.rules.WordRule;
import org.eclipse.cdt.core.model.ICLanguageKeywords;
+import org.eclipse.cdt.ui.text.ITokenStoreFactory;
import org.eclipse.cdt.internal.ui.text.util.CWhitespaceDetector;
import org.eclipse.cdt.internal.ui.text.util.CWordDetector;
@@ -45,26 +46,22 @@ public class CPreprocessorScanner extends AbstractCScanner {
/**
* Creates a C/C++ preprocessor scanner.
- *
- * @param manager the color manager
- * @param store the preference store
* @param keywords the keywords defined by the language dialect
*/
- public CPreprocessorScanner(IColorManager manager, IPreferenceStore store, ICLanguageKeywords keywords) {
- super(manager, store);
+ public CPreprocessorScanner(ITokenStoreFactory factory, ICLanguageKeywords keywords) {
+ super(factory.createTokenStore(fgTokenProperties));
fKeywords= keywords;
- initialize();
+ setRules(createRules());
}
/*
* @see org.eclipse.cdt.internal.ui.text.AbstractCScanner#createRules()
*/
- protected List createRules() {
+ protected List createRules() {
+ IToken defaultToken= getToken(ICColorConstants.PP_DEFAULT);
- Token defaultToken= getToken(ICColorConstants.PP_DEFAULT);
-
- List rules= new ArrayList();
- Token token;
+ List rules= new ArrayList();
+ IToken token;
// Add generic white space rule.
rules.add(new WhitespaceRule(new CWhitespaceDetector()));
@@ -110,12 +107,4 @@ public class CPreprocessorScanner extends AbstractCScanner {
setDefaultReturnToken(defaultToken);
return rules;
}
-
- /*
- * @see org.eclipse.cdt.internal.ui.text.AbstractCScanner#getTokenProperties()
- */
- protected String[] getTokenProperties() {
- return fgTokenProperties;
- }
-
}
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CSourceViewerConfiguration.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CSourceViewerConfiguration.java
index 7f0a8ca7f5f..7c867888de7 100644
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CSourceViewerConfiguration.java
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CSourceViewerConfiguration.java
@@ -17,6 +17,8 @@ package org.eclipse.cdt.internal.ui.text;
import java.util.Arrays;
import org.eclipse.core.resources.IFile;
+import org.eclipse.core.resources.IProject;
+import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.NullProgressMonitor;
@@ -77,6 +79,12 @@ import org.eclipse.cdt.ui.CElementContentProvider;
import org.eclipse.cdt.ui.CUIPlugin;
import org.eclipse.cdt.ui.ILanguageUI;
import org.eclipse.cdt.ui.text.ICPartitions;
+import org.eclipse.cdt.ui.text.ICTokenScanner;
+import org.eclipse.cdt.ui.text.ITokenStore;
+import org.eclipse.cdt.ui.text.ITokenStoreFactory;
+import org.eclipse.cdt.ui.text.doctools.DefaultMultilineCommentAutoEditStrategy;
+import org.eclipse.cdt.ui.text.doctools.IDocCommentOwner;
+import org.eclipse.cdt.ui.text.doctools.IDocCommentViewerConfiguration;
import org.eclipse.cdt.internal.corext.util.CodeFormatterUtil;
@@ -90,6 +98,7 @@ import org.eclipse.cdt.internal.ui.text.c.hover.CMacroExpansionInformationProvid
import org.eclipse.cdt.internal.ui.text.contentassist.CContentAssistProcessor;
import org.eclipse.cdt.internal.ui.text.contentassist.ContentAssistPreference;
import org.eclipse.cdt.internal.ui.text.correction.CCorrectionAssistant;
+import org.eclipse.cdt.internal.ui.text.doctools.DocCommentOwnerManager;
import org.eclipse.cdt.internal.ui.typehierarchy.THInformationControl;
import org.eclipse.cdt.internal.ui.typehierarchy.THInformationProvider;
@@ -111,11 +120,11 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
/**
* The C multi-line comment scanner.
*/
- private AbstractCScanner fMultilineCommentScanner;
+ private ICTokenScanner fMultilineDocCommentScanner;
/**
* The C single-line comment scanner.
*/
- private AbstractCScanner fSinglelineCommentScanner;
+ private ICTokenScanner fSinglelineDocCommentScanner;
/**
* The C string scanner.
*/
@@ -146,24 +155,6 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
initializeScanners();
}
- /**
- * Returns the C multi-line comment scanner for this configuration.
- *
- * @return the C multi-line comment scanner
- */
- protected RuleBasedScanner getMultilineCommentScanner() {
- return fMultilineCommentScanner;
- }
-
- /**
- * Returns the C single-line comment scanner for this configuration.
- *
- * @return the C single-line comment scanner
- */
- protected RuleBasedScanner getSinglelineCommentScanner() {
- return fSinglelineCommentScanner;
- }
-
/**
* Returns the C string scanner for this configuration.
*
@@ -184,10 +175,10 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
}
AbstractCScanner scanner= null;
if (language instanceof ICLanguageKeywords) {
- scanner= new CPreprocessorScanner(getColorManager(), fPreferenceStore, (ICLanguageKeywords)language);
+ scanner= new CPreprocessorScanner(getTokenStoreFactory(), (ICLanguageKeywords)language);
}
if (scanner == null) {
- scanner= new CPreprocessorScanner(getColorManager(), fPreferenceStore, GPPLanguage.getDefault());
+ scanner= new CPreprocessorScanner(getTokenStoreFactory(), GPPLanguage.getDefault());
}
fPreprocessorScanner= scanner;
return fPreprocessorScanner;
@@ -250,14 +241,12 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
presenter.setSizeConstraints(50, 20, true, false);
return presenter;
}
-
+
/**
* Initializes the scanners.
*/
private void initializeScanners() {
- fMultilineCommentScanner= new CCommentScanner(getColorManager(), fPreferenceStore, ICColorConstants.C_MULTI_LINE_COMMENT);
- fSinglelineCommentScanner= new CCommentScanner(getColorManager(), fPreferenceStore, ICColorConstants.C_SINGLE_LINE_COMMENT);
- fStringScanner= new SingleTokenCScanner(getColorManager(), fPreferenceStore, ICColorConstants.C_STRING);
+ fStringScanner= new SingleTokenCScanner(getTokenStoreFactory(), ICColorConstants.C_STRING);
}
/**
@@ -274,17 +263,29 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
reconciler.setDamager(dr, IDocument.DEFAULT_CONTENT_TYPE);
reconciler.setRepairer(dr, IDocument.DEFAULT_CONTENT_TYPE);
-
- //TextAttribute attr = new TextAttribute(manager.getColor(ICColorConstants.C_DEFAULT));
- dr= new DefaultDamagerRepairer(getSinglelineCommentScanner());
+ dr= new DefaultDamagerRepairer(new CCommentScanner(getTokenStoreFactory(), ICColorConstants.C_SINGLE_LINE_COMMENT));
reconciler.setDamager(dr, ICPartitions.C_SINGLE_LINE_COMMENT);
reconciler.setRepairer(dr, ICPartitions.C_SINGLE_LINE_COMMENT);
-
- dr= new DefaultDamagerRepairer(getMultilineCommentScanner());
+
+ dr= new DefaultDamagerRepairer(new CCommentScanner(getTokenStoreFactory(), ICColorConstants.C_MULTI_LINE_COMMENT));
reconciler.setDamager(dr, ICPartitions.C_MULTI_LINE_COMMENT);
reconciler.setRepairer(dr, ICPartitions.C_MULTI_LINE_COMMENT);
-
+
+ ICTokenScanner docCommentSingleScanner= getSinglelineDocCommentScanner(getProject());
+ if(docCommentSingleScanner!=null) {
+ dr= new DefaultDamagerRepairer(docCommentSingleScanner);
+ reconciler.setDamager(dr, ICPartitions.C_SINGLE_LINE_DOC_COMMENT);
+ reconciler.setRepairer(dr, ICPartitions.C_SINGLE_LINE_DOC_COMMENT);
+ }
+
+ ICTokenScanner docCommentMultiScanner= getMultilineDocCommentScanner(getProject());
+ if(docCommentMultiScanner!=null) {
+ dr= new DefaultDamagerRepairer(docCommentMultiScanner);
+ reconciler.setDamager(dr, ICPartitions.C_MULTI_LINE_DOC_COMMENT);
+ reconciler.setRepairer(dr, ICPartitions.C_MULTI_LINE_DOC_COMMENT);
+ }
+
dr= new DefaultDamagerRepairer(getStringScanner());
reconciler.setDamager(dr, ICPartitions.C_STRING);
reconciler.setRepairer(dr, ICPartitions.C_STRING);
@@ -299,7 +300,33 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
return reconciler;
}
+
+ /**
+ * Returns the C multi-line comment scanner for this configuration.
+ *
+ * @return the C multi-line comment scanner
+ */
+ protected ICTokenScanner getMultilineDocCommentScanner(IResource resource) {
+ if (fMultilineDocCommentScanner == null) {
+ IDocCommentViewerConfiguration owner= DocCommentOwnerManager.getInstance().getCommentOwner(resource).getMultilineConfiguration();
+ fMultilineDocCommentScanner= owner.createCommentScanner(getTokenStoreFactory());
+ }
+ return fMultilineDocCommentScanner;
+ }
+ /**
+ * Returns the C single-line comment scanner for this configuration.
+ *
+ * @return the C single-line comment scanner
+ */
+ protected ICTokenScanner getSinglelineDocCommentScanner(IResource resource) {
+ if (fSinglelineDocCommentScanner == null) {
+ IDocCommentViewerConfiguration owner= DocCommentOwnerManager.getInstance().getCommentOwner(resource).getSinglelineConfiguration();
+ fSinglelineDocCommentScanner= owner.createCommentScanner(getTokenStoreFactory());
+ }
+ return fSinglelineDocCommentScanner;
+ }
+
/**
* @return the code scanner for the given language
*/
@@ -310,14 +337,14 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
RuleBasedScanner scanner= null;
if (language instanceof ICLanguageKeywords) {
ICLanguageKeywords cLang= (ICLanguageKeywords)language;
- scanner = new CCodeScanner(getColorManager(), fPreferenceStore, cLang);
+ scanner = new CCodeScanner(getTokenStoreFactory(), cLang);
} else if (language != null) {
ILanguageUI languageUI = (ILanguageUI)language.getAdapter(ILanguageUI.class);
if (languageUI != null)
scanner = languageUI.getCodeScanner();
}
if (scanner == null) {
- scanner = new CCodeScanner(getColorManager(), fPreferenceStore, GPPLanguage.getDefault());
+ scanner = new CCodeScanner(getTokenStoreFactory(), GPPLanguage.getDefault());
}
if (scanner instanceof AbstractCScanner) {
fCodeScanner= (AbstractCScanner)scanner;
@@ -347,6 +374,12 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
processor = new CContentAssistProcessor(getEditor(), sourceViewer, assistant, ICPartitions.C_SINGLE_LINE_COMMENT);
assistant.setContentAssistProcessor(processor, ICPartitions.C_SINGLE_LINE_COMMENT);
+ processor = new CContentAssistProcessor(getEditor(), sourceViewer, assistant, ICPartitions.C_MULTI_LINE_DOC_COMMENT);
+ assistant.setContentAssistProcessor(processor, ICPartitions.C_MULTI_LINE_DOC_COMMENT);
+
+ processor = new CContentAssistProcessor(getEditor(), sourceViewer, assistant, ICPartitions.C_SINGLE_LINE_DOC_COMMENT);
+ assistant.setContentAssistProcessor(processor, ICPartitions.C_SINGLE_LINE_DOC_COMMENT);
+
processor = new CContentAssistProcessor(getEditor(), sourceViewer, assistant, ICPartitions.C_STRING);
assistant.setContentAssistProcessor(processor, ICPartitions.C_STRING);
@@ -410,26 +443,46 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
*/
public IAutoEditStrategy[] getAutoEditStrategies(ISourceViewer sourceViewer, String contentType) {
String partitioning= getConfiguredDocumentPartitioning(sourceViewer);
+
+ IDocCommentOwner owner= DocCommentOwnerManager.getInstance().getCommentOwner(getProject());
+ IAutoEditStrategy single= owner.getSinglelineConfiguration().createAutoEditStrategy();
+ IAutoEditStrategy multi= owner.getMultilineConfiguration().createAutoEditStrategy();
+
+ IAutoEditStrategy[] NONE= new IAutoEditStrategy[0];
+
if (ICPartitions.C_MULTI_LINE_COMMENT.equals(contentType))
- return new IAutoEditStrategy[] { new CCommentAutoIndentStrategy() };
+ return new IAutoEditStrategy[] { new DefaultMultilineCommentAutoEditStrategy() };
+ if (ICPartitions.C_SINGLE_LINE_DOC_COMMENT.equals(contentType))
+ return single!=null ? new IAutoEditStrategy[] {single} : NONE;
+ else if (ICPartitions.C_MULTI_LINE_DOC_COMMENT.equals(contentType))
+ return multi!=null? new IAutoEditStrategy[] {multi} : NONE;
else if (ICPartitions.C_STRING.equals(contentType))
- return new IAutoEditStrategy[] { /*new SmartSemicolonAutoEditStrategy(partitioning),*/ new CStringAutoIndentStrategy(partitioning, getProject()) };
+ return new IAutoEditStrategy[] { /*new SmartSemicolonAutoEditStrategy(partitioning),*/ new CStringAutoIndentStrategy(partitioning, getCProject()) };
else
- return new IAutoEditStrategy[] { new CAutoIndentStrategy(partitioning, getProject()) };
+ return new IAutoEditStrategy[] { new CAutoIndentStrategy(partitioning, getCProject()) };
}
-
+
/**
* @see SourceViewerConfiguration#getDoubleClickStrategy(ISourceViewer, String)
*/
public ITextDoubleClickStrategy getDoubleClickStrategy(ISourceViewer sourceViewer, String contentType) {
if (ICPartitions.C_MULTI_LINE_COMMENT.equals(contentType) ||
- ICPartitions.C_SINGLE_LINE_COMMENT.equals(contentType))
+ ICPartitions.C_SINGLE_LINE_COMMENT.equals(contentType)) {
return new DefaultTextDoubleClickStrategy();
- else if (ICPartitions.C_STRING.equals(contentType) ||
- ICPartitions.C_CHARACTER.equals(contentType))
+ } else if (ICPartitions.C_SINGLE_LINE_DOC_COMMENT.equals(contentType)) {
+ IDocCommentOwner owner= DocCommentOwnerManager.getInstance().getCommentOwner(getProject());
+ ITextDoubleClickStrategy single= owner.getSinglelineConfiguration().createDoubleClickStrategy();
+ return single != null ? single : new DefaultTextDoubleClickStrategy();
+ } else if(ICPartitions.C_MULTI_LINE_DOC_COMMENT.equals(contentType)) {
+ IDocCommentOwner owner= DocCommentOwnerManager.getInstance().getCommentOwner(getProject());
+ ITextDoubleClickStrategy multi= owner.getMultilineConfiguration().createDoubleClickStrategy();
+ return multi!=null ? multi : new DefaultTextDoubleClickStrategy();
+ } else if (ICPartitions.C_STRING.equals(contentType) ||
+ ICPartitions.C_CHARACTER.equals(contentType)) {
return new CStringDoubleClickSelector(getConfiguredDocumentPartitioning(sourceViewer));
- else if (ICPartitions.C_PREPROCESSOR.equals(contentType))
+ } else if (ICPartitions.C_PREPROCESSOR.equals(contentType)) {
return new CStringDoubleClickSelector(getConfiguredDocumentPartitioning(sourceViewer), new CDoubleClickSelector());
+ }
return new CDoubleClickSelector();
}
@@ -444,7 +497,7 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
* @see SourceViewerConfiguration#getIndentPrefixes(ISourceViewer, String)
*/
public String[] getIndentPrefixes(ISourceViewer sourceViewer, String contentType) {
- ICProject project= getProject();
+ ICProject project= getCProject();
final int tabWidth= CodeFormatterUtil.getTabWidth(project);
final int indentWidth= CodeFormatterUtil.getIndentWidth(project);
boolean allowTabs= tabWidth <= indentWidth;
@@ -504,7 +557,12 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
return new String(spaceChars);
}
- private ICProject getProject() {
+ /**
+ * Returns the ICProject associated with this CSourceViewerConfiguration, or null if
+ * no ICProject could be determined
+ * @return
+ */
+ private ICProject getCProject() {
ITextEditor editor= getEditor();
if (editor == null)
return null;
@@ -527,7 +585,7 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
* @see SourceViewerConfiguration#getTabWidth(ISourceViewer)
*/
public int getTabWidth(ISourceViewer sourceViewer) {
- return CodeFormatterUtil.getTabWidth(getProject());
+ return CodeFormatterUtil.getTabWidth(getCProject());
}
/**
@@ -536,7 +594,7 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
* @return the indent width
*/
public int getIndentWidth(ISourceViewer sourceViewer) {
- return CodeFormatterUtil.getIndentWidth(getProject());
+ return CodeFormatterUtil.getIndentWidth(getCProject());
}
/**
@@ -546,7 +604,7 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
* @return true if spaces should be used for indentation
*/
public boolean useSpacesOnly(ISourceViewer sourceViewer) {
- ICProject project= getProject();
+ ICProject project= getCProject();
String option;
if (project == null)
option= CCorePlugin.getOption(DefaultCodeFormatterConstants.FORMATTER_TAB_CHAR);
@@ -628,7 +686,10 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
ICPartitions.C_SINGLE_LINE_COMMENT,
ICPartitions.C_STRING,
ICPartitions.C_CHARACTER,
- ICPartitions.C_PREPROCESSOR};
+ ICPartitions.C_PREPROCESSOR,
+ ICPartitions.C_SINGLE_LINE_DOC_COMMENT,
+ ICPartitions.C_MULTI_LINE_DOC_COMMENT
+ };
}
/**
@@ -645,8 +706,8 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
}
public boolean affectsBehavior(PropertyChangeEvent event) {
- if (fMultilineCommentScanner.affectsBehavior(event)
- || fSinglelineCommentScanner.affectsBehavior(event)
+ if ((fMultilineDocCommentScanner != null && fMultilineDocCommentScanner.affectsBehavior(event))
+ || (fSinglelineDocCommentScanner != null && fSinglelineDocCommentScanner.affectsBehavior(event))
|| fStringScanner.affectsBehavior(event)) {
return true;
}
@@ -739,10 +800,10 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
public void handlePropertyChangeEvent(PropertyChangeEvent event) {
if (fCodeScanner != null && fCodeScanner.affectsBehavior(event))
fCodeScanner.adaptToPreferenceChange(event);
- if (fMultilineCommentScanner.affectsBehavior(event))
- fMultilineCommentScanner.adaptToPreferenceChange(event);
- if (fSinglelineCommentScanner.affectsBehavior(event))
- fSinglelineCommentScanner.adaptToPreferenceChange(event);
+ if (fMultilineDocCommentScanner!=null && fMultilineDocCommentScanner.affectsBehavior(event))
+ fMultilineDocCommentScanner.adaptToPreferenceChange(event);
+ if (fSinglelineDocCommentScanner!=null && fSinglelineDocCommentScanner.affectsBehavior(event))
+ fSinglelineDocCommentScanner.adaptToPreferenceChange(event);
if (fStringScanner.affectsBehavior(event))
fStringScanner.adaptToPreferenceChange(event);
if (fPreprocessorScanner != null && fPreprocessorScanner.affectsBehavior(event))
@@ -858,9 +919,11 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
*/
public void resetScanners() {
fCodeScanner= null;
+ fMultilineDocCommentScanner= null;
+ fSinglelineDocCommentScanner= null;
fPreprocessorScanner= null;
}
-
+
/**
* Creates macro exploration presenter.
* @param sourceViewer
@@ -898,5 +961,21 @@ public class CSourceViewerConfiguration extends TextSourceViewerConfiguration {
};
return conrolCreator;
}
+
+ /**
+ * @return the IProject associated with this CSourceViewerConfiguration, or null if
+ * no IProject could be determined
+ */
+ private IProject getProject() {
+ ICProject cproject= getCProject();
+ return cproject!=null ? cproject.getProject() :null;
+ }
-}
+ private ITokenStoreFactory getTokenStoreFactory() {
+ return new ITokenStoreFactory() {
+ public ITokenStore createTokenStore(String[] propertyColorNames) {
+ return new TokenStore(getColorManager(), fPreferenceStore, propertyColorNames);
+ }
+ };
+ }
+}
\ No newline at end of file
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CTextTools.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CTextTools.java
index 1fd70040d3b..9c906510013 100644
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CTextTools.java
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/CTextTools.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2005, 2007 IBM Corporation and others.
+ * Copyright (c) 2005, 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
@@ -9,9 +9,14 @@
* IBM Corporation - initial API and implementation
* QNX Software System
* Anton Leherbauer (Wind River Systems)
+ * Andrew Ferguson (Symbian)
*******************************************************************************/
package org.eclipse.cdt.internal.ui.text;
+import org.eclipse.core.filebuffers.LocationKind;
+import org.eclipse.core.resources.IFile;
+import org.eclipse.core.resources.ResourcesPlugin;
+import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Preferences;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.text.IDocument;
@@ -26,7 +31,11 @@ import org.eclipse.cdt.core.dom.ast.gnu.c.GCCLanguage;
import org.eclipse.cdt.core.dom.ast.gnu.cpp.GPPLanguage;
import org.eclipse.cdt.ui.CUIPlugin;
import org.eclipse.cdt.ui.text.ICPartitions;
+import org.eclipse.cdt.ui.text.ITokenStore;
+import org.eclipse.cdt.ui.text.ITokenStoreFactory;
+import org.eclipse.cdt.ui.text.doctools.IDocCommentOwner;
+import org.eclipse.cdt.internal.ui.text.doctools.DocCommentOwnerManager;
import org.eclipse.cdt.internal.ui.text.util.CColorManager;
@@ -35,14 +44,14 @@ import org.eclipse.cdt.internal.ui.text.util.CColorManager;
* its clients.
*/
public class CTextTools {
-
+
private class PreferenceListener implements IPropertyChangeListener, Preferences.IPropertyChangeListener {
public void propertyChange(PropertyChangeEvent event) {
adaptToPreferenceChange(event);
}
- public void propertyChange(Preferences.PropertyChangeEvent event) {
- adaptToPreferenceChange(new PropertyChangeEvent(event.getSource(), event.getProperty(), event.getOldValue(), event.getNewValue()));
- }
+ public void propertyChange(Preferences.PropertyChangeEvent event) {
+ adaptToPreferenceChange(new PropertyChangeEvent(event.getSource(), event.getProperty(), event.getOldValue(), event.getNewValue()));
+ }
}
/** The color manager */
@@ -64,57 +73,60 @@ public class CTextTools {
/** The preference store */
private IPreferenceStore fPreferenceStore;
- /** The core preference store */
- private Preferences fCorePreferenceStore;
+ /** The core preference store */
+ private Preferences fCorePreferenceStore;
/** The preference change listener */
private PreferenceListener fPreferenceListener= new PreferenceListener();
/** The document partitioning used for the C partitioner */
private String fDocumentPartitioning = ICPartitions.C_PARTITIONING;
-
- /**
- * Creates a new C text tools collection and eagerly creates
- * and initializes all members of this collection.
- */
- public CTextTools(IPreferenceStore store) {
- this(store, null, true);
- }
-
- /**
- * Creates a new C text tools collection and eagerly creates
- * and initializes all members of this collection.
- */
- public CTextTools(IPreferenceStore store, Preferences coreStore) {
- this(store, coreStore, true);
- }
-
- /**
- * Creates a new C text tools collection and eagerly creates
- * and initializes all members of this collection.
- */
- public CTextTools(IPreferenceStore store, Preferences coreStore, boolean autoDisposeOnDisplayDispose) {
- if(store == null) {
- store = CUIPlugin.getDefault().getPreferenceStore();
- }
- fColorManager= new CColorManager(autoDisposeOnDisplayDispose);
- fCodeScanner= new CCodeScanner(fColorManager, store, GCCLanguage.getDefault());
- fCppCodeScanner= new CCodeScanner(fColorManager, store, GPPLanguage.getDefault());
-
- fMultilineCommentScanner= new CCommentScanner(fColorManager, store, coreStore, ICColorConstants.C_MULTI_LINE_COMMENT);
- fSinglelineCommentScanner= new CCommentScanner(fColorManager, store, coreStore, ICColorConstants.C_SINGLE_LINE_COMMENT);
- fStringScanner= new SingleTokenCScanner(fColorManager, store, ICColorConstants.C_STRING);
- fCPreprocessorScanner= new CPreprocessorScanner(fColorManager, store, GCCLanguage.getDefault());
- fCppPreprocessorScanner= new CPreprocessorScanner(fColorManager, store, GPPLanguage.getDefault());
- fPreferenceStore = store;
- fPreferenceStore.addPropertyChangeListener(fPreferenceListener);
-
- fCorePreferenceStore= coreStore;
- if (fCorePreferenceStore != null) {
- fCorePreferenceStore.addPropertyChangeListener(fPreferenceListener);
- }
-
+ /**
+ * Creates a new C text tools collection and eagerly creates
+ * and initializes all members of this collection.
+ */
+ public CTextTools(IPreferenceStore store) {
+ this(store, null, true);
}
-
+
+ /**
+ * Creates a new C text tools collection and eagerly creates
+ * and initializes all members of this collection.
+ */
+ public CTextTools(IPreferenceStore store, Preferences coreStore) {
+ this(store, coreStore, true);
+ }
+
+ /**
+ * Creates a new C text tools collection and eagerly creates
+ * and initializes all members of this collection.
+ */
+ public CTextTools(IPreferenceStore store, Preferences coreStore, boolean autoDisposeOnDisplayDispose) {
+ fPreferenceStore = store != null ? store : CUIPlugin.getDefault().getPreferenceStore();
+ fColorManager= new CColorManager(autoDisposeOnDisplayDispose);
+
+ ITokenStoreFactory factory= new ITokenStoreFactory() {
+ public ITokenStore createTokenStore(String[] propertyColorNames) {
+ return new TokenStore(getColorManager(), fPreferenceStore, propertyColorNames);
+ }
+ };
+
+ fMultilineCommentScanner= new CCommentScanner(factory, coreStore, ICColorConstants.C_MULTI_LINE_COMMENT);
+ fSinglelineCommentScanner= new CCommentScanner(factory, coreStore, ICColorConstants.C_SINGLE_LINE_COMMENT);
+ fCodeScanner= new CCodeScanner(factory, GCCLanguage.getDefault());
+ fCppCodeScanner= new CCodeScanner(factory, GPPLanguage.getDefault());
+
+ fStringScanner= new SingleTokenCScanner(factory, ICColorConstants.C_STRING);
+ fCPreprocessorScanner= new CPreprocessorScanner(factory, GCCLanguage.getDefault());
+ fCppPreprocessorScanner= new CPreprocessorScanner(factory, GPPLanguage.getDefault());
+
+ fPreferenceStore.addPropertyChangeListener(fPreferenceListener);
+
+ fCorePreferenceStore= coreStore;
+ if (fCorePreferenceStore != null) {
+ fCorePreferenceStore.addPropertyChangeListener(fPreferenceListener);
+ }
+ }
+
/**
* Creates a new C text tools collection and eagerly creates
* and initializes all members of this collection.
@@ -122,83 +134,75 @@ public class CTextTools {
public CTextTools() {
this((IPreferenceStore)null);
}
-
+
/**
* Disposes all members of this tools collection.
*/
public void dispose() {
-
+
fCodeScanner= null;
fMultilineCommentScanner= null;
fSinglelineCommentScanner= null;
fStringScanner= null;
-
+
if (fColorManager != null) {
fColorManager.dispose();
fColorManager= null;
}
-
+
if (fPreferenceStore != null) {
fPreferenceStore.removePropertyChangeListener(fPreferenceListener);
fPreferenceStore= null;
-
- if (fCorePreferenceStore != null) {
- fCorePreferenceStore.removePropertyChangeListener(fPreferenceListener);
- fCorePreferenceStore= null;
- }
-
+
+ if (fCorePreferenceStore != null) {
+ fCorePreferenceStore.removePropertyChangeListener(fPreferenceListener);
+ fCorePreferenceStore= null;
+ }
+
fPreferenceListener= null;
}
}
-
+
/**
* Gets the color manager.
*/
public CColorManager getColorManager() {
return fColorManager;
}
-
+
/**
* Gets the code scanner used.
*/
public RuleBasedScanner getCCodeScanner() {
return fCodeScanner;
}
-
+
/**
* Gets the code scanner used.
*/
public RuleBasedScanner getCppCodeScanner() {
return fCppCodeScanner;
}
-
+
/**
* Returns a scanner which is configured to scan
* C-specific partitions, which are multi-line comments,
* and regular C source code.
*
+ * @param owner may be null
* @return a C partition scanner
*/
- public IPartitionTokenScanner getPartitionScanner() {
- return new FastCPartitionScanner();
+ public IPartitionTokenScanner getPartitionScanner(IDocCommentOwner owner) {
+ return new FastCPartitionScanner(owner);
}
-
+
/**
* Gets the document provider used.
*/
- public IDocumentPartitioner createDocumentPartitioner() {
-
- String[] types= new String[] {
- ICPartitions.C_MULTI_LINE_COMMENT,
- ICPartitions.C_SINGLE_LINE_COMMENT,
- ICPartitions.C_STRING,
- ICPartitions.C_CHARACTER,
- ICPartitions.C_PREPROCESSOR
- };
-
- return new FastCPartitioner(getPartitionScanner(), types);
+ public IDocumentPartitioner createDocumentPartitioner(IDocCommentOwner owner) {
+ return new FastCPartitioner(getPartitionScanner(owner), ICPartitions.ALL_CPARTITIONS);
}
-
+
/**
* Returns a scanner which is configured to scan C multiline comments.
*
@@ -216,7 +220,7 @@ public class CTextTools {
public RuleBasedScanner getSinglelineCommentScanner() {
return fSinglelineCommentScanner;
}
-
+
/**
* Returns a scanner which is configured to scan C strings.
*
@@ -243,7 +247,7 @@ public class CTextTools {
public RuleBasedScanner getCppPreprocessorScanner() {
return fCppPreprocessorScanner;
}
-
+
/**
* Determines whether the preference change encoded by the given event
* changes the behavior of one its contained components.
@@ -253,13 +257,13 @@ public class CTextTools {
*/
public boolean affectsBehavior(PropertyChangeEvent event) {
return fCodeScanner.affectsBehavior(event) ||
- fCppCodeScanner.affectsBehavior(event) ||
- fMultilineCommentScanner.affectsBehavior(event) ||
- fSinglelineCommentScanner.affectsBehavior(event) ||
- fStringScanner.affectsBehavior(event) ||
- fCPreprocessorScanner.affectsBehavior(event);
+ fCppCodeScanner.affectsBehavior(event) ||
+ fMultilineCommentScanner.affectsBehavior(event) ||
+ fSinglelineCommentScanner.affectsBehavior(event) ||
+ fStringScanner.affectsBehavior(event) ||
+ fCPreprocessorScanner.affectsBehavior(event);
}
-
+
/**
* Adapts the behavior of the contained components to the change
* encoded in the given event.
@@ -286,12 +290,13 @@ public class CTextTools {
/**
* Sets up the document partitioner for the given document for the given partitioning.
*
- * @param document the document to be set up
- * @param partitioning the document partitioning
- * @since 3.0
+ * @param document
+ * @param partitioning
+ * @param owner may be null
+ * @since 5.0
*/
- public void setupCDocumentPartitioner(IDocument document, String partitioning) {
- IDocumentPartitioner partitioner= createDocumentPartitioner();
+ public void setupCDocumentPartitioner(IDocument document, String partitioning, IDocCommentOwner owner) {
+ IDocumentPartitioner partitioner= createDocumentPartitioner(owner);
if (document instanceof IDocumentExtension3) {
IDocumentExtension3 extension3= (IDocumentExtension3) document;
extension3.setDocumentPartitioner(partitioning, partitioner);
@@ -300,7 +305,20 @@ public class CTextTools {
}
partitioner.connect(document);
}
-
+
+ /**
+ * Sets up the given document for the default partitioning.
+ *
+ * @param document the document to be set up
+ * @param location the path of the resource backing the document. May be null.
+ * @param locationKind the type of path specified above. May be null.
+ * @since 3.0
+ */
+ public void setupCDocument(IDocument document, IPath location, LocationKind locationKind) {
+ IDocCommentOwner owner= getDocumentationCommentOwner(location, locationKind);
+ setupCDocumentPartitioner(document, fDocumentPartitioning, owner);
+ }
+
/**
* Sets up the given document for the default partitioning.
*
@@ -308,7 +326,7 @@ public class CTextTools {
* @since 3.0
*/
public void setupCDocument(IDocument document) {
- setupCDocumentPartitioner(document, fDocumentPartitioning);
+ setupCDocumentPartitioner(document, fDocumentPartitioning, null);
}
/**
@@ -329,5 +347,19 @@ public class CTextTools {
public void setDocumentPartitioning(String documentPartitioning) {
fDocumentPartitioning = documentPartitioning;
}
-
+
+ /**
+ * @param location
+ * @param locationKind
+ * @return the documentation comment owner mapped to the specified location. If there is
+ * no mapping, or the location/locationKind is not available, the
+ * workspace default is returned.
+ */
+ private IDocCommentOwner getDocumentationCommentOwner(IPath location, LocationKind locationKind) {
+ if(location!=null && LocationKind.IFILE.equals(locationKind)) {
+ IFile file= ResourcesPlugin.getWorkspace().getRoot().getFile(location);
+ return DocCommentOwnerManager.getInstance().getCommentOwner(file);
+ }
+ return DocCommentOwnerManager.getInstance().getWorkspaceCommentOwner();
+ }
}
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/FastCPartitionScanner.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/FastCPartitionScanner.java
index 48913933d4e..e3a5ef74109 100644
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/FastCPartitionScanner.java
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/FastCPartitionScanner.java
@@ -9,6 +9,7 @@
* IBM Corporation - initial API and implementation
* QNX Software System
* Anton Leherbauer (Wind River Systems)
+ * Andrew Ferguson (Symbian)
*******************************************************************************/
package org.eclipse.cdt.internal.ui.text;
@@ -21,6 +22,7 @@ import org.eclipse.jface.text.rules.IToken;
import org.eclipse.jface.text.rules.Token;
import org.eclipse.cdt.ui.text.ICPartitions;
+import org.eclipse.cdt.ui.text.doctools.IDocCommentOwner;
/**
@@ -38,6 +40,8 @@ public final class FastCPartitionScanner implements IPartitionTokenScanner, ICPa
private static final int PREPROCESSOR= 5;
private static final int PREPROCESSOR_MULTI_LINE_COMMENT= 6;
private static final int PREPROCESSOR_STRING= 7;
+ private static final int SINGLE_LINE_DOC_COMMENT= 8;
+ private static final int MULTI_LINE_DOC_COMMENT= 9;
// beginning of prefixes and postfixes
private static final int NONE= 0;
@@ -65,11 +69,14 @@ public final class FastCPartitionScanner implements IPartitionTokenScanner, ICPa
private int fPrefixLength;
/** Indicate whether current char is first non-whitespace char on the line*/
private boolean fFirstCharOnLine= true;
-
+ /** An optional (possibly null) comment owner for detecting documentation-comments **/
+ private IDocCommentOwner fOwner;
+
// emulate CPartitionScanner
private final boolean fEmulate;
private int fCCodeOffset;
private int fCCodeLength;
+ private IDocument fDocument;
private final IToken[] fTokens= new IToken[] {
new Token(null),
@@ -80,14 +87,21 @@ public final class FastCPartitionScanner implements IPartitionTokenScanner, ICPa
new Token(C_PREPROCESSOR),
new Token(C_MULTI_LINE_COMMENT),
new Token(C_PREPROCESSOR),
+ new Token(C_SINGLE_LINE_DOC_COMMENT),
+ new Token(C_MULTI_LINE_DOC_COMMENT)
};
- public FastCPartitionScanner(boolean emulate) {
+ public FastCPartitionScanner(boolean emulate, IDocCommentOwner owner) {
fEmulate= emulate;
+ fOwner= owner;
}
+ public FastCPartitionScanner(IDocCommentOwner owner) {
+ this(false, owner);
+ }
+
public FastCPartitionScanner() {
- this(false);
+ this(false, null);
}
/*
@@ -533,13 +547,18 @@ public final class FastCPartitionScanner implements IPartitionTokenScanner, ICPa
}
private final IToken postFix(int state) {
+ return postFix(state, CCODE);
+ }
+
+ private final IToken postFix(int state, int newState) {
fTokenLength++;
fLast= NONE;
- fState= CCODE;
+ fState= newState;
fPrefixLength= 0;
- return fTokens[state];
+ return fTokens[interceptTokenState(state)];
}
+
private final IToken preFix(int state, int newState, int last, int prefixLength) {
// emulate CPartitionScanner
if (fEmulate && state == CCODE && (fTokenLength - getLastLength(fLast) > 0)) {
@@ -550,15 +569,14 @@ public final class FastCPartitionScanner implements IPartitionTokenScanner, ICPa
fState= newState;
fPrefixLength= prefixLength;
fLast= last;
- return fTokens[state];
+ return fTokens[interceptTokenState(state)];
} else {
fTokenLength -= getLastLength(fLast);
fLast= last;
fPrefixLength= prefixLength;
- IToken token= fTokens[state];
fState= newState;
- return token;
+ return fTokens[interceptTokenState(state)];
}
}
@@ -581,7 +599,13 @@ public final class FastCPartitionScanner implements IPartitionTokenScanner, ICPa
else if (contentType.equals(C_PREPROCESSOR))
return PREPROCESSOR;
-
+
+ else if (contentType.equals(C_SINGLE_LINE_DOC_COMMENT))
+ return SINGLE_LINE_COMMENT; // intentionally non-doc state: the state machine is doc-comment unaware
+
+ else if (contentType.equals(C_MULTI_LINE_DOC_COMMENT))
+ return MULTI_LINE_COMMENT; // intentionally non-doc state: the state machine is doc-comment unaware
+
else
return CCODE;
}
@@ -590,7 +614,7 @@ public final class FastCPartitionScanner implements IPartitionTokenScanner, ICPa
* @see IPartitionTokenScanner#setPartialRange(IDocument, int, int, String, int)
*/
public void setPartialRange(IDocument document, int offset, int length, String contentType, int partitionOffset) {
-
+ fDocument= document;
fScanner.setRange(document, offset, length);
fTokenOffset= partitionOffset;
fTokenLength= 0;
@@ -622,7 +646,7 @@ public final class FastCPartitionScanner implements IPartitionTokenScanner, ICPa
* @see ITokenScanner#setRange(IDocument, int, int)
*/
public void setRange(IDocument document, int offset, int length) {
-
+ fDocument= document;
fScanner.setRange(document, offset, length);
fTokenOffset= offset;
fTokenLength= 0;
@@ -658,4 +682,30 @@ public final class FastCPartitionScanner implements IPartitionTokenScanner, ICPa
return fTokenOffset;
}
+ private int interceptTokenState(int proposedTokenState) {
+ if(fOwner!=null) {
+ switch(proposedTokenState) {
+ case MULTI_LINE_COMMENT:
+ if(fOwner.getMultilineConfiguration().isDocumentationComment(fDocument, fTokenOffset, fTokenLength))
+ return MULTI_LINE_DOC_COMMENT;
+ break;
+
+ case SINGLE_LINE_COMMENT:
+ if(fOwner.getSinglelineConfiguration().isDocumentationComment(fDocument, fTokenOffset, fTokenLength))
+ return SINGLE_LINE_DOC_COMMENT;
+ break;
+
+ }
+ }
+ return proposedTokenState;
+ }
+
+ /**
+ * @return the DocCommentOwner associated with this partition scanner, or null
+ * if there is no owner.
+ * @since 5.0
+ */
+ public IDocCommentOwner getDocCommentOwner() {
+ return fOwner;
+ }
}
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/FastCPartitioner.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/FastCPartitioner.java
index 8439d665db3..653d6e0ab1d 100644
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/FastCPartitioner.java
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/FastCPartitioner.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2007 Wind River Systems, Inc. and others.
+ * Copyright (c) 2007, 2008 Wind River Systems, Inc. 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
@@ -7,6 +7,7 @@
*
* Contributors:
* Anton Leherbauer (Wind River Systems) - initial API and implementation
+ * Andrew Ferguson (Symbian)
*******************************************************************************/
package org.eclipse.cdt.internal.ui.text;
@@ -16,6 +17,7 @@ import org.eclipse.jface.text.rules.FastPartitioner;
import org.eclipse.jface.text.rules.IPartitionTokenScanner;
import org.eclipse.cdt.ui.text.ICPartitions;
+import org.eclipse.cdt.ui.text.doctools.IDocCommentOwner;
/**
* A slightly adapted FastPartitioner.
@@ -44,10 +46,30 @@ public class FastCPartitioner extends FastPartitioner {
if (fDocument.getChar(offset - 1) != '\n') {
return region;
}
+ } else if (ICPartitions.C_MULTI_LINE_DOC_COMMENT.equals(region.getType())) {
+ if (!fDocument.get(offset - 2, 2).equals("*/")) { //$NON-NLS-1$
+ return region;
+ }
+ } else if (ICPartitions.C_SINGLE_LINE_DOC_COMMENT.equals(region .getType())) {
+ if (fDocument.getChar(offset - 1) != '\n') {
+ return region;
+ }
}
} catch (BadLocationException exc) {
}
}
return super.getPartition(offset, preferOpenPartitions);
}
+
+ /**
+ * @return the DocCommentOwner associated with this partition scanner, or null
+ * if there is no owner.
+ * @since 5.0
+ */
+ public IDocCommentOwner getDocCommentOwner() {
+ if(fScanner instanceof FastCPartitionScanner) {
+ return ((FastCPartitionScanner)fScanner).getDocCommentOwner();
+ }
+ return null;
+ }
}
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/SingleTokenCScanner.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/SingleTokenCScanner.java
index 9313741b345..c79afdc63c5 100644
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/SingleTokenCScanner.java
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/SingleTokenCScanner.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000 2005 IBM Corporation and others.
+ * 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
@@ -8,42 +8,36 @@
* Contributors:
* IBM Corporation - initial API and implementation
* QNX Software System
+ * Andrew Ferguson (Symbian)
*******************************************************************************/
package org.eclipse.cdt.internal.ui.text;
import java.util.List;
-import org.eclipse.jface.preference.IPreferenceStore;
+
import org.eclipse.jface.text.IDocument;
+import org.eclipse.jface.text.rules.IRule;
import org.eclipse.jface.text.rules.IToken;
import org.eclipse.jface.text.rules.Token;
+import org.eclipse.cdt.ui.text.ITokenStoreFactory;
/**
*
*/
-public final class SingleTokenCScanner extends AbstractCScanner{
-
+public final class SingleTokenCScanner extends AbstractCScanner {
+ private String fProperty;
+ private int position, end;
+ private int size;
protected IToken fDefaultReturnToken;
- private String[] fProperty;
- public SingleTokenCScanner(IColorManager manager, IPreferenceStore store, String property) {
- super(manager, store, 20);
- fProperty= new String[] { property };
- initialize();
+ public SingleTokenCScanner(ITokenStoreFactory factory, String property) {
+ super(factory.createTokenStore(new String[] {property}), 20);
+ fProperty= property;
+ setRules(createRules());
}
- /*
- * @see AbstractCScanner#getTokenProperties()
- */
- protected String[] getTokenProperties() {
- return fProperty;
- }
-
- /*
- * @see AbstractCScanner#createRules()
- */
- protected List createRules() {
- fDefaultReturnToken= getToken(fProperty[0]);
+ protected List createRules() {
+ fDefaultReturnToken= getToken(fProperty);
setDefaultReturnToken(fDefaultReturnToken);
return null;
}
@@ -51,9 +45,6 @@ public final class SingleTokenCScanner extends AbstractCScanner{
/**
* setRange -- sets the range to be scanned
*/
-
- private int position, end;
- private int size;
public void setRange(IDocument document, int offset, int length) {
super.setRange(document, offset, length);
@@ -61,13 +52,13 @@ public final class SingleTokenCScanner extends AbstractCScanner{
size = length;
end = offset + length;
}
+
/**
* Returns the next token in the document.
*
* @return the next token in the document
*/
public IToken nextToken() {
-
fTokenOffset = position;
if(position < end) {
@@ -81,30 +72,6 @@ public final class SingleTokenCScanner extends AbstractCScanner{
public int getTokenLength() {
return size;
}
-
- //public int getTokenOffset() {
- // return position;
- //}
- /* while (true) {
-
- fTokenOffset= fOffset;
- fColumn= UNDEFINED;
-
- if (fRules != null) {
- for (int i= 0; i < fRules.length; i++) {
- token= (fRules[i].evaluate(this));
- if (!token.isUndefined())
- return token;
- }
- }
-
- if (read() == EOF)
- return Token.EOF;
- else
- return fDefaultReturnToken;
- }
- } */
-
}
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/TokenStore.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/TokenStore.java
new file mode 100644
index 00000000000..9a97d8c31a2
--- /dev/null
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/TokenStore.java
@@ -0,0 +1,275 @@
+/*******************************************************************************
+ * 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
+ * QNX Software System
+ * Andrew Ferguson (Symbian) - refactored to TokenStore (previously part of AbstractCScanner)
+ *******************************************************************************/
+package org.eclipse.cdt.internal.ui.text;
+
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.eclipse.jface.preference.IPreferenceStore;
+import org.eclipse.jface.preference.PreferenceConverter;
+import org.eclipse.jface.resource.StringConverter;
+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.swt.SWT;
+import org.eclipse.swt.graphics.Color;
+import org.eclipse.swt.graphics.RGB;
+import org.eclipse.swt.widgets.Display;
+
+import org.eclipse.cdt.ui.PreferenceConstants;
+import org.eclipse.cdt.ui.text.ITokenStore;
+
+
+/**
+ * Maintains a pool of tokens identified by a String ID.
+ * Supports styles per token.
+ * Updates token instances on property changes.
+ */
+
+public class TokenStore implements ITokenStore {
+ private IColorManager fColorManager;
+ private IPreferenceStore fPreferenceStore;
+
+ private Map fTokenMap= new HashMap();
+ private String[] fPropertyNamesColor;
+
+ private boolean fNeedsLazyColorLoading;
+
+ /**
+ * Maintains tokens for a specified set of property keys. Automatically also
+ * copes with bold, italic, strike-through and underlined versions of the key.
+ * @param manager the IColorManager to retrieve token colors from
+ * @param store the {@link IPreferenceStore} to fetch property preferences from
+ */
+ public TokenStore(IColorManager manager, IPreferenceStore store, String[] propertyNamesColor) {
+ fColorManager= manager;
+ fPreferenceStore= store;
+
+ fPropertyNamesColor= propertyNamesColor;
+
+ fNeedsLazyColorLoading= Display.getCurrent() == null;
+ for (int i= 0; i < fPropertyNamesColor.length; i++) {
+ if(fPropertyNamesColor[i].endsWith(PreferenceConstants.EDITOR_BOLD_SUFFIX)
+ || fPropertyNamesColor[i].endsWith(PreferenceConstants.EDITOR_ITALIC_SUFFIX)
+ || fPropertyNamesColor[i].endsWith(PreferenceConstants.EDITOR_STRIKETHROUGH_SUFFIX)
+ || fPropertyNamesColor[i].endsWith(PreferenceConstants.EDITOR_UNDERLINE_SUFFIX)) {
+ throw new IllegalArgumentException(); // XXX
+ }
+ if (fNeedsLazyColorLoading)
+ addTokenWithProxyAttribute(fPropertyNamesColor[i]);
+ else
+ addToken(fPropertyNamesColor[i]);
+ }
+ }
+
+ /**
+ * In the case where at the time of IToken construction, the Display was not
+ * ready to construct colors.
+ */
+ public void ensureTokensInitialised() {
+ if (fNeedsLazyColorLoading && Display.getCurrent() != null) {
+ for (int i= 0; i < fPropertyNamesColor.length; i++) {
+ addToken(fPropertyNamesColor[i]);
+ }
+ fNeedsLazyColorLoading= false;
+ }
+ }
+
+ private void addTokenWithProxyAttribute(String colorKey) {
+ fTokenMap.put(colorKey, new Token(createTextAttribute(colorKey, true)));
+ }
+
+ private void addToken(String colorKey) {
+ if (fColorManager != null && colorKey != null && fColorManager.getColor(colorKey) == null) {
+ RGB rgb= PreferenceConverter.getColor(fPreferenceStore, colorKey);
+ if (fColorManager instanceof IColorManagerExtension) {
+ IColorManagerExtension ext= (IColorManagerExtension) fColorManager;
+ ext.unbindColor(colorKey);
+ ext.bindColor(colorKey, rgb);
+ }
+ }
+
+ if (!fNeedsLazyColorLoading)
+ fTokenMap.put(colorKey, new Token(createTextAttribute(colorKey, false)));
+ else {
+ Token token= ((Token)fTokenMap.get(colorKey));
+ if (token != null)
+ token.setData(createTextAttribute(colorKey, false));
+ }
+ }
+
+ /**
+ * Create a text attribute based on the given color, bold, italic, strikethrough and underline preference keys.
+ *
+ * @param colorKey the color preference key
+ * @param boldKey the bold preference key
+ * @param italicKey the italic preference key
+ * @param strikethroughKey the strikethrough preference key
+ * @param underlineKey the italic preference key
+ * @return the created text attribute
+ * @since 3.0
+ */
+ private TextAttribute createTextAttribute(String colorKey, boolean isNull) {
+ Color color= null;
+ if (!isNull)
+ color= fColorManager.getColor(colorKey);
+
+ String boldKey= colorKey + PreferenceConstants.EDITOR_BOLD_SUFFIX;
+ String italicKey= colorKey + PreferenceConstants.EDITOR_ITALIC_SUFFIX;
+ String strikethroughKey= colorKey + PreferenceConstants.EDITOR_STRIKETHROUGH_SUFFIX;
+ String underlineKey= colorKey + PreferenceConstants.EDITOR_UNDERLINE_SUFFIX;
+
+ int style= fPreferenceStore.getBoolean(boldKey) ? SWT.BOLD : SWT.NORMAL;
+ if (fPreferenceStore.getBoolean(italicKey))
+ style |= SWT.ITALIC;
+
+ if (fPreferenceStore.getBoolean(strikethroughKey))
+ style |= TextAttribute.STRIKETHROUGH;
+
+ if (fPreferenceStore.getBoolean(underlineKey))
+ style |= TextAttribute.UNDERLINE;
+
+ return new TextAttribute(color, null, style);
+ }
+
+ /*
+ * (non-Javadoc)
+ * @see org.eclipse.cdt.ui.text.ITokenStore#getToken(java.lang.String)
+ */
+ public IToken getToken(String key) {
+ return getTokenInner(key);
+ }
+
+ private Token getTokenInner(String key) {
+ ensureTokensInitialised();
+ return (Token) fTokenMap.get(key);
+ }
+
+ private int indexOf(String property) {
+ if (property != null) {
+ int length= fPropertyNamesColor.length;
+ for (int i= 0; i < length; i++) {
+ if (property.startsWith(fPropertyNamesColor[i])) {
+ int pLength= property.length();
+ if(fPropertyNamesColor[i].length() < pLength) {
+ String end= property.substring(fPropertyNamesColor[i].length());
+ if (end.equals(PreferenceConstants.EDITOR_BOLD_SUFFIX)
+ || end.equals(PreferenceConstants.EDITOR_ITALIC_SUFFIX)
+ || end.equals(PreferenceConstants.EDITOR_STRIKETHROUGH_SUFFIX)
+ || end.equals(PreferenceConstants.EDITOR_UNDERLINE_SUFFIX)) {
+ return i;
+ }
+ } else if (fPropertyNamesColor[i].equals(property)) {
+ return i;
+ }
+ }
+ }
+ }
+ return -1;
+ }
+
+ /*
+ * (non-Javadoc)
+ * @see org.eclipse.cdt.ui.IPropertyChangeParticipant#affectsBehavior(org.eclipse.jface.util.PropertyChangeEvent)
+ */
+ public boolean affectsBehavior(PropertyChangeEvent event) {
+ return indexOf(event.getProperty()) >= 0;
+ }
+
+ /*
+ * (non-Javadoc)
+ * @see org.eclipse.cdt.ui.IPropertyChangeParticipant#adaptToPreferenceChange(org.eclipse.jface.util.PropertyChangeEvent)
+ */
+ public void adaptToPreferenceChange(PropertyChangeEvent event) {
+ String property= event.getProperty();
+ int i= indexOf(property);
+ if (property.startsWith(fPropertyNamesColor[i])) {
+ Token token= getTokenInner(fPropertyNamesColor[i]);
+ if(property.length() == fPropertyNamesColor[i].length()) {
+ adaptToColorChange(token, event);
+ } else {
+ String end= property.substring(fPropertyNamesColor[i].length());
+ if (end.equals(PreferenceConstants.EDITOR_BOLD_SUFFIX)) {
+ adaptToStyleChange(token, event, SWT.BOLD);
+ } else if (end.equals(PreferenceConstants.EDITOR_ITALIC_SUFFIX)) {
+ adaptToStyleChange(token, event, SWT.ITALIC);
+ } else if (end.equals(PreferenceConstants.EDITOR_STRIKETHROUGH_SUFFIX)) {
+ adaptToStyleChange(token, event, TextAttribute.STRIKETHROUGH);
+ } else if (end.equals(PreferenceConstants.EDITOR_UNDERLINE_SUFFIX)) {
+ adaptToStyleChange(token, event, TextAttribute.UNDERLINE);
+ }
+ }
+ }
+ }
+
+ private void adaptToColorChange(Token token, PropertyChangeEvent event) {
+ RGB rgb= null;
+
+ Object value= event.getNewValue();
+ if (value instanceof RGB)
+ rgb= (RGB) value;
+ else if (value instanceof String)
+ rgb= StringConverter.asRGB((String) value);
+
+ if (rgb != null) {
+
+ String property= event.getProperty();
+ Color color= fColorManager.getColor(property);
+
+ if ((color == null || !rgb.equals(color.getRGB())) && fColorManager instanceof IColorManagerExtension) {
+ IColorManagerExtension ext= (IColorManagerExtension) fColorManager;
+
+ ext.unbindColor(property);
+ ext.bindColor(property, rgb);
+
+ color= fColorManager.getColor(property);
+ }
+
+ Object data= token.getData();
+ if (data instanceof TextAttribute) {
+ TextAttribute oldAttr= (TextAttribute) data;
+ token.setData(new TextAttribute(color, oldAttr.getBackground(), oldAttr.getStyle()));
+ }
+ }
+ }
+
+ private void adaptToStyleChange(Token token, PropertyChangeEvent event, int styleAttribute) {
+ boolean eventValue= false;
+ Object value= event.getNewValue();
+ if (value instanceof Boolean)
+ eventValue= ((Boolean) value).booleanValue();
+ else if (IPreferenceStore.TRUE.equals(value))
+ eventValue= true;
+
+ Object data= token.getData();
+ if (data instanceof TextAttribute) {
+ TextAttribute oldAttr= (TextAttribute) data;
+ boolean activeValue= (oldAttr.getStyle() & styleAttribute) == styleAttribute;
+ if (activeValue != eventValue)
+ token.setData(new TextAttribute(oldAttr.getForeground(), oldAttr.getBackground(), eventValue ? oldAttr.getStyle() | styleAttribute : oldAttr.getStyle() & ~styleAttribute));
+ }
+ }
+
+ /**
+ * Returns the preference store.
+ *
+ * @return the preference store.
+ *
+ * @since 3.0
+ */
+ public IPreferenceStore getPreferenceStore() {
+ return fPreferenceStore;
+ }
+}
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/doctools/AbstractDocCommentProposalComputer.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/doctools/AbstractDocCommentProposalComputer.java
new file mode 100644
index 00000000000..60fe0c0cc90
--- /dev/null
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/doctools/AbstractDocCommentProposalComputer.java
@@ -0,0 +1,88 @@
+/*******************************************************************************
+ * Copyright (c) 2008 Symbian Software Systems 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:
+ * Andrew Ferguson (Symbian) - Initial implementation
+ *******************************************************************************/
+package org.eclipse.cdt.internal.ui.text.doctools;
+
+import java.util.List;
+
+import org.eclipse.core.resources.IResource;
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.ui.IEditorPart;
+import org.eclipse.ui.IWorkbenchPage;
+import org.eclipse.ui.IWorkbenchWindow;
+import org.eclipse.ui.PlatformUI;
+
+import org.eclipse.cdt.core.model.ITranslationUnit;
+import org.eclipse.cdt.ui.CUIPlugin;
+import org.eclipse.cdt.ui.IWorkingCopyManager;
+import org.eclipse.cdt.ui.text.contentassist.ContentAssistInvocationContext;
+import org.eclipse.cdt.ui.text.contentassist.ICompletionProposalComputer;
+import org.eclipse.cdt.ui.text.doctools.IDocCommentOwner;
+import org.eclipse.cdt.ui.text.doctools.IDocCommentViewerConfiguration;
+
+
+abstract class AbstractDocCommentProposalComputer implements ICompletionProposalComputer {
+
+ protected abstract IDocCommentViewerConfiguration getConfiguration(IDocCommentOwner owner);
+
+ protected final IDocCommentViewerConfiguration getConfiguration() {
+ IResource resource= getResource();
+ IDocCommentOwner owner= DocCommentOwnerManager.getInstance().getCommentOwner(resource);
+ return getConfiguration(owner);
+ }
+
+ public List computeCompletionProposals(ContentAssistInvocationContext context, IProgressMonitor monitor) {
+ return getConfiguration().createProposalComputer().computeCompletionProposals(context, monitor);
+ }
+
+ public List computeContextInformation(
+ ContentAssistInvocationContext context, IProgressMonitor monitor) {
+ return getConfiguration().createProposalComputer().computeContextInformation(context, monitor);
+ }
+
+ public String getErrorMessage() {
+ return getConfiguration().createProposalComputer().getErrorMessage();
+ }
+
+ public void sessionEnded() {
+ // XXX
+ }
+
+ public void sessionStarted() {
+ // XXX
+ }
+
+
+ private static IResource getResource() {
+ ITranslationUnit tu= getTranslationUnit();
+ return tu.getResource();
+ }
+
+ private static ITranslationUnit getTranslationUnit() {
+ IWorkbenchWindow window= PlatformUI.getWorkbench().getActiveWorkbenchWindow();
+ if (window == null)
+ return null;
+
+ IWorkbenchPage page= window.getActivePage();
+ if (page == null)
+ return null;
+
+ IEditorPart editor= page.getActiveEditor();
+ if (editor == null)
+ return null;
+
+ IWorkingCopyManager manager= CUIPlugin.getDefault().getWorkingCopyManager();
+ ITranslationUnit unit= manager.getWorkingCopy(editor.getEditorInput());
+ if (unit == null)
+ return null;
+
+ return unit;
+ }
+}
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/doctools/DocCommentMultilineProposalComputer.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/doctools/DocCommentMultilineProposalComputer.java
new file mode 100644
index 00000000000..17cc0dfc67e
--- /dev/null
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/doctools/DocCommentMultilineProposalComputer.java
@@ -0,0 +1,20 @@
+/*******************************************************************************
+ * Copyright (c) 2008 Symbian Software Systems 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:
+ * Andrew Ferguson (Symbian) - Initial implementation
+ *******************************************************************************/
+package org.eclipse.cdt.internal.ui.text.doctools;
+
+import org.eclipse.cdt.ui.text.doctools.IDocCommentOwner;
+import org.eclipse.cdt.ui.text.doctools.IDocCommentViewerConfiguration;
+
+public class DocCommentMultilineProposalComputer extends AbstractDocCommentProposalComputer {
+ protected IDocCommentViewerConfiguration getConfiguration(IDocCommentOwner owner) {
+ return owner.getMultilineConfiguration();
+ }
+}
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/doctools/DocCommentOwner.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/doctools/DocCommentOwner.java
new file mode 100644
index 00000000000..1369c23e672
--- /dev/null
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/doctools/DocCommentOwner.java
@@ -0,0 +1,61 @@
+/*******************************************************************************
+ * Copyright (c) 2008 Symbian Software Systems 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:
+ * Andrew Ferguson (Symbian) - Initial implementation
+ *******************************************************************************/
+package org.eclipse.cdt.internal.ui.text.doctools;
+
+import org.eclipse.core.runtime.Assert;
+
+import org.eclipse.cdt.ui.text.doctools.IDocCommentOwner;
+import org.eclipse.cdt.ui.text.doctools.IDocCommentViewerConfiguration;
+
+/**
+ * Internal implementation of IDocCommentOwner
+ */
+public class DocCommentOwner implements IDocCommentOwner {
+ private final String id;
+ private final String name;
+ private final IDocCommentViewerConfiguration multi, single;
+
+ public DocCommentOwner(String id, String name, IDocCommentViewerConfiguration multi, IDocCommentViewerConfiguration single) {
+ Assert.isNotNull(id); Assert.isNotNull(name); Assert.isNotNull(multi); Assert.isNotNull(single);
+ this.id= id;
+ this.name= name;
+ this.multi= multi;
+ this.single= single;
+ }
+
+ /*
+ * @see org.eclipse.cdt.ui.text.ICCommentOwner#getID()
+ */
+ public String getID() {
+ return id;
+ }
+
+ /*
+ * @see org.eclipse.cdt.ui.text.ICCommentOwner#getName()
+ */
+ public String getName() {
+ return name;
+ }
+
+ /*
+ * @see org.eclipse.cdt.ui.text.ICCommentOwner#getMultilineConfiguration()
+ */
+ public IDocCommentViewerConfiguration getMultilineConfiguration() {
+ return multi;
+ }
+
+ /*
+ * @see org.eclipse.cdt.ui.text.ICCommentOwner#getSinglelineConfiguration()
+ */
+ public IDocCommentViewerConfiguration getSinglelineConfiguration() {
+ return single;
+ }
+}
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/doctools/DocCommentOwnerManager.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/doctools/DocCommentOwnerManager.java
new file mode 100644
index 00000000000..f4c90c2c792
--- /dev/null
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/text/doctools/DocCommentOwnerManager.java
@@ -0,0 +1,257 @@
+/*******************************************************************************
+ * Copyright (c) 2008 Symbian Software Systems 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:
+ * Andrew Ferguson (Symbian) - Initial implementation
+ *******************************************************************************/
+package org.eclipse.cdt.internal.ui.text.doctools;
+
+import java.text.MessageFormat;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+
+import org.eclipse.core.resources.IContainer;
+import org.eclipse.core.resources.IProject;
+import org.eclipse.core.resources.IResource;
+import org.eclipse.core.resources.ResourcesPlugin;
+import org.eclipse.core.runtime.Assert;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IConfigurationElement;
+import org.eclipse.core.runtime.IExtension;
+import org.eclipse.core.runtime.IExtensionPoint;
+import org.eclipse.core.runtime.IExtensionRegistry;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.Platform;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.core.runtime.preferences.InstanceScope;
+import org.osgi.service.prefs.Preferences;
+
+import org.eclipse.cdt.core.CCorePlugin;
+import org.eclipse.cdt.ui.CUIPlugin;
+import org.eclipse.cdt.ui.text.doctools.IDocCommentOwner;
+import org.eclipse.cdt.ui.text.doctools.IDocCommentOwnershipListener;
+import org.eclipse.cdt.ui.text.doctools.IDocCommentViewerConfiguration;
+
+/**
+ * This class manages which IDocCommentOwner's are available in the run-time, and how they map to resources
+ * in projects.
+ * @since 5.0
+ */
+public class DocCommentOwnerManager {
+ /** Constants for attributes/elements from the DocCommentOwner extension point */
+ private static final String ELEMENT_OWNER = "owner"; //$NON-NLS-1$
+ private static final String ATTRKEY_OWNER_ID = "id"; //$NON-NLS-1$
+ private static final String ATTRKEY_OWNER_NAME = "name"; //$NON-NLS-1$
+ private static final String ATTRKEY_OWNER_SINGLELINE = "singleline"; //$NON-NLS-1$
+ private static final String ATTRKEY_OWNER_MULTILINE = "multiline"; //$NON-NLS-1$
+
+ private static final String QUALIFIER= CCorePlugin.PLUGIN_ID;
+ private static final String WORKSPACE_DOC_TOOL_NODE= "doctool"; //$NON-NLS-1$
+ private static final String PREFKEY_WORKSPACE_DEFAULT= "workspace.default"; //$NON-NLS-1$
+
+ private static DocCommentOwnerManager singleton;
+
+ public static DocCommentOwnerManager getInstance() {
+ return singleton==null ? singleton= new DocCommentOwnerManager() : singleton;
+ }
+
+ private Map fOwners;
+ private IDocCommentOwner fWorkspaceOwner;
+ private Map prj2map= new HashMap();
+ private static List fListeners;
+
+ private DocCommentOwnerManager() {
+ fOwners= getCommentOwnerExtensions();
+ fListeners= new ArrayList();
+
+ Preferences prefs= new InstanceScope().getNode(QUALIFIER).node(WORKSPACE_DOC_TOOL_NODE);
+ String id= prefs.get(PREFKEY_WORKSPACE_DEFAULT, NullDocCommentOwner.INSTANCE.getID());
+ fWorkspaceOwner= getOwner(id);
+ if(fWorkspaceOwner == null) {
+ // this could occur if a plug-in is no longer available
+ fWorkspaceOwner= NullDocCommentOwner.INSTANCE;
+ }
+ }
+
+ /**
+ * @param project a non-null project
+ * @return whether the specified project defines any documentation owner association
+ */
+ public boolean projectDefinesOwnership(IProject project) {
+ return !getProjectMap(project).isEmpty();
+ }
+
+ /**
+ * @param owner the non-null doc-comment owner
+ */
+ public void setWorkspaceCommentOwner(IDocCommentOwner owner) {
+ if(owner == null)
+ throw new IllegalArgumentException();
+ IDocCommentOwner old= fWorkspaceOwner;
+ fWorkspaceOwner= owner;
+
+ Preferences prefs= new InstanceScope().getNode(QUALIFIER).node(WORKSPACE_DOC_TOOL_NODE);
+ prefs.put(PREFKEY_WORKSPACE_DEFAULT, owner.getID());
+
+ fireWorkspaceOwnershipChanged(old, fWorkspaceOwner);
+ }
+
+ /**
+ * @return the doc comment owner associated with the workspace. If non
+ * is set, the {@link NullDocCommentOwner} is returned.
+ */
+ public IDocCommentOwner getWorkspaceCommentOwner() {
+ return fWorkspaceOwner;
+ }
+
+ /**
+ *
+ * @param resource May be null.
+ * @return a non-null IDocCommentOwner. If the resource was null, the {@link NullDocCommentOwner} is returned.
+ */
+ public IDocCommentOwner getCommentOwner(IResource resource) {
+ if(resource==null)
+ return NullDocCommentOwner.INSTANCE;
+
+ if(ResourcesPlugin.getWorkspace().getRoot().equals(resource))
+ return getWorkspaceCommentOwner();
+
+ ProjectMap pm= getProjectMap(resource);
+ String ownerID= pm.getOwnerID(resource);
+ IDocCommentOwner result= getOwner(ownerID);
+ return result == null ? fWorkspaceOwner : result;
+ }
+
+ /**
+ * @param id
+ * @return the {@link IDocCommentOwner} with the specified id, or null
+ */
+ public IDocCommentOwner getOwner(String id) {
+ if(NullDocCommentOwner.INSTANCE.getID().equals(id)) {
+ return NullDocCommentOwner.INSTANCE;
+ }
+ return fOwners.get(id);
+ }
+
+ /**
+ * @param resource a non-null resource to map a comment owner to
+ * @param owner the new owner to assign, or null to inherit the parent's mapping
+ * @param removeSubMappings if the resource is an {@link IContainer}, then remove any mappings
+ * children have. This is currently unimplemented.
+ */
+ /*
+ * Note - this implementation currently ignores removeSubMappings.
+ */
+ public void setCommentOwner(IResource resource, IDocCommentOwner owner, boolean removeSubMappings) {
+ Assert.isNotNull(resource);
+
+ if(ResourcesPlugin.getWorkspace().getRoot().equals(resource)) {
+ setWorkspaceCommentOwner(owner);
+ return;
+ }
+
+ ProjectMap pm= getProjectMap(resource);
+ IDocCommentOwner old= getCommentOwner(resource);
+ pm.setCommentOwner(resource, owner);
+ IDocCommentOwner n3w= getCommentOwner(resource);
+ fireOwnershipChanged(resource, removeSubMappings, old, n3w);
+ }
+
+ /**
+ * @return any comment owners registered against the extension point. This does not include
+ * the null comment processor.
+ */
+ public IDocCommentOwner[] getRegisteredOwners() {
+ return fOwners.values().toArray(new IDocCommentOwner[fOwners.values().size()]);
+ }
+
+
+ /**
+ * @param listener registers a listener for doc-comment ownership events
+ */
+ public void addListener(IDocCommentOwnershipListener listener) {
+ if(!fListeners.contains(listener)) {
+ fListeners.add(listener);
+ }
+ }
+
+ /**
+ * @param listener removes a listener from those registered for doc-comment ownership events
+ */
+ public void removeListener(IDocCommentOwnershipListener listener) {
+ fListeners.add(listener);
+ }
+
+ /*
+ * Utilities
+ */
+
+ /**
+ * @param resource a non-null resource
+ * @return the cached (or newly obtained) ProjectMap for the resources
+ * associated project.
+ */
+ private ProjectMap getProjectMap(IResource resource) {
+ Assert.isNotNull(resource);
+ IProject project= resource.getProject();
+
+ if(!prj2map.containsKey(project)) {
+ prj2map.put(project, new ProjectMap(project));
+ }
+
+ return prj2map.get(project);
+ }
+
+ /**
+ * @return a map of ID to {@link IDocCommentOwner} for comment owners registered
+ * via the DocCommentOwner extension point
+ */
+ private static Map getCommentOwnerExtensions() {
+ Map result= new HashMap();
+
+ IExtensionRegistry registry = Platform.getExtensionRegistry();
+ IExtensionPoint indexProviders = registry.getExtensionPoint(CUIPlugin.ID_COMMENT_OWNER);
+ IExtension[] extensions = indexProviders.getExtensions();
+ for(int i=0; i needReopening= new ArrayList();
+ if(window.getActivePage()!=null) {
+ IEditorReference[] es= window.getActivePage().getEditorReferences();
+ for(int i=0; i