new version with WorkingCopy Management
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / PHPSourceViewerConfiguration.java
index 45ee036..b7f6156 100644 (file)
@@ -14,8 +14,15 @@ package net.sourceforge.phpeclipse.phpeditor;
 import java.util.Vector;
 
 import net.sourceforge.phpdt.internal.ui.text.ContentAssistPreference;
-import net.sourceforge.phpdt.internal.ui.text.JavaColorManager;
+import net.sourceforge.phpdt.internal.ui.text.HTMLTextPresenter;
+import net.sourceforge.phpdt.internal.ui.text.JavaElementProvider;
+import net.sourceforge.phpdt.internal.ui.text.JavaOutlineInformationControl;
+import net.sourceforge.phpdt.internal.ui.text.JavaReconciler;
+import net.sourceforge.phpdt.internal.ui.text.PHPAnnotationHover;
 import net.sourceforge.phpdt.internal.ui.text.java.JavaFormattingStrategy;
+import net.sourceforge.phpdt.internal.ui.text.java.JavaReconcilingStrategy;
+import net.sourceforge.phpdt.internal.ui.text.java.hover.JavaEditorTextHoverDescriptor;
+import net.sourceforge.phpdt.internal.ui.text.java.hover.JavaEditorTextHoverProxy;
 import net.sourceforge.phpdt.internal.ui.text.phpdoc.PHPDocCompletionProcessor;
 import net.sourceforge.phpdt.ui.PreferenceConstants;
 import net.sourceforge.phpdt.ui.text.JavaTextTools;
@@ -29,13 +36,18 @@ 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.runtime.Preferences;
+import org.eclipse.core.resources.IFile;
+import org.eclipse.core.runtime.NullProgressMonitor;
 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.ITextViewerExtension2;
 import org.eclipse.jface.text.TextAttribute;
 import org.eclipse.jface.text.contentassist.ContentAssistant;
 import org.eclipse.jface.text.contentassist.IContentAssistProcessor;
@@ -43,37 +55,44 @@ import org.eclipse.jface.text.contentassist.IContentAssistant;
 import org.eclipse.jface.text.formatter.ContentFormatter;
 import org.eclipse.jface.text.formatter.IContentFormatter;
 import org.eclipse.jface.text.formatter.IFormattingStrategy;
+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.presentation.IPresentationReconciler;
 import org.eclipse.jface.text.presentation.PresentationReconciler;
+import org.eclipse.jface.text.reconciler.IReconciler;
 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.SWT;
