new icon for "defines" in code completion
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / PHPSourceViewerConfiguration.java
index 9fbe169..ab128ff 100644 (file)
@@ -13,10 +13,13 @@ package net.sourceforge.phpeclipse.phpeditor;
 
 import java.util.Vector;
 
-import net.sourceforge.phpdt.internal.ui.text.JavaColorManager;
+import net.sourceforge.phpdt.internal.ui.text.ContentAssistPreference;
+import net.sourceforge.phpdt.internal.ui.text.HTMLTextPresenter;
 import net.sourceforge.phpdt.internal.ui.text.java.JavaFormattingStrategy;
 import net.sourceforge.phpdt.internal.ui.text.phpdoc.PHPDocCompletionProcessor;
+import net.sourceforge.phpdt.ui.PreferenceConstants;
 import net.sourceforge.phpdt.ui.text.JavaTextTools;
+import net.sourceforge.phpeclipse.PHPCore;
 import net.sourceforge.phpeclipse.PHPeclipsePlugin;
 import net.sourceforge.phpeclipse.phpeditor.html.HTMLFormattingStrategy;
 import net.sourceforge.phpeclipse.phpeditor.php.HTMLCompletionProcessor;
@@ -26,14 +29,19 @@ import net.sourceforge.phpeclipse.phpeditor.php.PHPCompletionProcessor;
 import net.sourceforge.phpeclipse.phpeditor.php.PHPDoubleClickSelector;
 import net.sourceforge.phpeclipse.phpeditor.util.PHPColorProvider;
 
+import org.eclipse.core.resources.IFile;
 import org.eclipse.jface.preference.IPreferenceStore;
 import org.eclipse.jface.text.DefaultAutoIndentStrategy;
+import org.eclipse.jface.text.DefaultInformationControl;
 import org.eclipse.jface.text.IAutoIndentStrategy;
 import org.eclipse.jface.text.IDocument;
+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.TextAttribute;
 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.ContentFormatter;
 import org.eclipse.jface.text.formatter.IContentFormatter;
@@ -43,18 +51,34 @@ import org.eclipse.jface.text.presentation.PresentationReconciler;
 import org.eclipse.jface.text.rules.BufferedRuleBasedScanner;
 import org.eclipse.jface.text.rules.DefaultDamagerRepairer;
 import org.eclipse.jface.text.rules.DefaultPartitioner;
+import org.eclipse.jface.text.rules.RuleBasedScanner;
 import org.eclipse.jface.text.rules.Token;
 import org.eclipse.jface.text.source.IAnnotationHover;
 import org.eclipse.jface.text.source.ISourceViewer;
 import org.eclipse.jface.text.source.SourceViewerConfiguration;
-import org.eclipse.swt.graphics.RGB;
+import org.eclipse.swt.SWT;
+import org.eclipse.swt.widgets.Shell;
+import org.eclipse.ui.IFileEditorInput;
 
 /**
  * Configuration for an <code>SourceViewer</code> which shows PHP code. 
  */
 public class PHPSourceViewerConfiguration extends SourceViewerConfiguration {
 
-  public static final String HTML_DEFAULT = IPHPPartitionScannerConstants.HTML;
+  /** 
+   * Preference key used to look up display tab width.
+   * 
+   * @since 2.0
+   */
+  public final static String PREFERENCE_TAB_WIDTH = PreferenceConstants.EDITOR_TAB_WIDTH;
+  /** 
+   * Preference key for inserting spaces rather than tabs.
+   * 
+   * @since 2.0
+   */
+  public final static String SPACES_FOR_TABS = PreferenceConstants.EDITOR_SPACES_FOR_TABS;
+
+  //  public static final String HTML_DEFAULT = IPHPPartitionScannerConstants.HTML;
   //IDocument.DEFAULT_CONTENT_TYPE;
 
   private JavaTextTools fJavaTextTools;
@@ -97,12 +121,9 @@ public class PHPSourceViewerConfiguration extends SourceViewerConfiguration {
       fFormatter = new ContentFormatter();
       IFormattingStrategy strategy = new JavaFormattingStrategy(sourceViewer);
 
-      fFormatter.setFormattingStrategy(
-        strategy,
-        IDocument.DEFAULT_CONTENT_TYPE);
+      fFormatter.setFormattingStrategy(strategy, IDocument.DEFAULT_CONTENT_TYPE);
       fFormatter.enablePartitionAwareFormatting(false);
-      fFormatter.setPartitionManagingPositionCategories(
-        getPartitionManagingPositionCategories());
+      fFormatter.setPartitionManagingPositionCategories(getPartitionManagingPositionCategories());
     }
     return fFormatter;
   }
