blob: b64edc9031127f7b6e0d11fc984754ea8b0618b6 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2004 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
*******************************************************************************/
package org.eclipse.wst.html.ui.internal.provisional;
import java.util.ArrayList;
import java.util.List;
import java.util.Vector;
import org.eclipse.core.runtime.Preferences;
import org.eclipse.jface.text.DefaultInformationControl;
import org.eclipse.jface.text.IAutoEditStrategy;
import org.eclipse.jface.text.IInformationControl;
import org.eclipse.jface.text.IInformationControlCreator;
import org.eclipse.jface.text.ITextDoubleClickStrategy;
import org.eclipse.jface.text.ITextHover;
import org.eclipse.jface.text.contentassist.ContentAssistant;
import org.eclipse.jface.text.contentassist.IContentAssistProcessor;
import org.eclipse.jface.text.contentassist.IContentAssistant;
import org.eclipse.jface.text.formatter.IContentFormatter;
import org.eclipse.jface.text.formatter.MultiPassContentFormatter;
import org.eclipse.jface.text.hyperlink.IHyperlinkDetector;
import org.eclipse.jface.text.information.IInformationPresenter;
import org.eclipse.jface.text.information.IInformationProvider;
import org.eclipse.jface.text.information.InformationPresenter;
import org.eclipse.jface.text.reconciler.IReconciler;
import org.eclipse.jface.text.reconciler.IReconcilingStrategy;
import org.eclipse.jface.text.source.ISourceViewer;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants;
import org.eclipse.wst.css.core.internal.provisional.text.ICSSPartitionTypes;
import org.eclipse.wst.css.ui.internal.contentassist.CSSContentAssistProcessor;
import org.eclipse.wst.css.ui.internal.style.LineStyleProviderForEmbeddedCSS;
import org.eclipse.wst.html.core.internal.HTMLCorePlugin;
import org.eclipse.wst.html.core.internal.format.HTMLFormatProcessorImpl;
import org.eclipse.wst.html.core.internal.preferences.HTMLCorePreferenceNames;
import org.eclipse.wst.html.core.internal.provisional.text.IHTMLPartitionTypes;
import org.eclipse.wst.html.core.internal.text.StructuredTextPartitionerForHTML;
import org.eclipse.wst.html.ui.internal.autoedit.AutoEditStrategyForTabs;
import org.eclipse.wst.html.ui.internal.autoedit.StructuredAutoEditStrategyHTML;
import org.eclipse.wst.html.ui.internal.contentassist.HTMLContentAssistProcessor;
import org.eclipse.wst.html.ui.internal.contentassist.NoRegionContentAssistProcessorForHTML;
import org.eclipse.wst.html.ui.internal.derived.HTMLTextPresenter;
import org.eclipse.wst.html.ui.internal.hyperlink.XMLHyperlinkDetector;
import org.eclipse.wst.html.ui.internal.style.LineStyleProviderForHTML;
import org.eclipse.wst.html.ui.internal.taginfo.HTMLInformationProvider;
import org.eclipse.wst.html.ui.internal.taginfo.HTMLTagInfoHoverProcessor;
import org.eclipse.wst.javascript.ui.internal.common.contentassist.JavaScriptContentAssistProcessor;
import org.eclipse.wst.javascript.ui.internal.common.style.LineStyleProviderForJavaScript;
import org.eclipse.wst.javascript.ui.internal.common.taginfo.JavaScriptInformationProvider;
import org.eclipse.wst.javascript.ui.internal.common.taginfo.JavaScriptTagInfoHoverProcessor;
import org.eclipse.wst.sse.core.internal.provisional.text.IStructuredPartitionTypes;
import org.eclipse.wst.sse.ui.StructuredTextViewerConfiguration;
import org.eclipse.wst.sse.ui.internal.SSEUIPlugin;
import org.eclipse.wst.sse.ui.internal.format.StructuredFormattingStrategy;
import org.eclipse.wst.sse.ui.internal.provisional.preferences.CommonEditorPreferenceNames;
import org.eclipse.wst.sse.ui.internal.provisional.style.LineStyleProvider;
import org.eclipse.wst.sse.ui.internal.reconcile.StructuredRegionProcessor;
import org.eclipse.wst.sse.ui.internal.taginfo.TextHoverManager;
import org.eclipse.wst.sse.ui.internal.util.EditorUtility;
import org.eclipse.wst.xml.core.internal.provisional.text.IXMLPartitions;
import org.eclipse.wst.xml.core.internal.text.rules.StructuredTextPartitionerForXML;
import org.eclipse.wst.xml.ui.StructuredTextViewerConfigurationXML;
import org.eclipse.wst.xml.ui.internal.validation.StructuredTextReconcilingStrategyForMarkup;
public class StructuredTextViewerConfigurationHTML extends StructuredTextViewerConfiguration {
/*
* One instance per configuration because not sourceviewer-specific and
* it's a String array
*/
private String[] fConfiguredContentTypes;
/*
* One instance per configuration
*/
private LineStyleProvider fLineStyleProviderForEmbeddedCSS;
/*
* One instance per configuration
*/
private LineStyleProvider fLineStyleProviderForHTML;
/*
* One instance per configuration
*/
private LineStyleProvider fLineStyleProviderForJavascript;
/*
* One instance per configuration
*/
private IReconciler fReconciler;
/*
* One instance per configuration
*/
private StructuredTextViewerConfiguration fXMLSourceViewerConfiguration;
public IAutoEditStrategy[] getAutoEditStrategies(ISourceViewer sourceViewer, String contentType) {
List allStrategies = new ArrayList(0);
IAutoEditStrategy[] superStrategies = super.getAutoEditStrategies(sourceViewer, contentType);
for (int i = 0; i < superStrategies.length; i++) {
allStrategies.add(superStrategies[i]);
}
if (contentType == IHTMLPartitionTypes.HTML_DEFAULT || contentType == IHTMLPartitionTypes.HTML_DECLARATION) {
allStrategies.add(new StructuredAutoEditStrategyHTML());
}
// be sure this is added last in list, so it has a change to modify
// previous results.
// add auto edit strategy that handles when tab key is pressed
allStrategies.add(new AutoEditStrategyForTabs());
return (IAutoEditStrategy[]) allStrategies.toArray(new IAutoEditStrategy[allStrategies.size()]);
}
public String[] getConfiguredContentTypes(ISourceViewer sourceViewer) {
if (fConfiguredContentTypes == null) {
String[] xmlTypes = StructuredTextPartitionerForXML.getConfiguredContentTypes();
String[] htmlTypes = StructuredTextPartitionerForHTML.getConfiguredContentTypes();
fConfiguredContentTypes = new String[2 + xmlTypes.length + htmlTypes.length];
fConfiguredContentTypes[0] = IStructuredPartitionTypes.DEFAULT_PARTITION;
fConfiguredContentTypes[1] = IStructuredPartitionTypes.UNKNOWN_PARTITION;
int index = 0;
System.arraycopy(xmlTypes, 0, fConfiguredContentTypes, index += 2, xmlTypes.length);
System.arraycopy(htmlTypes, 0, fConfiguredContentTypes, index += xmlTypes.length, htmlTypes.length);
}
return fConfiguredContentTypes;
}
/**
* Returns the content assistant ready to be used with the given source
* viewer.
*
* @param sourceViewer
* the source viewer to be configured by this configuration
* @return a content assistant or <code>null</code> if content assist
* should not be supported
*/
public IContentAssistant getContentAssistant(ISourceViewer sourceViewer) {
ContentAssistant assistant = (ContentAssistant) super.getContentAssistant(sourceViewer);
// create content assist processors to be used
IContentAssistProcessor htmlContentAssistProcessor = new HTMLContentAssistProcessor();
IContentAssistProcessor jsContentAssistProcessor = new JavaScriptContentAssistProcessor();
IContentAssistProcessor cssContentAssistProcessor = new CSSContentAssistProcessor();
IContentAssistProcessor noRegionProcessorForHTML = new NoRegionContentAssistProcessorForHTML();
// add processors to content assistant
// HTML
assistant.setContentAssistProcessor(htmlContentAssistProcessor, IHTMLPartitionTypes.HTML_DEFAULT);
assistant.setContentAssistProcessor(htmlContentAssistProcessor, IHTMLPartitionTypes.HTML_COMMENT);
// JavaScript
assistant.setContentAssistProcessor(jsContentAssistProcessor, IHTMLPartitionTypes.SCRIPT);
// CSS
assistant.setContentAssistProcessor(cssContentAssistProcessor, ICSSPartitionTypes.STYLE);
// unknown
assistant.setContentAssistProcessor(noRegionProcessorForHTML, IStructuredPartitionTypes.UNKNOWN_PARTITION);
return assistant;
}
/**
* Returns the content formatter ready to be used with the given source
* viewer.
*
* @param sourceViewer
* the source viewer to be configured by this configuration
* @return a content formatter or <code>null</code> if formatting should
* not be supported
*/
public IContentFormatter getContentFormatter(ISourceViewer sourceViewer) {
final MultiPassContentFormatter formatter = new MultiPassContentFormatter(getConfiguredDocumentPartitioning(sourceViewer), IHTMLPartitionTypes.HTML_DEFAULT);
formatter.setMasterStrategy(new StructuredFormattingStrategy(new HTMLFormatProcessorImpl()));
return formatter;
}
public ITextDoubleClickStrategy getDoubleClickStrategy(ISourceViewer sourceViewer, String contentType) {
if (contentType == IHTMLPartitionTypes.HTML_DEFAULT) {
// use xml's doubleclick strategy
return getXMLSourceViewerConfiguration().getDoubleClickStrategy(sourceViewer, IXMLPartitions.XML_DEFAULT);
}
else
return super.getDoubleClickStrategy(sourceViewer, contentType);
}
/*
* (non-Javadoc)
*
* @see org.eclipse.ui.editors.text.TextSourceViewerConfiguration#getHyperlinkDetectors(org.eclipse.jface.text.source.ISourceViewer)
*/
public IHyperlinkDetector[] getHyperlinkDetectors(ISourceViewer sourceViewer) {
if (sourceViewer == null || !fPreferenceStore.getBoolean(AbstractDecoratedTextEditorPreferenceConstants.EDITOR_HYPERLINKS_ENABLED))
return null;
List allDetectors = new ArrayList(0);
allDetectors.add(new XMLHyperlinkDetector());
IHyperlinkDetector[] superDetectors = super.getHyperlinkDetectors(sourceViewer);
for (int m = 0; m < superDetectors.length; m++) {
IHyperlinkDetector detector = superDetectors[m];
if (!allDetectors.contains(detector)) {
allDetectors.add(detector);
}
}
return (IHyperlinkDetector[]) allDetectors.toArray(new IHyperlinkDetector[0]);
}
public String[] getIndentPrefixes(ISourceViewer sourceViewer, String contentType) {
Vector vector = new Vector();
// prefix[0] is either '\t' or ' ' x tabWidth, depending on preference
Preferences preferences = HTMLCorePlugin.getDefault().getPluginPreferences();
int indentationWidth = preferences.getInt(HTMLCorePreferenceNames.INDENTATION_SIZE);
String indentCharPref = preferences.getString(HTMLCorePreferenceNames.INDENTATION_CHAR);
boolean useSpaces = HTMLCorePreferenceNames.SPACE.equals(indentCharPref);
for (int i = 0; i <= indentationWidth; i++) {
StringBuffer prefix = new StringBuffer();
boolean appendTab = false;
if (useSpaces) {
for (int j = 0; j + i < indentationWidth; j++)
prefix.append(' ');
if (i != 0)
appendTab = true;
}
else {
for (int j = 0; j < i; j++)
prefix.append(' ');
if (i != indentationWidth)
appendTab = true;
}
if (appendTab) {
prefix.append('\t');
vector.add(prefix.toString());
// remove the tab so that indentation - tab is also an indent
// prefix
prefix.deleteCharAt(prefix.length() - 1);
}
vector.add(prefix.toString());
}
vector.add(""); //$NON-NLS-1$
return (String[]) vector.toArray(new String[vector.size()]);
}
/**
* Returns the information control creator. The creator is a factory
* creating information controls for the given source viewer.
*
* @param sourceViewer
* the source viewer to be configured by this configuration
* @return the information control creator or <code>null</code> if no
* information support should be installed
* @since 2.0
*/
public IInformationControlCreator getInformationControlCreator(ISourceViewer sourceViewer) {
// used by hover help
return new IInformationControlCreator() {
public IInformationControl createInformationControl(Shell parent) {
return new DefaultInformationControl(parent, SWT.NONE, new HTMLTextPresenter(false));
}
};
}
public IInformationPresenter getInformationPresenter(ISourceViewer sourceViewer) {
InformationPresenter presenter = new InformationPresenter(getInformationPresenterControlCreator(sourceViewer));
// information presenter configurations
presenter.setSizeConstraints(60, 10, true, true);
presenter.setDocumentPartitioning(getConfiguredDocumentPartitioning(sourceViewer));
// information providers to be used
IInformationProvider htmlInformationProvider = new HTMLInformationProvider();
IInformationProvider javascriptInformationProvider = new JavaScriptInformationProvider();
// add information providers to information presenter
// HTML
presenter.setInformationProvider(htmlInformationProvider, IHTMLPartitionTypes.HTML_DEFAULT);
// JavaScript
presenter.setInformationProvider(javascriptInformationProvider, IHTMLPartitionTypes.SCRIPT);
return presenter;
}
/**
* Returns the information presenter control creator. The creator is a
* factory creating the presenter controls for the given source viewer.
*
* @param sourceViewer
* the source viewer to be configured by this configuration
* @return an information control creator
*/
private IInformationControlCreator getInformationPresenterControlCreator(ISourceViewer sourceViewer) {
return new IInformationControlCreator() {
public IInformationControl createInformationControl(Shell parent) {
int shellStyle = SWT.RESIZE | SWT.TOOL;
int style = SWT.V_SCROLL | SWT.H_SCROLL;
return new DefaultInformationControl(parent, shellStyle, style, new HTMLTextPresenter(false));
}
};
}
public LineStyleProvider[] getLineStyleProviders(ISourceViewer sourceViewer, String partitionType) {
LineStyleProvider[] providers = null;
if (partitionType == IHTMLPartitionTypes.HTML_DEFAULT || partitionType == IHTMLPartitionTypes.HTML_COMMENT || partitionType == IHTMLPartitionTypes.HTML_DECLARATION) {
providers = new LineStyleProvider[]{getLineStyleProviderForHTML()};
}
else if (partitionType == IHTMLPartitionTypes.SCRIPT) {
providers = new LineStyleProvider[]{getLineStyleProviderForJavascript()};
}
else if (partitionType == ICSSPartitionTypes.STYLE) {
providers = new LineStyleProvider[]{getLineStyleProviderForEmbeddedCSS()};
}
return providers;
}
private LineStyleProvider getLineStyleProviderForEmbeddedCSS() {
if (fLineStyleProviderForEmbeddedCSS == null) {
fLineStyleProviderForEmbeddedCSS = new LineStyleProviderForEmbeddedCSS();
}
return fLineStyleProviderForEmbeddedCSS;
}
private LineStyleProvider getLineStyleProviderForHTML() {
if (fLineStyleProviderForHTML == null) {
fLineStyleProviderForHTML = new LineStyleProviderForHTML();
}
return fLineStyleProviderForHTML;
}
private LineStyleProvider getLineStyleProviderForJavascript() {
if (fLineStyleProviderForJavascript == null) {
fLineStyleProviderForJavascript = new LineStyleProviderForJavaScript();
}
return fLineStyleProviderForJavascript;
}
public IReconciler getReconciler(ISourceViewer sourceViewer) {
boolean reconcilingEnabled = fPreferenceStore.getBoolean(CommonEditorPreferenceNames.EVALUATE_TEMPORARY_PROBLEMS);
if (sourceViewer == null || !reconcilingEnabled)
return null;
/*
* Only create reconciler if sourceviewer is present
*/
if (fReconciler == null && sourceViewer != null) {
StructuredRegionProcessor reconciler = new StructuredRegionProcessor();
// reconciler configurations
reconciler.setDocumentPartitioning(getConfiguredDocumentPartitioning(sourceViewer));
// reconciling strategies for reconciler
IReconcilingStrategy markupStrategy = new StructuredTextReconcilingStrategyForMarkup(sourceViewer);
// add reconciling strategies
reconciler.setReconcilingStrategy(markupStrategy, IStructuredPartitionTypes.DEFAULT_PARTITION);
reconciler.setReconcilingStrategy(markupStrategy, IXMLPartitions.XML_DEFAULT);
reconciler.setDefaultStrategy(markupStrategy);
fReconciler = reconciler;
}
return fReconciler;
}
public ITextHover getTextHover(ISourceViewer sourceViewer, String contentType, int stateMask) {
ITextHover textHover = null;
// look for appropriate text hover processor to return based on
// content type and state mask
TextHoverManager manager = SSEUIPlugin.getDefault().getTextHoverManager();
TextHoverManager.TextHoverDescriptor[] hoverDescs = manager.getTextHovers();
int i = 0;
while (i < hoverDescs.length && textHover == null) {
if (hoverDescs[i].isEnabled() && EditorUtility.computeStateMask(hoverDescs[i].getModifierString()) == stateMask) {
String hoverType = hoverDescs[i].getId();
if (TextHoverManager.COMBINATION_HOVER.equalsIgnoreCase(hoverType)) {
// check if script or html is needed
if (contentType == IHTMLPartitionTypes.SCRIPT) {
textHover = manager.createBestMatchHover(new JavaScriptTagInfoHoverProcessor());
}
else if (contentType == IHTMLPartitionTypes.HTML_DEFAULT) {
textHover = manager.createBestMatchHover(new HTMLTagInfoHoverProcessor());
}
}
else if (TextHoverManager.DOCUMENTATION_HOVER.equalsIgnoreCase(hoverType))
// check if script or html is needed
if (contentType == IHTMLPartitionTypes.SCRIPT) {
textHover = new JavaScriptTagInfoHoverProcessor();
}
else if (contentType == IHTMLPartitionTypes.HTML_DEFAULT) {
textHover = new HTMLTagInfoHoverProcessor();
}
}
i++;
}
// no appropriate text hovers found, try super
if (textHover == null) {
textHover = super.getTextHover(sourceViewer, contentType, stateMask);
}
return textHover;
}
private StructuredTextViewerConfiguration getXMLSourceViewerConfiguration() {
if (fXMLSourceViewerConfiguration == null) {
fXMLSourceViewerConfiguration = new StructuredTextViewerConfigurationXML();
}
return fXMLSourceViewerConfiguration;
}
}