+import org.eclipse.swt.widgets.Shell;
+import org.eclipse.ui.IEditorInput;
+import org.eclipse.ui.IFileEditorInput;
 
 /**
  * Configuration for an <code>SourceViewer</code> which shows PHP code. 
  */
 public class PHPSourceViewerConfiguration extends SourceViewerConfiguration {
 
-       
   /** 
    * Preference key used to look up display tab width.
    * 
    * @since 2.0
    */
-  public final static String PREFERENCE_TAB_WIDTH= PreferenceConstants.EDITOR_TAB_WIDTH;
+  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 final static String SPACES_FOR_TABS = PreferenceConstants.EDITOR_SPACES_FOR_TABS;
 
-
-//  public static final String HTML_DEFAULT = IPHPPartitionScannerConstants.HTML;
+  //  public static final String HTML_DEFAULT = IPHPPartitionScannerConstants.HTML;
   //IDocument.DEFAULT_CONTENT_TYPE;
 
   private JavaTextTools fJavaTextTools;
@@ -164,8 +183,14 @@ public class PHPSourceViewerConfiguration extends SourceViewerConfiguration {
     return PHPeclipsePlugin.getDefault().getPreferenceStore();
   }
 
-  /* (non-Javadoc)
-   * Method declared on SourceViewerConfiguration
+  //  /* (non-Javadoc)
+  //   * Method declared on SourceViewerConfiguration
+  //   */
+  //  public IAnnotationHover getAnnotationHover(ISourceViewer sourceViewer) {
+  //    return new PHPAnnotationHover();
+  //  }
+  /*
+   * @see SourceViewerConfiguration#getAnnotationHover(ISourceViewer)
    */
   public IAnnotationHover getAnnotationHover(ISourceViewer sourceViewer) {
     return new PHPAnnotationHover();
@@ -178,20 +203,145 @@ public class PHPSourceViewerConfiguration extends SourceViewerConfiguration {
     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 Smarty source code scanner for this configuration.
+   *
+   * @return the Smarty source code scanner
+   */
+  protected RuleBasedScanner getSmartyScanner() {
+    return fJavaTextTools.getSmartyScanner();
+  }
+
+  /*
+   * @see SourceViewerConfiguration#getReconciler(ISourceViewer)
+   */
+  public IReconciler getReconciler(ISourceViewer sourceViewer) {
+
+    if (getEditor() != null && getEditor().isEditable()) {
+      JavaReconciler reconciler = new JavaReconciler(getEditor(), new JavaReconcilingStrategy(getEditor()), false);
+      reconciler.setProgressMonitor(new NullProgressMonitor());
+      reconciler.setDelay(500);
+      return reconciler;
+    }
+
+    return null;
+  }
+
+  /*
+        * @see SourceViewerConfiguration#getConfiguredTextHoverStateMasks(ISourceViewer, String)
+        * @since 2.1
+        */
+  public int[] getConfiguredTextHoverStateMasks(ISourceViewer sourceViewer, String contentType) {
+    JavaEditorTextHoverDescriptor[] hoverDescs = PHPeclipsePlugin.getDefault().getJavaEditorTextHoverDescriptors();
+    int stateMasks[] = new int[hoverDescs.length];
+    int stateMasksLength = 0;
+    for (int i = 0; i < hoverDescs.length; i++) {
+      if (hoverDescs[i].isEnabled()) {
+        int j = 0;
+        int stateMask = hoverDescs[i].getStateMask();
+        while (j < stateMasksLength) {
+          if (stateMasks[j] == stateMask)
+            break;
+          j++;
+        }
+        if (j == stateMasksLength)
+          stateMasks[stateMasksLength++] = stateMask;
+      }
+    }
+    if (stateMasksLength == hoverDescs.length)
+      return stateMasks;
+
+    int[] shortenedStateMasks = new int[stateMasksLength];
+    System.arraycopy(stateMasks, 0, shortenedStateMasks, 0, stateMasksLength);
+    return shortenedStateMasks;
+  }
+
+  /*
+   * @see SourceViewerConfiguration#getTextHover(ISourceViewer, String, int)
+   * @since 2.1
+   */
+  public ITextHover getTextHover(ISourceViewer sourceViewer, String contentType, int stateMask) {
+    JavaEditorTextHoverDescriptor[] hoverDescs = PHPeclipsePlugin.getDefault().getJavaEditorTextHoverDescriptors();
+    int i = 0;
+    while (i < hoverDescs.length) {
+      if (hoverDescs[i].isEnabled() && hoverDescs[i].getStateMask() == stateMask)
+        return new JavaEditorTextHoverProxy(hoverDescs[i], getEditor());
+      i++;
+    }
+
+    if (fEditor != null) {
+      IEditorInput editorInput = fEditor.getEditorInput();
+      if (editorInput instanceof IFileEditorInput) {
+        try {
+          IFile f = ((IFileEditorInput) editorInput).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#getTextHover(ISourceViewer, String)
+   */
+  public ITextHover getTextHover(ISourceViewer sourceViewer, String contentType) {
+    return getTextHover(sourceViewer, contentType, ITextViewerExtension2.DEFAULT_HOVER_STATE_MASK);
+  }
+
+  /**
+   * Returns the SmartyDoc source code scanner for this configuration.
+   *
+   * @return the SmartyDoc source code scanner
+   */
+  protected RuleBasedScanner getSmartyDocScanner() {
+    return fJavaTextTools.getSmartyDocScanner();
+  }
+
+  /**
+   * Returns the PHPDoc source code scanner for this configuration.
+   *
+   * @return the PHPDoc source code scanner
+   */
+  protected RuleBasedScanner getPHPDocScanner() {
+    return fJavaTextTools.getJavaDocScanner();
+  }
+
   /* (non-Javadoc)
    * Method declared on SourceViewerConfiguration
    */
   public String[] getConfiguredContentTypes(ISourceViewer sourceViewer) {
     return new String[] {
-      //    IDocument.DEFAULT_CONTENT_TYPE,
       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.HTML_MULTILINE_COMMENT,
+      IPHPPartitionScannerConstants.PHP,
+      IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT,
+      IPHPPartitionScannerConstants.CSS,
+      IPHPPartitionScannerConstants.CSS_MULTILINE_COMMENT,
+      IPHPPartitionScannerConstants.JAVASCRIPT,
+      IPHPPartitionScannerConstants.JS_MULTILINE_COMMENT,
+      IPHPPartitionScannerConstants.SMARTY,
+      IPHPPartitionScannerConstants.SMARTY_MULTILINE_COMMENT,
+      IDocument.DEFAULT_CONTENT_TYPE };
   }
 
   /* (non-Javadoc) 
@@ -208,6 +358,9 @@ public class PHPSourceViewerConfiguration extends SourceViewerConfiguration {
     assistant.setContentAssistProcessor(processor, IPHPPartitionScannerConstants.CSS_MULTILINE_COMMENT);
     assistant.setContentAssistProcessor(processor, IPHPPartitionScannerConstants.JAVASCRIPT);
     assistant.setContentAssistProcessor(processor, IPHPPartitionScannerConstants.JS_MULTILINE_COMMENT);
+    // TODO define special smarty partition content assist
+    assistant.setContentAssistProcessor(processor, IPHPPartitionScannerConstants.SMARTY);
+    assistant.setContentAssistProcessor(processor, IPHPPartitionScannerConstants.SMARTY_MULTILINE_COMMENT);
 
     assistant.setContentAssistProcessor(new PHPCompletionProcessor(), IPHPPartitionScannerConstants.PHP);
 
@@ -262,10 +415,10 @@ public class PHPSourceViewerConfiguration extends SourceViewerConfiguration {
 
     // prefix[0] is either '\t' or ' ' x tabWidth, depending on useSpaces
 
-    final IPreferenceStore preferences= PHPeclipsePlugin.getDefault().getPreferenceStore();
-    int tabWidth= preferences.getInt(PHPCore.FORMATTER_TAB_SIZE);
-    boolean useSpaces= getPreferenceStore().getBoolean(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();
 
@@ -295,38 +448,48 @@ public class PHPSourceViewerConfiguration extends SourceViewerConfiguration {
    */
   public IPresentationReconciler getPresentationReconciler(ISourceViewer sourceViewer) {
     //  PHPColorProvider provider = PHPEditorEnvironment.getPHPColorProvider();
-    JavaColorManager 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(PHPEditorEnvironment.getHTMLCodeScanner());
+    dr = new DefaultDamagerRepairer(getHTMLScanner());
     reconciler.setDamager(dr, IPHPPartitionScannerConstants.HTML);
     reconciler.setRepairer(dr, IPHPPartitionScannerConstants.HTML);
-    dr = new DefaultDamagerRepairer(PHPEditorEnvironment.getHTMLCodeScanner());
+    dr = new DefaultDamagerRepairer(getHTMLScanner());
     reconciler.setDamager(dr, IPHPPartitionScannerConstants.CSS);
     reconciler.setRepairer(dr, IPHPPartitionScannerConstants.CSS);
-    dr = new DefaultDamagerRepairer(PHPEditorEnvironment.getHTMLCodeScanner());
+    dr = new DefaultDamagerRepairer(getHTMLScanner());
     reconciler.setDamager(dr, IPHPPartitionScannerConstants.CSS_MULTILINE_COMMENT);
     reconciler.setRepairer(dr, IPHPPartitionScannerConstants.CSS_MULTILINE_COMMENT);
-    dr = new DefaultDamagerRepairer(PHPEditorEnvironment.getHTMLCodeScanner());
+    dr = new DefaultDamagerRepairer(getHTMLScanner());
     reconciler.setDamager(dr, IPHPPartitionScannerConstants.JAVASCRIPT);
     reconciler.setRepairer(dr, IPHPPartitionScannerConstants.JAVASCRIPT);
-    dr = new DefaultDamagerRepairer(PHPEditorEnvironment.getHTMLCodeScanner());
+    dr = new DefaultDamagerRepairer(getHTMLScanner());
     reconciler.setDamager(dr, IPHPPartitionScannerConstants.JS_MULTILINE_COMMENT);
     reconciler.setRepairer(dr, IPHPPartitionScannerConstants.JS_MULTILINE_COMMENT);
+
+    dr = new DefaultDamagerRepairer(getSmartyScanner());
+    reconciler.setDamager(dr, IPHPPartitionScannerConstants.SMARTY);
+    reconciler.setRepairer(dr, IPHPPartitionScannerConstants.SMARTY);
+
+    dr = new DefaultDamagerRepairer(getSmartyDocScanner());
+    reconciler.setDamager(dr, IPHPPartitionScannerConstants.SMARTY_MULTILINE_COMMENT);
+    reconciler.setRepairer(dr, IPHPPartitionScannerConstants.SMARTY_MULTILINE_COMMENT);
+
     dr =
-      new DefaultDamagerRepairer(new SingleTokenScanner(new TextAttribute(provider.getColor(PHPColorProvider.MULTI_LINE_COMMENT))));
+      new DefaultDamagerRepairer(
+        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(PHPEditorEnvironment.getPHPCodeScanner());
+    dr = new DefaultDamagerRepairer(getCodeScanner());
     reconciler.setDamager(dr, IPHPPartitionScannerConstants.PHP);
     reconciler.setRepairer(dr, IPHPPartitionScannerConstants.PHP);
 
-    dr = new DefaultDamagerRepairer(PHPEditorEnvironment.getPHPDocCodeScanner());
+    dr = new DefaultDamagerRepairer(getPHPDocScanner());
     reconciler.setDamager(dr, IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT);
     reconciler.setRepairer(dr, IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT);
 
@@ -343,7 +506,104 @@ public class PHPSourceViewerConfiguration extends SourceViewerConfiguration {
   /* (non-Javadoc)
    * Method declared on SourceViewerConfiguration
    */
-  public ITextHover getTextHover(ISourceViewer sourceViewer, String contentType) {
-    return new PHPTextHover();
+  //  public ITextHover getTextHover(ISourceViewer sourceViewer, String contentType) {
+  //    if (fEditor != null) {
+  //      IEditorInput editorInput = fEditor.getEditorInput();
+  //      if (editorInput instanceof IFileEditorInput) {
+  //        try {
+  //          IFile f = ((IFileEditorInput) editorInput).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);
+      }
+    };
+  }
+
+  /*
+   * @see SourceViewerConfiguration#getInformationPresenter(ISourceViewer)
+   * @since 2.0
+   */
+  //   public IInformationPresenter getInformationPresenter(ISourceViewer sourceViewer) {
+  //           InformationPresenter presenter= new InformationPresenter(getInformationPresenterControlCreator(sourceViewer));
+  //           IInformationProvider provider= new JavaInformationProvider(getEditor());
+  //           presenter.setInformationProvider(provider, IDocument.DEFAULT_CONTENT_TYPE);
+  //           presenter.setInformationProvider(provider, IJavaPartitions.JAVA_DOC);
+  //           presenter.setSizeConstraints(60, 10, true, true);               
+  //           return presenter;
+  //   }
+
+  /**
+   * Returns the information presenter control creator. The creator is a factory creating the
+   * presenter controls for the given source viewer. This implementation always returns a creator
+   * for <code>DefaultInformationControl</code> instances.
+   * 
+   * @param sourceViewer the source viewer to be configured by this configuration
+   * @return an information control creator
+   * @since 2.1
+   */
+  private IInformationControlCreator getInformationPresenterControlCreator(ISourceViewer sourceViewer) {
+    return new IInformationControlCreator() {
+      public IInformationControl createInformationControl(Shell parent) {
+        int shellStyle = SWT.RESIZE;
+        int style = SWT.V_SCROLL | SWT.H_SCROLL;
+        return new DefaultInformationControl(parent, shellStyle, style, new HTMLTextPresenter(false));
+        // return new HoverBrowserControl(parent);
+      }
+    };
+  }
+  /**
+   * Returns the outline presenter control creator. The creator is a factory creating outline
+   * presenter controls for the given source viewer. This implementation always returns a creator
+   * for <code>JavaOutlineInformationControl</code> instances.
+   * 
+   * @param sourceViewer the source viewer to be configured by this configuration
+   * @return an information control creator
+   * @since 2.1
+   */
+  private IInformationControlCreator getOutlinePresenterControlCreator(ISourceViewer sourceViewer) {
+    return new IInformationControlCreator() {
+      public IInformationControl createInformationControl(Shell parent) {
+        int shellStyle = SWT.RESIZE;
+        int treeStyle = SWT.V_SCROLL | SWT.H_SCROLL;
+        return new JavaOutlineInformationControl(parent, shellStyle, treeStyle);
+      }
+    };
+  }
+  /**
+   * Returns the outline presenter which will determine and shown
+   * information requested for the current cursor position.
+   *
+   * @param sourceViewer the source viewer to be configured by this configuration
+   * @param doCodeResolve a boolean which specifies whether code resolve should be used to compute the Java element 
+   * @return an information presenter
+   * @since 2.1
+   */
+  public IInformationPresenter getOutlinePresenter(ISourceViewer sourceViewer, boolean doCodeResolve) {
+    InformationPresenter presenter = new InformationPresenter(getOutlinePresenterControlCreator(sourceViewer));
+    presenter.setAnchor(InformationPresenter.ANCHOR_GLOBAL);
+    IInformationProvider provider = new JavaElementProvider(getEditor(), doCodeResolve);
+    presenter.setInformationProvider(provider, IDocument.DEFAULT_CONTENT_TYPE);
+    presenter.setInformationProvider(provider, IPHPPartitionScannerConstants.PHP);
+    presenter.setInformationProvider(provider, IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT);
+    presenter.setInformationProvider(provider, IPHPPartitionScannerConstants.SMARTY_MULTILINE_COMMENT);
+    presenter.setInformationProvider(provider, IPHPPartitionScannerConstants.HTML);
+    presenter.setInformationProvider(provider, IPHPPartitionScannerConstants.HTML_MULTILINE_COMMENT);
+    presenter.setSizeConstraints(40, 20, true, false);
+    return presenter;
   }
 }