@@ -136,6 +157,18 @@ public class PHPSourceViewerConfiguration extends SourceViewerConfiguration {
     return fEditor;
   }
 
+  /**
+   * Returns the preference store used by this configuration to initialize
+   * the individual bits and pieces.
+   * 
+   * @return the preference store used to initialize this configuration
+   * 
+   * @since 2.0
+   */
+  protected IPreferenceStore getPreferenceStore() {
+    return PHPeclipsePlugin.getDefault().getPreferenceStore();
+  }
+
   /* (non-Javadoc)
    * Method declared on SourceViewerConfiguration
    */
@@ -146,13 +179,35 @@ public class PHPSourceViewerConfiguration extends SourceViewerConfiguration {
   /* (non-Javadoc)
    * Method declared on SourceViewerConfiguration
    */
-  public IAutoIndentStrategy getAutoIndentStrategy(
-    ISourceViewer sourceViewer,
-    String contentType) {
-    return (
-      IDocument.DEFAULT_CONTENT_TYPE.equals(contentType)
-        ? new PHPAutoIndentStrategy()
-        : new DefaultAutoIndentStrategy());
+  public IAutoIndentStrategy getAutoIndentStrategy(ISourceViewer sourceViewer, String contentType) {
+    return (IPHPPartitionScannerConstants.PHP.equals(contentType) ? new PHPAutoIndentStrategy() : new DefaultAutoIndentStrategy());
+  }
+
+  /**
+   * Returns the PHP source code scanner for this configuration.
+   *
+   * @return the PHP source code scanner
+   */
+  protected RuleBasedScanner getCodeScanner() {
+    return fJavaTextTools.getCodeScanner();
+  }
+
+  /**
+   * Returns the HTML source code scanner for this configuration.
+   *
+   * @return the HTML source code scanner
+   */
+  protected RuleBasedScanner getHTMLScanner() {
+    return fJavaTextTools.getHTMLScanner();
+  }
+
+  /**
+   * Returns the PHPDoc source code scanner for this configuration.
+   *
+   * @return the PHPDoc source code scanner
+   */
+  protected RuleBasedScanner getPHPDocScanner() {
+    return fJavaTextTools.getJavaDocScanner();
   }
 
   /* (non-Javadoc)
@@ -160,15 +215,15 @@ public class PHPSourceViewerConfiguration extends SourceViewerConfiguration {
    */
   public String[] getConfiguredContentTypes(ISourceViewer sourceViewer) {
     return new String[] {
-      IDocument.DEFAULT_CONTENT_TYPE,
-      IPHPPartitionScannerConstants.PHP,
-      IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT,
       IPHPPartitionScannerConstants.HTML,
       IPHPPartitionScannerConstants.HTML_MULTILINE_COMMENT,
+      IPHPPartitionScannerConstants.PHP,
+      IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT,
       IPHPPartitionScannerConstants.CSS,
       IPHPPartitionScannerConstants.CSS_MULTILINE_COMMENT,
       IPHPPartitionScannerConstants.JAVASCRIPT,
-      IPHPPartitionScannerConstants.JS_MULTILINE_COMMENT };
+      IPHPPartitionScannerConstants.JS_MULTILINE_COMMENT,
+      IDocument.DEFAULT_CONTENT_TYPE };
   }
 
   /* (non-Javadoc) 
@@ -177,24 +232,32 @@ public class PHPSourceViewerConfiguration extends SourceViewerConfiguration {
   public IContentAssistant getContentAssistant(ISourceViewer sourceViewer) {
 
     ContentAssistant assistant = new ContentAssistant();
-    assistant.setContentAssistProcessor(
-      new HTMLCompletionProcessor(),
-      IDocument.DEFAULT_CONTENT_TYPE);
-    assistant.setContentAssistProcessor(
-      new PHPCompletionProcessor(),
-      IPHPPartitionScannerConstants.PHP);
-    assistant.setContentAssistProcessor(
-      new PHPDocCompletionProcessor(),
-      IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT);
-
-    assistant.enableAutoActivation(true);
-    assistant.setAutoActivationDelay(500);
-    assistant.setProposalPopupOrientation(ContentAssistant.PROPOSAL_OVERLAY);
-    assistant.setContextInformationPopupOrientation(
-      ContentAssistant.CONTEXT_INFO_ABOVE);
-    assistant.setContextInformationPopupBackground(
-      PHPEditorEnvironment.getPHPColorProvider().getColor(
-        new RGB(150, 150, 0)));
+    IContentAssistProcessor processor = new HTMLCompletionProcessor();
+    assistant.setContentAssistProcessor(processor, IPHPPartitionScannerConstants.HTML);
+    assistant.setContentAssistProcessor(processor, IPHPPartitionScannerConstants.HTML_MULTILINE_COMMENT);
+    assistant.setContentAssistProcessor(processor, IDocument.DEFAULT_CONTENT_TYPE);
+    assistant.setContentAssistProcessor(processor, IPHPPartitionScannerConstants.CSS);
+    assistant.setContentAssistProcessor(processor, IPHPPartitionScannerConstants.CSS_MULTILINE_COMMENT);
+    assistant.setContentAssistProcessor(processor, IPHPPartitionScannerConstants.JAVASCRIPT);
+    assistant.setContentAssistProcessor(processor, IPHPPartitionScannerConstants.JS_MULTILINE_COMMENT);
+
+    assistant.setContentAssistProcessor(new PHPCompletionProcessor(), IPHPPartitionScannerConstants.PHP);
+
+    assistant.setContentAssistProcessor(new PHPDocCompletionProcessor(), IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT);
+
+    //    assistant.enableAutoActivation(true);
+    //    assistant.setAutoActivationDelay(500);
+    //    assistant.setProposalPopupOrientation(ContentAssistant.PROPOSAL_OVERLAY);
+    //    ContentAssistPreference.configure(assistant, getPreferenceStore());
+    //    assistant.setContextInformationPopupOrientation(
+    //      ContentAssistant.CONTEXT_INFO_ABOVE);
+    //    assistant.setContextInformationPopupBackground(
+    //      PHPEditorEnvironment.getPHPColorProvider().getColor(
+    //        new RGB(150, 150, 0)));
+    ContentAssistPreference.configure(assistant, getPreferenceStore());
+
+    assistant.setContextInformationPopupOrientation(ContentAssistant.CONTEXT_INFO_ABOVE);
+    assistant.setInformationControlCreator(getInformationControlCreator(sourceViewer));
 
     return assistant;
   }
@@ -211,44 +274,29 @@ public class PHPSourceViewerConfiguration extends SourceViewerConfiguration {
    * @see SourceViewerConfiguration#getDefaultPrefix(ISourceViewer, String)
    * @since 2.0
    */
-  public String[] getDefaultPrefixes(
-    ISourceViewer sourceViewer,
-    String contentType) {
+  public String[] getDefaultPrefixes(ISourceViewer sourceViewer, String contentType) {
     return new String[] { "//", "" }; //$NON-NLS-1$ //$NON-NLS-2$
   }
 
   /* (non-Javadoc)
    * Method declared on SourceViewerConfiguration
    */
-  public ITextDoubleClickStrategy getDoubleClickStrategy(
-    ISourceViewer sourceViewer,
-    String contentType) {
+  public ITextDoubleClickStrategy getDoubleClickStrategy(ISourceViewer sourceViewer, String contentType) {
     return new PHPDoubleClickSelector();
   }
 
-  /* (non-Javadoc)
-   * Method declared on SourceViewerConfiguration
-   */
-  //  public String[] getIndentPrefixes(ISourceViewer sourceViewer, String contentType) {
-  //    return new String[] { "\t", "    " }; //$NON-NLS-1$ //$NON-NLS-2$
-  //  }
-
   /*
    * @see SourceViewerConfiguration#getIndentPrefixes(ISourceViewer, String)
    */
-  public String[] getIndentPrefixes(
-    ISourceViewer sourceViewer,
-    String contentType) {
+  public String[] getIndentPrefixes(ISourceViewer sourceViewer, String contentType) {
 
     Vector vector = new Vector();
 
     // prefix[0] is either '\t' or ' ' x tabWidth, depending on useSpaces
 
-    final IPreferenceStore store =
-      PHPeclipsePlugin.getDefault().getPreferenceStore();
-
-    int tabWidth = store.getInt(PHPeclipsePlugin.FORMATTER_TAB_SIZE);
-    boolean useSpaces = store.getBoolean(PHPeclipsePlugin.SPACES_FOR_TABS);
+    final IPreferenceStore preferences = PHPeclipsePlugin.getDefault().getPreferenceStore();
+    int tabWidth = preferences.getInt(PHPCore.FORMATTER_TAB_SIZE);
+    boolean useSpaces = getPreferenceStore().getBoolean(SPACES_FOR_TABS);
 
     for (int i = 0; i <= tabWidth; i++) {
       StringBuffer prefix = new StringBuffer();
@@ -278,48 +326,42 @@ public class PHPSourceViewerConfiguration extends SourceViewerConfiguration {
    * Method declared on SourceViewerConfiguration
    */
   public IPresentationReconciler getPresentationReconciler(ISourceViewer sourceViewer) {
-
-  //  PHPColorProvider provider = PHPEditorEnvironment.getPHPColorProvider();
-    JavaColorManager provider = PHPEditorEnvironment.getPHPColorProvider();
+    //  PHPColorProvider provider = PHPEditorEnvironment.getPHPColorProvider();
+    //    JavaColorManager provider = PHPEditorEnvironment.getPHPColorProvider();
     PresentationReconciler reconciler = new PresentationReconciler();
 
-    DefaultDamagerRepairer dr =
-      new DefaultDamagerRepairer(PHPEditorEnvironment.getHTMLCodeScanner());
+    DefaultDamagerRepairer dr = new DefaultDamagerRepairer(getHTMLScanner());
     reconciler.setDamager(dr, IDocument.DEFAULT_CONTENT_TYPE);
     reconciler.setRepairer(dr, IDocument.DEFAULT_CONTENT_TYPE);
 
-    //    dr = new DefaultDamagerRepairer(new SingleTokenScanner(new TextAttribute(provider.getColor(provider.HTML_DEFAULT))));
-    //    reconciler.setDamager(dr, IDocument.DEFAULT_CONTENT_TYPE);
-    //    reconciler.setRepairer(dr, IDocument.DEFAULT_CONTENT_TYPE);
-
-    dr = new DefaultDamagerRepairer(PHPEditorEnvironment.getPHPCodeScanner());
-    reconciler.setDamager(dr, IPHPPartitionScannerConstants.PHP);
-    reconciler.setRepairer(dr, IPHPPartitionScannerConstants.PHP);
-
-    dr =
-      new DefaultDamagerRepairer(PHPEditorEnvironment.getPHPDocCodeScanner());
-    reconciler.setDamager(
-      dr,
-      IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT);
-    reconciler.setRepairer(
-      dr,
-      IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT);
-
-    dr = new DefaultDamagerRepairer(PHPEditorEnvironment.getHTMLCodeScanner());
+    dr = new DefaultDamagerRepairer(getHTMLScanner());
     reconciler.setDamager(dr, IPHPPartitionScannerConstants.HTML);
     reconciler.setRepairer(dr, IPHPPartitionScannerConstants.HTML);
-
+    dr = new DefaultDamagerRepairer(getHTMLScanner());
+    reconciler.setDamager(dr, IPHPPartitionScannerConstants.CSS);
+    reconciler.setRepairer(dr, IPHPPartitionScannerConstants.CSS);
+    dr = new DefaultDamagerRepairer(getHTMLScanner());
+    reconciler.setDamager(dr, IPHPPartitionScannerConstants.CSS_MULTILINE_COMMENT);
+    reconciler.setRepairer(dr, IPHPPartitionScannerConstants.CSS_MULTILINE_COMMENT);
+    dr = new DefaultDamagerRepairer(getHTMLScanner());
+    reconciler.setDamager(dr, IPHPPartitionScannerConstants.JAVASCRIPT);
+    reconciler.setRepairer(dr, IPHPPartitionScannerConstants.JAVASCRIPT);
+    dr = new DefaultDamagerRepairer(getHTMLScanner());
+    reconciler.setDamager(dr, IPHPPartitionScannerConstants.JS_MULTILINE_COMMENT);
+    reconciler.setRepairer(dr, IPHPPartitionScannerConstants.JS_MULTILINE_COMMENT);
     dr =
       new DefaultDamagerRepairer(
-        new SingleTokenScanner(
-          new TextAttribute(
-            provider.getColor(PHPColorProvider.MULTI_LINE_COMMENT))));
-    reconciler.setDamager(
-      dr,
-      IPHPPartitionScannerConstants.HTML_MULTILINE_COMMENT);
-    reconciler.setRepairer(
-      dr,
-      IPHPPartitionScannerConstants.HTML_MULTILINE_COMMENT);
+        new SingleTokenScanner(new TextAttribute(fJavaTextTools.getColorManager().getColor(PHPColorProvider.MULTI_LINE_COMMENT))));
+    reconciler.setDamager(dr, IPHPPartitionScannerConstants.HTML_MULTILINE_COMMENT);
+    reconciler.setRepairer(dr, IPHPPartitionScannerConstants.HTML_MULTILINE_COMMENT);
+
+    dr = new DefaultDamagerRepairer(getCodeScanner());
+    reconciler.setDamager(dr, IPHPPartitionScannerConstants.PHP);
+    reconciler.setRepairer(dr, IPHPPartitionScannerConstants.PHP);
+
+    dr = new DefaultDamagerRepairer(getPHPDocScanner());
+    reconciler.setDamager(dr, IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT);
+    reconciler.setRepairer(dr, IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT);
 
     return reconciler;
   }
@@ -328,15 +370,32 @@ public class PHPSourceViewerConfiguration extends SourceViewerConfiguration {
    * Method declared on SourceViewerConfiguration
    */
   public int getTabWidth(ISourceViewer sourceViewer) {
-    return 4;
+    return getPreferenceStore().getInt(PREFERENCE_TAB_WIDTH);
   }
 
   /* (non-Javadoc)
    * Method declared on SourceViewerConfiguration
    */
-  public ITextHover getTextHover(
-    ISourceViewer sourceViewer,
-    String contentType) {
-    return new PHPTextHover();
+  public ITextHover getTextHover(ISourceViewer sourceViewer, String contentType) {
+    try {
+      IFile f = ((IFileEditorInput) fEditor.getEditorInput()).getFile();
+      return new PHPTextHover(f.getProject());
+    } catch (NullPointerException e) {
+       // this exception occurs, if getTextHover is called by preference pages !
+    }
+    return new PHPTextHover(null);
   }
+  
+       /*
+        * @see SourceViewerConfiguration#getInformationControlCreator(ISourceViewer)
+        * @since 2.0
+        */
+       public IInformationControlCreator getInformationControlCreator(ISourceViewer sourceViewer) {
+               return new IInformationControlCreator() {
+                       public IInformationControl createInformationControl(Shell parent) {
+                               return new DefaultInformationControl(parent, SWT.NONE, new HTMLTextPresenter(true));
+                               // return new HoverBrowserControl(parent);
+                       }
+               };
+       }
 }