1 /**********************************************************************
2 Copyright (c) 2000, 2002 IBM Corp. and others.
3 All rights reserved. This program and the accompanying materials
4 are made available under the terms of the Common Public License v1.0
5 which accompanies this distribution, and is available at
6 http://www.eclipse.org/legal/cpl-v10.html
9 IBM Corporation - Initial implementation
11 **********************************************************************/
12 package net.sourceforge.phpdt.ui.text;
14 import java.util.Vector;
16 import net.sourceforge.phpdt.core.JavaCore;
17 import net.sourceforge.phpdt.internal.ui.text.AbstractJavaScanner;
18 import net.sourceforge.phpdt.internal.ui.text.ContentAssistPreference;
19 import net.sourceforge.phpdt.internal.ui.text.HTMLTextPresenter;
20 import net.sourceforge.phpdt.internal.ui.text.IPHPPartitions;
21 import net.sourceforge.phpdt.internal.ui.text.JavaAnnotationHover;
22 import net.sourceforge.phpdt.internal.ui.text.JavaCompositeReconcilingStrategy;
23 import net.sourceforge.phpdt.internal.ui.text.JavaElementProvider;
24 import net.sourceforge.phpdt.internal.ui.text.JavaOutlineInformationControl;
25 import net.sourceforge.phpdt.internal.ui.text.JavaPresentationReconciler;
26 import net.sourceforge.phpdt.internal.ui.text.JavaReconciler;
27 import net.sourceforge.phpdt.internal.ui.text.PreferencesAdapter;
28 import net.sourceforge.phpdt.internal.ui.text.java.JavaFormattingStrategy;
29 import net.sourceforge.phpdt.internal.ui.text.java.JavaStringAutoIndentStrategyDQ;
30 import net.sourceforge.phpdt.internal.ui.text.java.JavaStringAutoIndentStrategySQ;
31 import net.sourceforge.phpdt.internal.ui.text.java.hover.JavaEditorTextHoverDescriptor;
32 import net.sourceforge.phpdt.internal.ui.text.java.hover.JavaEditorTextHoverProxy;
33 import net.sourceforge.phpdt.internal.ui.text.java.hover.JavaInformationProvider;
34 import net.sourceforge.phpdt.internal.ui.text.phpdoc.JavaDocAutoIndentStrategy;
35 import net.sourceforge.phpdt.internal.ui.text.phpdoc.PHPDocCodeScanner;
36 import net.sourceforge.phpdt.internal.ui.text.phpdoc.PHPDocCompletionProcessor;
37 import net.sourceforge.phpdt.ui.PreferenceConstants;
38 import net.sourceforge.phpeclipse.IPreferenceConstants;
39 import net.sourceforge.phpeclipse.PHPeclipsePlugin;
40 import net.sourceforge.phpeclipse.phpeditor.php.HTMLCompletionProcessor;
41 import net.sourceforge.phpeclipse.phpeditor.php.PHPAutoIndentStrategy;
42 import net.sourceforge.phpeclipse.phpeditor.php.PHPCodeScanner;
43 import net.sourceforge.phpeclipse.phpeditor.php.PHPCompletionProcessor;
44 import net.sourceforge.phpeclipse.phpeditor.php.PHPDocumentPartitioner;
45 import net.sourceforge.phpeclipse.phpeditor.php.PHPDoubleClickSelector;
46 import net.sourceforge.phpeclipse.phpeditor.php.PHPPartitionScanner;
47 import net.sourceforge.phpeclipse.xml.ui.XMLPlugin;
48 import net.sourceforge.phpeclipse.xml.ui.internal.text.XMLConfiguration;
49 import net.sourceforge.phpeclipse.xml.ui.internal.text.XMLPartitionScanner;
50 import net.sourceforge.phpeclipse.xml.ui.text.XMLTextTools;
52 import org.eclipse.core.runtime.NullProgressMonitor;
53 import org.eclipse.jface.preference.IPreferenceStore;
54 import org.eclipse.jface.text.DefaultAutoIndentStrategy;
55 import org.eclipse.jface.text.DefaultInformationControl;
56 import org.eclipse.jface.text.IAutoIndentStrategy;
57 import org.eclipse.jface.text.IDocument;
58 import org.eclipse.jface.text.IInformationControl;
59 import org.eclipse.jface.text.IInformationControlCreator;
60 import org.eclipse.jface.text.ITextDoubleClickStrategy;
61 import org.eclipse.jface.text.ITextHover;
62 import org.eclipse.jface.text.ITextViewerExtension2;
63 import org.eclipse.jface.text.TextAttribute;
64 import org.eclipse.jface.text.contentassist.ContentAssistant;
65 import org.eclipse.jface.text.contentassist.IContentAssistProcessor;
66 import org.eclipse.jface.text.contentassist.IContentAssistant;
67 import org.eclipse.jface.text.formatter.ContentFormatter;
68 import org.eclipse.jface.text.formatter.IContentFormatter;
69 import org.eclipse.jface.text.formatter.IFormattingStrategy;
70 import org.eclipse.jface.text.information.IInformationPresenter;
71 import org.eclipse.jface.text.information.IInformationProvider;
72 import org.eclipse.jface.text.information.InformationPresenter;
73 import org.eclipse.jface.text.presentation.IPresentationDamager;
74 import org.eclipse.jface.text.presentation.IPresentationReconciler;
75 import org.eclipse.jface.text.presentation.IPresentationRepairer;
76 import org.eclipse.jface.text.presentation.PresentationReconciler;
77 import org.eclipse.jface.text.reconciler.IReconciler;
78 import org.eclipse.jface.text.rules.BufferedRuleBasedScanner;
79 import org.eclipse.jface.text.rules.DefaultDamagerRepairer;
80 import org.eclipse.jface.text.rules.DefaultPartitioner;
81 import org.eclipse.jface.text.rules.RuleBasedScanner;
82 import org.eclipse.jface.text.rules.Token;
83 import org.eclipse.jface.text.source.IAnnotationHover;
84 import org.eclipse.jface.text.source.ISourceViewer;
85 import org.eclipse.jface.text.source.SourceViewerConfiguration;
86 import org.eclipse.jface.util.Assert;
87 import org.eclipse.jface.util.PropertyChangeEvent;
88 import org.eclipse.swt.SWT;
89 import org.eclipse.swt.widgets.Shell;
90 import org.eclipse.ui.editors.text.EditorsUI;
91 import org.eclipse.ui.texteditor.ChainedPreferenceStore;
92 import org.eclipse.ui.texteditor.ITextEditor;
95 * Configuration for an <code>SourceViewer</code> which shows PHP code.
97 public class PHPSourceViewerConfiguration extends SourceViewerConfiguration {
99 * Preference key used to look up display tab width.
103 public final static String PREFERENCE_TAB_WIDTH = PreferenceConstants.EDITOR_TAB_WIDTH;
106 * Preference key for inserting spaces rather than tabs.
110 public final static String SPACES_FOR_TABS = PreferenceConstants.EDITOR_SPACES_FOR_TABS;
112 // public static final String HTML_DEFAULT =
113 // IPHPPartitionScannerConstants.HTML;
114 //IDocument.DEFAULT_CONTENT_TYPE;
115 // private JavaTextTools fJavaTextTools;
117 private ITextEditor fTextEditor;
120 * The document partitioning.
124 private String fDocumentPartitioning;
126 private ContentFormatter fFormatter;
129 * Single token scanner.
131 static class SingleTokenScanner extends BufferedRuleBasedScanner {
132 public SingleTokenScanner(TextAttribute attribute) {
133 setDefaultReturnToken(new Token(attribute));
138 * The document partitioning.
142 // private String fDocumentPartitioning;
144 * The Java source code scanner
148 private AbstractJavaScanner fCodeScanner;
151 * The Java multi-line comment scanner
155 private AbstractJavaScanner fMultilineCommentScanner;
158 * The Java single-line comment scanner
162 private AbstractJavaScanner fSinglelineCommentScanner;
165 * The PHP double quoted string scanner
167 private AbstractJavaScanner fStringDQScanner;
169 * The PHP single quoted string scanner
171 private AbstractJavaScanner fStringSQScanner;
174 * The Javadoc scanner
178 private AbstractJavaScanner fJavaDocScanner;
181 * The preference store, can be read-only
185 private IPreferenceStore fPreferenceStore;
192 private IColorManager fColorManager;
194 private XMLTextTools fXMLTextTools;
196 private XMLConfiguration xmlConfiguration;
199 * Creates a new Java source viewer configuration for viewers in the given editor using the given preference store, the color
200 * manager and the specified document partitioning.
202 * Creates a Java source viewer configuration in the new setup without text tools. Clients are allowed to call
203 * {@link JavaSourceViewerConfiguration#handlePropertyChangeEvent(PropertyChangeEvent)}and disallowed to call
204 * {@link JavaSourceViewerConfiguration#getPreferenceStore()}on the resulting Java source viewer configuration.
207 * @param colorManager
209 * @param preferenceStore
210 * the preference store, can be read-only
212 * the editor in which the configured viewer(s) will reside
213 * @param partitioning
214 * the document partitioning for this configuration
217 public PHPSourceViewerConfiguration(IColorManager colorManager, IPreferenceStore preferenceStore, ITextEditor editor,
218 String partitioning) {
219 fColorManager = colorManager;
220 fPreferenceStore = preferenceStore;
221 fTextEditor = editor;
222 fDocumentPartitioning = partitioning;
223 // fJavaTextTools = PHPeclipsePlugin.getDefault().getJavaTextTools();
224 fXMLTextTools = XMLPlugin.getDefault().getXMLTextTools();
225 xmlConfiguration = new XMLConfiguration(fXMLTextTools);
226 fColorManager = colorManager;
227 fPreferenceStore = preferenceStore;
228 fTextEditor = editor;
229 fDocumentPartitioning = partitioning;
231 initializeScanners();
235 * Creates a new Java source viewer configuration for viewers in the given editor using the given Java tools.
238 * the Java text tools to be used
240 * the editor in which the configured viewer(s) will reside
242 * @deprecated As of 3.0, replaced by
243 * {@link JavaSourceViewerConfiguration#JavaSourceViewerConfiguration(IColorManager, IPreferenceStore, ITextEditor, String)}
245 // public PHPSourceViewerConfiguration(JavaTextTools tools, PHPEditor editor, String partitioning) {
246 // fJavaTextTools = tools;
247 // fColorManager = tools.getColorManager();
248 // fPreferenceStore = createPreferenceStore();
249 // fDocumentPartitioning = partitioning;
250 // fCodeScanner = (AbstractJavaScanner) fJavaTextTools.getCodeScanner();
251 // fMultilineCommentScanner = (AbstractJavaScanner) fJavaTextTools.getMultilineCommentScanner();
252 // fSinglelineCommentScanner = (AbstractJavaScanner) fJavaTextTools.getSinglelineCommentScanner();
253 // fStringDQScanner = (AbstractJavaScanner) fJavaTextTools.getStringScanner();
254 // fJavaDocScanner = (AbstractJavaScanner) fJavaTextTools.getJavaDocScanner();
255 // fTextEditor = editor;
256 // fXMLTextTools = XMLPlugin.getDefault().getXMLTextTools();
257 // xmlConfiguration = new XMLConfiguration(fXMLTextTools);
260 * Returns the color manager for this configuration.
262 * @return the color manager
264 protected IColorManager getColorManager() {
265 return fColorManager;
269 * Initializes the scanners.
273 private void initializeScanners() {
274 // Assert.isTrue(isNewSetup());
275 fCodeScanner = new PHPCodeScanner(getColorManager(), fPreferenceStore);
276 fMultilineCommentScanner = new SingleTokenPHPScanner(getColorManager(), fPreferenceStore,
277 IPreferenceConstants.PHP_MULTILINE_COMMENT);
278 fSinglelineCommentScanner = new SingleTokenPHPScanner(getColorManager(), fPreferenceStore,
279 IPreferenceConstants.PHP_SINGLELINE_COMMENT);
280 // fStringDQScanner = new SingleTokenPHPScanner(getColorManager(), fPreferenceStore, IPreferenceConstants.PHP_STRING_DQ);
281 fStringDQScanner = new PHPStringDQCodeScanner(getColorManager(), fPreferenceStore);
282 fStringSQScanner = new SingleTokenPHPScanner(getColorManager(), fPreferenceStore, IPreferenceConstants.PHP_STRING_SQ);
283 fJavaDocScanner = new PHPDocCodeScanner(getColorManager(), fPreferenceStore);
287 * Determines whether the preference change encoded by the given event changes the behavior of one of its contained components.
290 * the event to be investigated
291 * @return <code>true</code> if event causes a behavioral change
294 public boolean affectsTextPresentation(PropertyChangeEvent event) {
295 return fCodeScanner.affectsBehavior(event) || fMultilineCommentScanner.affectsBehavior(event)
296 || fSinglelineCommentScanner.affectsBehavior(event) || fStringDQScanner.affectsBehavior(event)|| fStringSQScanner.affectsBehavior(event)
297 || fJavaDocScanner.affectsBehavior(event);
301 * Adapts the behavior of the contained components to the change encoded in the given event.
303 * Clients are not allowed to call this method if the old setup with text tools is in use.
307 * the event to which to adapt
308 * @see JavaSourceViewerConfiguration#JavaSourceViewerConfiguration(IColorManager, IPreferenceStore, ITextEditor, String)
311 public void handlePropertyChangeEvent(PropertyChangeEvent event) {
312 // Assert.isTrue(isNewSetup());
313 if (fCodeScanner.affectsBehavior(event))
314 fCodeScanner.adaptToPreferenceChange(event);
315 if (fMultilineCommentScanner.affectsBehavior(event))
316 fMultilineCommentScanner.adaptToPreferenceChange(event);
317 if (fSinglelineCommentScanner.affectsBehavior(event))
318 fSinglelineCommentScanner.adaptToPreferenceChange(event);
319 if (fStringDQScanner.affectsBehavior(event))
320 fStringDQScanner.adaptToPreferenceChange(event);
321 if (fStringSQScanner.affectsBehavior(event))
322 fStringSQScanner.adaptToPreferenceChange(event);
323 if (fJavaDocScanner.affectsBehavior(event))
324 fJavaDocScanner.adaptToPreferenceChange(event);
328 * @see SourceViewerConfiguration#getContentFormatter(ISourceViewer)
330 public IContentFormatter getContentFormatter(ISourceViewer sourceViewer) {
331 // if (fFormatter == null) {
332 // fFormatter = new ContentFormatter();
333 // fFormattingStrategy = new HTMLFormattingStrategy(this,
335 // fFormatter.setFormattingStrategy(fFormattingStrategy, HTML_DEFAULT);
336 // fFormatter.enablePartitionAwareFormatting(false);
337 // fFormatter.setPartitionManagingPositionCategories(getConfiguredContentTypes(null));
339 // return fFormatter;
340 if (fFormatter == null) {
342 fFormatter = new ContentFormatter();
343 IFormattingStrategy strategy = new JavaFormattingStrategy(sourceViewer);
344 fFormatter.setFormattingStrategy(strategy, IDocument.DEFAULT_CONTENT_TYPE);
345 fFormatter.enablePartitionAwareFormatting(false);
346 fFormatter.setPartitionManagingPositionCategories(getPartitionManagingPositionCategories());
352 * Returns the names of the document position categories used by the document partitioners created by this object to manage their
353 * partition information. If the partitioners don't use document position categories, the returned result is <code>null</code>.
355 * @return the partition managing position categories or <code>null</code> if there is none
357 public String[] getPartitionManagingPositionCategories() {
358 return new String[] { DefaultPartitioner.CONTENT_TYPES_CATEGORY };
362 // * Returns the names of the document position categories used by the
364 // * partitioners created by this object to manage their partition
366 // * If the partitioners don't use document position categories, the
368 // * result is <code>null</code>.
370 // * @return the partition managing position categories or
372 // * if there is none
374 // private String[] getPartitionManagingPositionCategories() {
375 // return new String[] { DefaultPartitioner.CONTENT_TYPES_CATEGORY };
377 public ITextEditor getEditor() {
382 * Returns the preference store used by this configuration to initialize the individual bits and pieces.
384 * @return the preference store used to initialize this configuration
388 protected IPreferenceStore getPreferenceStore() {
389 return PHPeclipsePlugin.getDefault().getPreferenceStore();
393 // * Method declared on SourceViewerConfiguration
395 // public IAnnotationHover getAnnotationHover(ISourceViewer sourceViewer) {
396 // return new PHPAnnotationHover();
399 * @see SourceViewerConfiguration#getAnnotationHover(ISourceViewer)
401 public IAnnotationHover getAnnotationHover(ISourceViewer sourceViewer) {
402 return new JavaAnnotationHover(JavaAnnotationHover.VERTICAL_RULER_HOVER);
406 * @see SourceViewerConfiguration#getOverviewRulerAnnotationHover(ISourceViewer)
409 public IAnnotationHover getOverviewRulerAnnotationHover(ISourceViewer sourceViewer) {
410 return new JavaAnnotationHover(JavaAnnotationHover.OVERVIEW_RULER_HOVER);
414 * (non-Javadoc) Method declared on SourceViewerConfiguration
416 public IAutoIndentStrategy getAutoIndentStrategy(ISourceViewer sourceViewer, String contentType) {
417 if (IPHPPartitions.PHP_PHPDOC_COMMENT.equals(contentType)
418 || IPHPPartitions.PHP_MULTILINE_COMMENT.equals(contentType))
419 return new JavaDocAutoIndentStrategy(getConfiguredDocumentPartitioning(sourceViewer));
420 if (IPHPPartitions.PHP_STRING_DQ.equals(contentType))
421 return new JavaStringAutoIndentStrategyDQ(getConfiguredDocumentPartitioning(sourceViewer));
422 if (IPHPPartitions.PHP_STRING_SQ.equals(contentType))
423 return new JavaStringAutoIndentStrategySQ(getConfiguredDocumentPartitioning(sourceViewer));
425 return (PHPDocumentPartitioner.PHP_TEMPLATE_DATA.equals(contentType)
426 || PHPDocumentPartitioner.PHP_SCRIPT_CODE.equals(contentType) || IDocument.DEFAULT_CONTENT_TYPE.equals(contentType)
427 || IPHPPartitions.PHP_PARTITIONING.equals(contentType) || PHPPartitionScanner.PHP_SCRIPTING_AREA.equals(contentType) ? new PHPAutoIndentStrategy()
428 : new DefaultAutoIndentStrategy());
432 * Returns the PHP source code scanner for this configuration.
434 * @return the PHP source code scanner
436 protected RuleBasedScanner getCodeScanner() {
437 return fCodeScanner; //fJavaTextTools.getCodeScanner();
441 * Returns the Java multi-line comment scanner for this configuration.
443 * @return the Java multi-line comment scanner
446 protected RuleBasedScanner getMultilineCommentScanner() {
447 return fMultilineCommentScanner;
451 * Returns the Java single-line comment scanner for this configuration.
453 * @return the Java single-line comment scanner
456 protected RuleBasedScanner getSinglelineCommentScanner() {
457 return fSinglelineCommentScanner;
461 * Returns the PHP double quoted string scanner for this configuration.
463 * @return the PHP double quoted string scanner
465 protected RuleBasedScanner getStringDQScanner() {
466 return fStringDQScanner;
470 * Returns the PHP single quoted string scanner for this configuration.
472 * @return the PHP single quoted string scanner
474 protected RuleBasedScanner getStringSQScanner() {
475 return fStringSQScanner;
478 * Returns the HTML source code scanner for this configuration.
480 * @return the HTML source code scanner
482 // protected RuleBasedScanner getHTMLScanner() {
483 // return fJavaTextTools.getHTMLScanner();
486 * Returns the Smarty source code scanner for this configuration.
488 * @return the Smarty source code scanner
490 // protected RuleBasedScanner getSmartyScanner() {
491 // return fJavaTextTools.getSmartyScanner();
494 * @see SourceViewerConfiguration#getReconciler(ISourceViewer)
497 * @see SourceViewerConfiguration#getReconciler(ISourceViewer)
499 public IReconciler getReconciler(ISourceViewer sourceViewer) {
501 final ITextEditor editor = getEditor();
502 if (editor != null && editor.isEditable()) {
504 JavaCompositeReconcilingStrategy strategy = new JavaCompositeReconcilingStrategy(editor,
505 getConfiguredDocumentPartitioning(sourceViewer));
506 JavaReconciler reconciler = new JavaReconciler(editor, strategy, false);
507 reconciler.setIsIncrementalReconciler(false);
508 reconciler.setProgressMonitor(new NullProgressMonitor());
509 reconciler.setDelay(500);
517 * @see SourceViewerConfiguration#getConfiguredTextHoverStateMasks(ISourceViewer, String)
520 public int[] getConfiguredTextHoverStateMasks(ISourceViewer sourceViewer, String contentType) {
521 JavaEditorTextHoverDescriptor[] hoverDescs = PHPeclipsePlugin.getDefault().getJavaEditorTextHoverDescriptors();
522 int stateMasks[] = new int[hoverDescs.length];
523 int stateMasksLength = 0;
524 for (int i = 0; i < hoverDescs.length; i++) {
525 if (hoverDescs[i].isEnabled()) {
527 int stateMask = hoverDescs[i].getStateMask();
528 while (j < stateMasksLength) {
529 if (stateMasks[j] == stateMask)
533 if (j == stateMasksLength)
534 stateMasks[stateMasksLength++] = stateMask;
537 if (stateMasksLength == hoverDescs.length)
539 int[] shortenedStateMasks = new int[stateMasksLength];
540 System.arraycopy(stateMasks, 0, shortenedStateMasks, 0, stateMasksLength);
541 return shortenedStateMasks;
545 * @see SourceViewerConfiguration#getTextHover(ISourceViewer, String, int)
548 public ITextHover getTextHover(ISourceViewer sourceViewer, String contentType, int stateMask) {
549 JavaEditorTextHoverDescriptor[] hoverDescs = PHPeclipsePlugin.getDefault().getJavaEditorTextHoverDescriptors();
551 while (i < hoverDescs.length) {
552 if (hoverDescs[i].isEnabled() && hoverDescs[i].getStateMask() == stateMask)
553 return new JavaEditorTextHoverProxy(hoverDescs[i], getEditor());
557 // if (fEditor != null) {
558 // IEditorInput editorInput = fEditor.getEditorInput();
559 // if (editorInput instanceof IFileEditorInput) {
561 // IFile f = ((IFileEditorInput) editorInput).getFile();
562 // return new PHPTextHover(f.getProject());
563 // } catch (NullPointerException e) {
564 // // this exception occurs, if getTextHover is called by
565 // // preference pages !
569 // return new PHPTextHover(null);
573 * @see SourceViewerConfiguration#getTextHover(ISourceViewer, String)
575 public ITextHover getTextHover(ISourceViewer sourceViewer, String contentType) {
576 return getTextHover(sourceViewer, contentType, ITextViewerExtension2.DEFAULT_HOVER_STATE_MASK);
580 * Returns the SmartyDoc source code scanner for this configuration.
582 * @return the SmartyDoc source code scanner
584 // protected RuleBasedScanner getSmartyDocScanner() {
585 // return fJavaTextTools.getSmartyDocScanner();
588 * Returns the PHPDoc source code scanner for this configuration.
590 * @return the PHPDoc source code scanner
592 protected RuleBasedScanner getPHPDocScanner() {
593 return fJavaDocScanner; //fJavaTextTools.getJavaDocScanner();
597 * (non-Javadoc) Method declared on SourceViewerConfiguration
599 public String[] getConfiguredContentTypes(ISourceViewer sourceViewer) {
600 return new String[] { IDocument.DEFAULT_CONTENT_TYPE, PHPPartitionScanner.PHP_SCRIPTING_AREA,
602 IPHPPartitions.HTML, IPHPPartitions.HTML_MULTILINE_COMMENT, IPHPPartitions.PHP_PARTITIONING,
603 IPHPPartitions.PHP_SINGLELINE_COMMENT, IPHPPartitions.PHP_MULTILINE_COMMENT, IPHPPartitions.PHP_PHPDOC_COMMENT,
604 IPHPPartitions.PHP_STRING_DQ, IPHPPartitions.PHP_STRING_SQ, IPHPPartitions.CSS, IPHPPartitions.CSS_MULTILINE_COMMENT,
605 IPHPPartitions.JAVASCRIPT, IPHPPartitions.JS_MULTILINE_COMMENT, IPHPPartitions.SMARTY,
606 IPHPPartitions.SMARTY_MULTILINE_COMMENT,
608 XMLPartitionScanner.XML_PI, XMLPartitionScanner.XML_COMMENT, XMLPartitionScanner.XML_DECL, XMLPartitionScanner.XML_TAG,
609 XMLPartitionScanner.XML_ATTRIBUTE, XMLPartitionScanner.XML_CDATA,
611 XMLPartitionScanner.DTD_INTERNAL, XMLPartitionScanner.DTD_INTERNAL_PI, XMLPartitionScanner.DTD_INTERNAL_COMMENT,
612 XMLPartitionScanner.DTD_INTERNAL_DECL,
614 PHPDocumentPartitioner.PHP_TEMPLATE_DATA, PHPDocumentPartitioner.PHP_SCRIPT_CODE };
617 public String[] getConfiguredHTMLContentTypes() {
618 return new String[] { XMLPartitionScanner.XML_PI, XMLPartitionScanner.XML_COMMENT, XMLPartitionScanner.XML_DECL,
619 XMLPartitionScanner.XML_TAG, XMLPartitionScanner.XML_ATTRIBUTE, XMLPartitionScanner.XML_CDATA,
621 XMLPartitionScanner.DTD_INTERNAL, XMLPartitionScanner.DTD_INTERNAL_PI, XMLPartitionScanner.DTD_INTERNAL_COMMENT,
622 XMLPartitionScanner.DTD_INTERNAL_DECL, };
625 public String[] getConfiguredPHPContentTypes() {
626 return new String[] { IDocument.DEFAULT_CONTENT_TYPE, IPHPPartitions.PHP_PARTITIONING, IPHPPartitions.PHP_SINGLELINE_COMMENT,
627 IPHPPartitions.PHP_MULTILINE_COMMENT, IPHPPartitions.PHP_PHPDOC_COMMENT, IPHPPartitions.PHP_STRING_DQ,
628 IPHPPartitions.PHP_STRING_SQ, IPHPPartitions.CSS, IPHPPartitions.CSS_MULTILINE_COMMENT, IPHPPartitions.JAVASCRIPT,
629 IPHPPartitions.JS_MULTILINE_COMMENT, IPHPPartitions.SMARTY, IPHPPartitions.SMARTY_MULTILINE_COMMENT, };
633 * @see org.eclipse.jface.text.source.SourceViewerConfiguration#getConfiguredDocumentPartitioning(org.eclipse.jface.text.source.ISourceViewer)
636 public String getConfiguredDocumentPartitioning(ISourceViewer sourceViewer) {
637 if (fDocumentPartitioning != null)
638 return fDocumentPartitioning;
639 return super.getConfiguredDocumentPartitioning(sourceViewer);
643 * (non-Javadoc) Method declared on SourceViewerConfiguration
645 public IContentAssistant getContentAssistant(ISourceViewer sourceViewer) {
646 ContentAssistant assistant = new ContentAssistant();
647 IContentAssistProcessor processor = new HTMLCompletionProcessor(getEditor());
648 assistant.setDocumentPartitioning(getConfiguredDocumentPartitioning(sourceViewer));
649 assistant.setContentAssistProcessor(processor, IPHPPartitions.HTML);
650 assistant.setContentAssistProcessor(processor, IPHPPartitions.HTML_MULTILINE_COMMENT);
652 assistant.setContentAssistProcessor(processor, IPHPPartitions.CSS);
653 assistant.setContentAssistProcessor(processor, IPHPPartitions.CSS_MULTILINE_COMMENT);
654 assistant.setContentAssistProcessor(processor, IPHPPartitions.JAVASCRIPT);
655 assistant.setContentAssistProcessor(processor, IPHPPartitions.JS_MULTILINE_COMMENT);
656 // TODO define special smarty partition content assist
657 assistant.setContentAssistProcessor(processor, IPHPPartitions.SMARTY);
658 assistant.setContentAssistProcessor(processor, IPHPPartitions.SMARTY_MULTILINE_COMMENT);
660 assistant.setContentAssistProcessor(processor, PHPDocumentPartitioner.PHP_TEMPLATE_DATA);
661 String[] htmlTypes = getConfiguredHTMLContentTypes();
662 for (int i = 0; i < htmlTypes.length; i++) {
663 assistant.setContentAssistProcessor(processor, htmlTypes[i]);
665 processor = new PHPCompletionProcessor(getEditor());
667 assistant.setContentAssistProcessor(processor, PHPDocumentPartitioner.PHP_SCRIPT_CODE);
668 assistant.setContentAssistProcessor(processor, IPHPPartitions.PHP_PARTITIONING);
669 assistant.setContentAssistProcessor(processor, IPHPPartitions.PHP_STRING_DQ);
670 assistant.setContentAssistProcessor(processor, IPHPPartitions.PHP_STRING_SQ);
672 assistant.setContentAssistProcessor(new PHPDocCompletionProcessor(getEditor()), IPHPPartitions.PHP_PHPDOC_COMMENT);
673 // assistant.enableAutoActivation(true);
674 // assistant.setAutoActivationDelay(500);
675 // assistant.setProposalPopupOrientation(ContentAssistant.PROPOSAL_OVERLAY);
676 // ContentAssistPreference.configure(assistant, getPreferenceStore());
677 // assistant.setContextInformationPopupOrientation(
678 // ContentAssistant.CONTEXT_INFO_ABOVE);
679 // assistant.setContextInformationPopupBackground(
680 // PHPEditorEnvironment.getPHPColorProvider().getColor(
681 // new RGB(150, 150, 0)));
682 ContentAssistPreference.configure(assistant, getPreferenceStore());
683 assistant.setContextInformationPopupOrientation(ContentAssistant.CONTEXT_INFO_ABOVE);
684 assistant.setInformationControlCreator(getInformationControlCreator(sourceViewer));
689 * (non-Javadoc) Method declared on SourceViewerConfiguration
691 // public String getDefaultPrefix(ISourceViewer sourceViewer, String
693 // return (PHPPartitionScanner.PHP.equals(contentType) ? "//" : null);
695 // // return (IDocument.DEFAULT_CONTENT_TYPE.equals(contentType) ? "//" :
696 // null); //$NON-NLS-1$
699 * @see SourceViewerConfiguration#getDefaultPrefix(ISourceViewer, String)
702 public String[] getDefaultPrefixes(ISourceViewer sourceViewer, String contentType) {
703 return new String[] { "//", "" }; //$NON-NLS-1$ //$NON-NLS-2$
707 * (non-Javadoc) Method declared on SourceViewerConfiguration
709 public ITextDoubleClickStrategy getDoubleClickStrategy(ISourceViewer sourceViewer, String contentType) {
710 return new PHPDoubleClickSelector();
714 * @see SourceViewerConfiguration#getIndentPrefixes(ISourceViewer, String)
716 public String[] getIndentPrefixes(ISourceViewer sourceViewer, String contentType) {
717 Vector vector = new Vector();
718 // prefix[0] is either '\t' or ' ' x tabWidth, depending on useSpaces
719 final IPreferenceStore preferences = PHPeclipsePlugin.getDefault().getPreferenceStore();
720 int tabWidth = preferences.getInt(JavaCore.FORMATTER_TAB_SIZE);
721 boolean useSpaces = getPreferenceStore().getBoolean(SPACES_FOR_TABS);
722 for (int i = 0; i <= tabWidth; i++) {
723 StringBuffer prefix = new StringBuffer();
725 for (int j = 0; j + i < tabWidth; j++)
730 for (int j = 0; j < i; j++)
735 vector.add(prefix.toString());
737 vector.add(""); //$NON-NLS-1$
738 return (String[]) vector.toArray(new String[vector.size()]);
742 * @return <code>true</code> iff the new setup without text tools is in use.
746 // private boolean isNewSetup() {
747 // return fJavaTextTools == null;
751 * Creates and returns a preference store which combines the preference stores from the text tools and which is read-only.
753 * @return the read-only preference store
756 // private IPreferenceStore createPreferenceStore() {
757 // Assert.isTrue(!isNewSetup());
758 // IPreferenceStore generalTextStore = EditorsUI.getPreferenceStore();
759 // if (fJavaTextTools.getCorePreferenceStore() == null)
760 // return new ChainedPreferenceStore(new IPreferenceStore[] { fJavaTextTools.getPreferenceStore(), generalTextStore });
762 // return new ChainedPreferenceStore(new IPreferenceStore[] { fJavaTextTools.getPreferenceStore(),
763 // new PreferencesAdapter(fJavaTextTools.getCorePreferenceStore()), generalTextStore });
767 * (non-Javadoc) Method declared on SourceViewerConfiguration
769 public IPresentationReconciler getPresentationReconciler(ISourceViewer sourceViewer) {
770 // PHPColorProvider provider =
771 // PHPEditorEnvironment.getPHPColorProvider();
772 // JavaColorManager provider =
773 // PHPEditorEnvironment.getPHPColorProvider();
774 PresentationReconciler phpReconciler = new JavaPresentationReconciler();
775 phpReconciler.setDocumentPartitioning(getConfiguredDocumentPartitioning(sourceViewer));
777 // DefaultDamagerRepairer dr = new DefaultDamagerRepairer(getHTMLScanner());
778 // reconciler.setDamager(dr, IDocument.DEFAULT_CONTENT_TYPE);
779 // reconciler.setRepairer(dr, IDocument.DEFAULT_CONTENT_TYPE);
780 // dr = new DefaultDamagerRepairer(getHTMLScanner());
781 // reconciler.setDamager(dr, IPHPPartitions.HTML);
782 // reconciler.setRepairer(dr, IPHPPartitions.HTML);
783 // dr = new DefaultDamagerRepairer(getHTMLScanner());
784 // reconciler.setDamager(dr, IPHPPartitions.CSS);
785 // reconciler.setRepairer(dr, IPHPPartitions.CSS);
786 // dr = new DefaultDamagerRepairer(getHTMLScanner());
787 // reconciler.setDamager(dr, IPHPPartitions.CSS_MULTILINE_COMMENT);
788 // reconciler.setRepairer(dr, IPHPPartitions.CSS_MULTILINE_COMMENT);
789 // dr = new DefaultDamagerRepairer(getHTMLScanner());
790 // reconciler.setDamager(dr, IPHPPartitions.JAVASCRIPT);
791 // reconciler.setRepairer(dr, IPHPPartitions.JAVASCRIPT);
792 // dr = new DefaultDamagerRepairer(getHTMLScanner());
793 // reconciler.setDamager(dr, IPHPPartitions.JS_MULTILINE_COMMENT);
794 // reconciler.setRepairer(dr, IPHPPartitions.JS_MULTILINE_COMMENT);
795 // DefaultDamagerRepairer phpDR = new DefaultDamagerRepairer(getSmartyScanner());
796 // phpReconciler.setDamager(phpDR, IPHPPartitions.SMARTY);
797 // phpReconciler.setRepairer(phpDR, IPHPPartitions.SMARTY);
798 // phpDR = new DefaultDamagerRepairer(getSmartyDocScanner());
799 // phpReconciler.setDamager(phpDR, IPHPPartitions.SMARTY_MULTILINE_COMMENT);
800 // phpReconciler.setRepairer(phpDR, IPHPPartitions.SMARTY_MULTILINE_COMMENT);
801 // dr = new DefaultDamagerRepairer(new SingleTokenScanner(new TextAttribute(fJavaTextTools.getColorManager().getColor(
802 // PHPColorProvider.MULTI_LINE_COMMENT))));
803 // reconciler.setDamager(dr, IPHPPartitions.HTML_MULTILINE_COMMENT);
804 // reconciler.setRepairer(dr, IPHPPartitions.HTML_MULTILINE_COMMENT);
806 DefaultDamagerRepairer phpDR = new DefaultDamagerRepairer(getCodeScanner());
807 phpReconciler.setDamager(phpDR, IDocument.DEFAULT_CONTENT_TYPE);
808 phpReconciler.setRepairer(phpDR, IDocument.DEFAULT_CONTENT_TYPE);
810 phpDR = new DefaultDamagerRepairer(getCodeScanner());
811 phpReconciler.setDamager(phpDR, IPHPPartitions.PHP_PARTITIONING);
812 phpReconciler.setRepairer(phpDR, IPHPPartitions.PHP_PARTITIONING);
814 phpDR = new DefaultDamagerRepairer(getPHPDocScanner());
815 phpReconciler.setDamager(phpDR, IPHPPartitions.PHP_PHPDOC_COMMENT);
816 phpReconciler.setRepairer(phpDR, IPHPPartitions.PHP_PHPDOC_COMMENT);
818 phpDR = new DefaultDamagerRepairer(getStringDQScanner());
819 phpReconciler.setDamager(phpDR, IPHPPartitions.PHP_STRING_DQ);
820 phpReconciler.setRepairer(phpDR, IPHPPartitions.PHP_STRING_DQ);
821 phpDR = new DefaultDamagerRepairer(getStringSQScanner());
822 phpReconciler.setDamager(phpDR, IPHPPartitions.PHP_STRING_SQ);
823 phpReconciler.setRepairer(phpDR, IPHPPartitions.PHP_STRING_SQ);
824 phpDR = new DefaultDamagerRepairer(getSinglelineCommentScanner());
825 phpReconciler.setDamager(phpDR, IPHPPartitions.PHP_SINGLELINE_COMMENT);
826 phpReconciler.setRepairer(phpDR, IPHPPartitions.PHP_SINGLELINE_COMMENT);
827 phpDR = new DefaultDamagerRepairer(getMultilineCommentScanner());
828 phpReconciler.setDamager(phpDR, IPHPPartitions.PHP_MULTILINE_COMMENT);
829 phpReconciler.setRepairer(phpDR, IPHPPartitions.PHP_MULTILINE_COMMENT);
831 PresentationReconciler reconciler = new PresentationReconciler();
832 reconciler.setDocumentPartitioning(getConfiguredDocumentPartitioning(sourceViewer));
834 // JavaTextTools jspTextTools = PHPeclipsePlugin.getDefault().getJavaTextTools();
835 DefaultDamagerRepairer dr = new DefaultDamagerRepairer(getPHPDocScanner());//jspTextTools.getJSPTextScanner());
836 reconciler.setDamager(dr, IDocument.DEFAULT_CONTENT_TYPE);
837 reconciler.setRepairer(dr, IDocument.DEFAULT_CONTENT_TYPE);
839 // dr = new DefaultDamagerRepairer(new SingleTokenScanner(new TextAttribute(fJavaTextTools.getColorManager().getColor(
840 // PHPColorProvider.PHPDOC_TAG))));//jspTextTools.getJSPBracketScanner());
841 // reconciler.setDamager(dr, JSPScriptScanner.JSP_BRACKET);
842 // reconciler.setRepairer(dr, JSPScriptScanner.JSP_BRACKET);
845 configureEmbeddedPresentationReconciler(reconciler, xmlConfiguration.getPresentationReconciler(sourceViewer), xmlConfiguration
846 .getConfiguredContentTypes(sourceViewer), PHPDocumentPartitioner.PHP_TEMPLATE_DATA);
849 configureEmbeddedPresentationReconciler(reconciler, phpReconciler, getConfiguredPHPContentTypes(),
850 PHPDocumentPartitioner.PHP_SCRIPT_CODE);
855 private void configureEmbeddedPresentationReconciler(PresentationReconciler reconciler, IPresentationReconciler embedded,
856 String[] types, String defaultType) {
857 for (int i = 0; i < types.length; i++) {
858 String type = types[i];
860 IPresentationDamager damager = embedded.getDamager(type);
861 IPresentationRepairer repairer = embedded.getRepairer(type);
863 if (type == IDocument.DEFAULT_CONTENT_TYPE) {
867 reconciler.setDamager(damager, type);
868 reconciler.setRepairer(repairer, type);
873 * (non-Javadoc) Method declared on SourceViewerConfiguration
875 public int getTabWidth(ISourceViewer sourceViewer) {
876 return getPreferenceStore().getInt(PREFERENCE_TAB_WIDTH);
880 * (non-Javadoc) Method declared on SourceViewerConfiguration
882 // public ITextHover getTextHover(ISourceViewer sourceViewer, String
884 // if (fEditor != null) {
885 // IEditorInput editorInput = fEditor.getEditorInput();
886 // if (editorInput instanceof IFileEditorInput) {
888 // IFile f = ((IFileEditorInput) editorInput).getFile();
889 // return new PHPTextHover(f.getProject());
890 // } catch (NullPointerException e) {
891 // // this exception occurs, if getTextHover is called by preference pages
896 // return new PHPTextHover(null);
899 * @see SourceViewerConfiguration#getInformationControlCreator(ISourceViewer)
902 public IInformationControlCreator getInformationControlCreator(ISourceViewer sourceViewer) {
903 return new IInformationControlCreator() {
904 public IInformationControl createInformationControl(Shell parent) {
905 return new DefaultInformationControl(parent, SWT.NONE, new HTMLTextPresenter(true));
906 // return new HoverBrowserControl(parent);
912 * @see SourceViewerConfiguration#getInformationPresenter(ISourceViewer)
915 public IInformationPresenter getInformationPresenter(ISourceViewer sourceViewer) {
916 InformationPresenter presenter = new InformationPresenter(getInformationPresenterControlCreator(sourceViewer));
917 presenter.setDocumentPartitioning(getConfiguredDocumentPartitioning(sourceViewer));
918 IInformationProvider provider = new JavaInformationProvider(getEditor());
919 presenter.setInformationProvider(provider, IDocument.DEFAULT_CONTENT_TYPE);
920 presenter.setInformationProvider(provider, IPHPPartitions.PHP_PHPDOC_COMMENT);
921 // presenter.setInformationProvider(provider, IPHPPartitions.JAVA_CHARACTER);
922 presenter.setSizeConstraints(60, 10, true, true);
927 * @see SourceViewerConfiguration#getInformationPresenter(ISourceViewer)
930 // public IInformationPresenter getInformationPresenter(ISourceViewer
932 // InformationPresenter presenter= new
933 // InformationPresenter(getInformationPresenterControlCreator(sourceViewer));
934 // IInformationProvider provider= new JavaInformationProvider(getEditor());
935 // presenter.setInformationProvider(provider,
936 // IDocument.DEFAULT_CONTENT_TYPE);
937 // presenter.setInformationProvider(provider, IJavaPartitions.JAVA_DOC);
938 // presenter.setSizeConstraints(60, 10, true, true);
942 * Returns the information presenter control creator. The creator is a factory creating the presenter controls for the given
943 * source viewer. This implementation always returns a creator for <code>DefaultInformationControl</code> instances.
945 * @param sourceViewer
946 * the source viewer to be configured by this configuration
947 * @return an information control creator
950 private IInformationControlCreator getInformationPresenterControlCreator(ISourceViewer sourceViewer) {
951 return new IInformationControlCreator() {
952 public IInformationControl createInformationControl(Shell parent) {
953 int shellStyle = SWT.RESIZE;
954 int style = SWT.V_SCROLL | SWT.H_SCROLL;
955 return new DefaultInformationControl(parent, shellStyle, style, new HTMLTextPresenter(false));
956 // return new HoverBrowserControl(parent);
962 * Returns the outline presenter control creator. The creator is a factory creating outline presenter controls for the given
963 * source viewer. This implementation always returns a creator for <code>JavaOutlineInformationControl</code> instances.
965 * @param sourceViewer
966 * the source viewer to be configured by this configuration
967 * @return an information control creator
970 private IInformationControlCreator getOutlinePresenterControlCreator(ISourceViewer sourceViewer) {
971 return new IInformationControlCreator() {
972 public IInformationControl createInformationControl(Shell parent) {
973 int shellStyle = SWT.RESIZE;
974 int treeStyle = SWT.V_SCROLL | SWT.H_SCROLL;
975 return new JavaOutlineInformationControl(parent, shellStyle, treeStyle);
981 * Returns the outline presenter which will determine and shown information requested for the current cursor position.
983 * @param sourceViewer
984 * the source viewer to be configured by this configuration
985 * @param doCodeResolve
986 * a boolean which specifies whether code resolve should be used to compute the Java element
987 * @return an information presenter
990 public IInformationPresenter getOutlinePresenter(ISourceViewer sourceViewer, boolean doCodeResolve) {
991 InformationPresenter presenter = new InformationPresenter(getOutlinePresenterControlCreator(sourceViewer));
992 presenter.setAnchor(InformationPresenter.ANCHOR_GLOBAL);
993 IInformationProvider provider = new JavaElementProvider(getEditor(), doCodeResolve);
994 presenter.setInformationProvider(provider, IDocument.DEFAULT_CONTENT_TYPE);
995 presenter.setInformationProvider(provider, PHPDocumentPartitioner.PHP_SCRIPT_CODE);
996 presenter.setInformationProvider(provider, IPHPPartitions.PHP_PARTITIONING);
997 presenter.setInformationProvider(provider, IPHPPartitions.PHP_PHPDOC_COMMENT);
998 presenter.setInformationProvider(provider, IPHPPartitions.SMARTY_MULTILINE_COMMENT);
999 presenter.setInformationProvider(provider, IPHPPartitions.HTML);
1000 presenter.setInformationProvider(provider, IPHPPartitions.HTML_MULTILINE_COMMENT);
1001 presenter.setSizeConstraints(40, 20, true, false);