added PHPDoc contexts
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / PHPSourceViewerConfiguration.java
index c6aaad9..4e3bb91 100644 (file)
@@ -11,10 +11,20 @@ Contributors:
 **********************************************************************/
 package net.sourceforge.phpeclipse.phpeditor;
 
+import java.util.Vector;
 
-import java.util.List;
+import net.sourceforge.phpdt.internal.ui.text.java.JavaFormattingStrategy;
+import net.sourceforge.phpdt.internal.ui.text.phpdoc.PHPDocCompletionProcessor;
+import net.sourceforge.phpeclipse.PHPeclipsePlugin;
+import net.sourceforge.phpeclipse.phpeditor.html.HTMLFormattingStrategy;
+import net.sourceforge.phpeclipse.phpeditor.php.HTMLCompletionProcessor;
+import net.sourceforge.phpeclipse.phpeditor.php.IPHPPartitionScannerConstants;
+import net.sourceforge.phpeclipse.phpeditor.php.PHPAutoIndentStrategy;
+import net.sourceforge.phpeclipse.phpeditor.php.PHPCompletionProcessor;
+import net.sourceforge.phpeclipse.phpeditor.php.PHPDoubleClickSelector;
+import net.sourceforge.phpeclipse.phpeditor.util.PHPColorProvider;
 
-import org.eclipse.swt.graphics.RGB;
+import org.eclipse.jface.preference.IPreferenceStore;
 import org.eclipse.jface.text.DefaultAutoIndentStrategy;
 import org.eclipse.jface.text.IAutoIndentStrategy;
 import org.eclipse.jface.text.IDocument;
@@ -23,145 +33,265 @@ 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.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.presentation.IPresentationReconciler;
 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.IToken;
-import org.eclipse.jface.text.rules.RuleBasedDamagerRepairer;
+import org.eclipse.jface.text.rules.DefaultPartitioner;
 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 net.sourceforge.phpeclipse.phpeditor.php.PHPAutoIndentStrategy;
-import net.sourceforge.phpeclipse.phpeditor.php.PHPCompletionProcessor;
-import net.sourceforge.phpeclipse.phpeditor.php.PHPDoubleClickSelector;
-import net.sourceforge.phpeclipse.phpeditor.php.PHPPartitionScanner;
-//import net.sourceforge.phpeclipse.phpeditor.html.JavaDocCompletionProcessor;
-import net.sourceforge.phpeclipse.phpeditor.util.PHPColorProvider;
+import org.eclipse.swt.graphics.RGB;
 
 /**
- * Configuration for an <code>SourceViewer</code> which shows PHP code.
+ * Configuration for an <code>SourceViewer</code> which shows PHP code. 
  */
 public class PHPSourceViewerConfiguration extends SourceViewerConfiguration {
 
-       /**
-        * Single token scanner.
-        */
-       static class SingleTokenScanner extends BufferedRuleBasedScanner {
-               public SingleTokenScanner(TextAttribute attribute) {
-                       setDefaultReturnToken(new Token(attribute));
-               }
-       };
-
-       /**
-        * Default constructor.
-        */
-       public PHPSourceViewerConfiguration() {
-       }
-
-       /* (non-Javadoc)
-        * Method declared on SourceViewerConfiguration
-        */
-       public IAnnotationHover getAnnotationHover(ISourceViewer sourceViewer) {
-               return new PHPAnnotationHover();
-       }
-
-       /* (non-Javadoc)
-        * Method declared on SourceViewerConfiguration
-        */
-       public IAutoIndentStrategy getAutoIndentStrategy(ISourceViewer sourceViewer, String contentType) {
-               return (IDocument.DEFAULT_CONTENT_TYPE.equals(contentType) ? new PHPAutoIndentStrategy() : new DefaultAutoIndentStrategy());
-       }
-
-       /* (non-Javadoc)
-        * Method declared on SourceViewerConfiguration
-        */
-       public String[] getConfiguredContentTypes(ISourceViewer sourceViewer) {
-               return new String[] {
-                       IDocument.DEFAULT_CONTENT_TYPE,
-      PHPPartitionScanner.PHP,
-               //      PHPPartitionScanner.JAVA_DOC,
-                       PHPPartitionScanner.JAVA_MULTILINE_COMMENT };
-       }
-
-       /* (non-Javadoc)
-        * Method declared on SourceViewerConfiguration
-        */
-       public IContentAssistant getContentAssistant(ISourceViewer sourceViewer) {
-
-               ContentAssistant assistant = new ContentAssistant();
-               assistant.setContentAssistProcessor(new PHPCompletionProcessor(), IDocument.DEFAULT_CONTENT_TYPE);
-       //      assistant.setContentAssistProcessor(new JavaDocCompletionProcessor(), PHPPartitionScanner.JAVA_DOC);
-
-               assistant.enableAutoActivation(true);
-               assistant.setAutoActivationDelay(500);
-               assistant.setProposalPopupOrientation(assistant.PROPOSAL_OVERLAY);
-               assistant.setContextInformationPopupOrientation(assistant.CONTEXT_INFO_ABOVE);
-               assistant.setContextInformationPopupBackground(PHPEditorEnvironment.getJavaColorProvider().getColor(new RGB(150, 150, 0)));
-
-               return assistant;
-       }
-
-       /* (non-Javadoc)
-        * Method declared on SourceViewerConfiguration
-        */
-       public String getDefaultPrefix(ISourceViewer sourceViewer, String contentType) {
-               return (IDocument.DEFAULT_CONTENT_TYPE.equals(contentType) ? "//" : null); //$NON-NLS-1$
-       }
-
-       /* (non-Javadoc)
-        * Method declared on SourceViewerConfiguration
-        */
-       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$
-       }
-
-       /* (non-Javadoc)
-        * Method declared on SourceViewerConfiguration
-        */
-       public IPresentationReconciler getPresentationReconciler(ISourceViewer sourceViewer) {
-
-               PHPColorProvider provider = PHPEditorEnvironment.getJavaColorProvider();
-               PresentationReconciler reconciler = new PresentationReconciler();
-
-               DefaultDamagerRepairer 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);
+  public static final String HTML_DEFAULT = IDocument.DEFAULT_CONTENT_TYPE;
+  
+  private PHPEditor fEditor;
+  
+  private ContentFormatter fFormatter;
+  private HTMLFormattingStrategy fFormattingStrategy;
+  /**
+   * Single token scanner.
+   */
+  static class SingleTokenScanner extends BufferedRuleBasedScanner {
+    public SingleTokenScanner(TextAttribute attribute) {
+      setDefaultReturnToken(new Token(attribute));
+    }
+  };
+
+  /**
+   * Default constructor.
+   */
+  public PHPSourceViewerConfiguration(PHPEditor editor) {
+    fEditor = editor;
+  }
+
+  /*
+   * @see SourceViewerConfiguration#getContentFormatter(ISourceViewer)
+   */
+  public IContentFormatter getContentFormatter(ISourceViewer sourceViewer) {
+//    if (fFormatter == null) {
+//      fFormatter = new ContentFormatter();
+//      fFormattingStrategy = new HTMLFormattingStrategy(this, sourceViewer);
+//      fFormatter.setFormattingStrategy(fFormattingStrategy, HTML_DEFAULT);
+//      fFormatter.enablePartitionAwareFormatting(false);
+//      fFormatter.setPartitionManagingPositionCategories(getConfiguredContentTypes(null));
+//    }
+//    return fFormatter;
+    
+    if (fFormatter == null) {
+    //ContentFormatter 
+    fFormatter= new ContentFormatter();
+    IFormattingStrategy strategy= new JavaFormattingStrategy(sourceViewer);
+               
+    fFormatter.setFormattingStrategy(strategy, IDocument.DEFAULT_CONTENT_TYPE);
+    fFormatter.enablePartitionAwareFormatting(false);          
+    fFormatter.setPartitionManagingPositionCategories(getPartitionManagingPositionCategories());
+    }
+    return fFormatter;
+  }
+  
+  /**
+   * Returns the names of the document position categories used by the document
+   * partitioners created by this object to manage their partition information.
+   * If the partitioners don't use document position categories, the returned
+   * result is <code>null</code>.
+   *
+   * @return the partition managing position categories or <code>null</code> 
+   *                   if there is none
+   */
+  public String[] getPartitionManagingPositionCategories() {
+    return new String[] { DefaultPartitioner.CONTENT_TYPES_CATEGORY };
+  }
+//  /** 
+//   * Returns the names of the document position categories used by the document
+//   * partitioners created by this object to manage their partition information.
+//   * If the partitioners don't use document position categories, the returned
+//   * result is <code>null</code>.
+//   *
+//   * @return the partition managing position categories or <code>null</code> 
+//   *                         if there is none
+//   */
+//  private String[] getPartitionManagingPositionCategories() {
+//    return new String[] { DefaultPartitioner.CONTENT_TYPES_CATEGORY };
+//  } 
+  
+  public PHPEditor getEditor() {
+    return fEditor;
+  }
+  /* (non-Javadoc)
+   * Method declared on SourceViewerConfiguration
+   */
+  public IAnnotationHover getAnnotationHover(ISourceViewer sourceViewer) {
+    return new PHPAnnotationHover();
+  }
+
+  /* (non-Javadoc)
+   * Method declared on SourceViewerConfiguration
+   */
+  public IAutoIndentStrategy getAutoIndentStrategy(ISourceViewer sourceViewer, String contentType) {
+    return (IDocument.DEFAULT_CONTENT_TYPE.equals(contentType) ? new PHPAutoIndentStrategy() : new DefaultAutoIndentStrategy());
+  }
+
+/* (non-Javadoc)
+ * Method declared on 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.CSS,
+        IPHPPartitionScannerConstants.CSS_MULTILINE_COMMENT,
+        IPHPPartitionScannerConstants.JAVASCRIPT,
+        IPHPPartitionScannerConstants.JS_MULTILINE_COMMENT
+        };
+  }
+
+  /* (non-Javadoc) 
+   * Method declared on 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)));
+
+    return assistant;
+  }
+
+  /* (non-Javadoc)
+   * Method declared on SourceViewerConfiguration
+   */
+//  public String getDefaultPrefix(ISourceViewer sourceViewer, String contentType) {
+//    return (PHPPartitionScanner.PHP.equals(contentType) ? "//" : null); //$NON-NLS-1$
+//    // return (IDocument.DEFAULT_CONTENT_TYPE.equals(contentType) ? "//" : null); //$NON-NLS-1$
+//  }
+
+  /*
+   * @see SourceViewerConfiguration#getDefaultPrefix(ISourceViewer, String)
+   * @since 2.0
+   */
+  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) {
+    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) {
+
+    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);
+    
+    for (int i= 0; i <= tabWidth; i++) {
+        StringBuffer prefix= new StringBuffer();
+
+      if (useSpaces) {
+          for (int j= 0; j + i < tabWidth; j++)
+            prefix.append(' ');
+          
+        if (i != 0)
+            prefix.append('\t');        
+      } else {    
+          for (int j= 0; j < i; j++)
+            prefix.append(' ');
+          
+        if (i != tabWidth)
+            prefix.append('\t');
+      }
+      
+      vector.add(prefix.toString());
+    }
+
+    vector.add(""); //$NON-NLS-1$
+    
+    return (String[]) vector.toArray(new String[vector.size()]);
+  }
+  /* (non-Javadoc)
+   * Method declared on SourceViewerConfiguration
+   */
+  public IPresentationReconciler getPresentationReconciler(ISourceViewer sourceViewer) {
+
+    PHPColorProvider provider = PHPEditorEnvironment.getPHPColorProvider();
+    PresentationReconciler reconciler = new PresentationReconciler();
+    
+    DefaultDamagerRepairer dr= new DefaultDamagerRepairer(PHPEditorEnvironment.getHTMLCodeScanner());
+    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, PHPPartitionScanner.PHP);
-    reconciler.setRepairer(dr, PHPPartitionScanner.PHP);
+    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(new SingleTokenScanner(new TextAttribute(provider.getColor(provider.JAVADOC_DEFAULT))));
-//             reconciler.setDamager(dr, PHPPartitionScanner.JAVA_DOC);
-//             reconciler.setRepairer(dr, PHPPartitionScanner.JAVA_DOC);
-
-               dr = new DefaultDamagerRepairer(new SingleTokenScanner(new TextAttribute(provider.getColor(provider.MULTI_LINE_COMMENT))));
-               reconciler.setDamager(dr, PHPPartitionScanner.JAVA_MULTILINE_COMMENT);
-               reconciler.setRepairer(dr, PHPPartitionScanner.JAVA_MULTILINE_COMMENT);
-
-               return reconciler;
-       }
-
-       /* (non-Javadoc)
-        * Method declared on SourceViewerConfiguration
-        */
-       public int getTabWidth(ISourceViewer sourceViewer) {
-               return 4;
-       }
-
-       /* (non-Javadoc)
-        * Method declared on SourceViewerConfiguration
-        */
-       public ITextHover getTextHover(ISourceViewer sourceViewer, String contentType) {
-               return new PHPTextHover();
-       }
+//    dr = new DefaultDamagerRepairer(PHPEditorEnvironment.getHTMLCodeScanner());
+//    reconciler.setDamager(dr, PHPPartitionScanner.HTML);
+//    reconciler.setRepairer(dr, PHPPartitionScanner.HTML);
+
+    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);
+
+    return reconciler;
+  }
+
+  /* (non-Javadoc)
+   * Method declared on SourceViewerConfiguration
+   */
+  public int getTabWidth(ISourceViewer sourceViewer) {
+    return 4;
+  }
+
+  /* (non-Javadoc)
+   * Method declared on SourceViewerConfiguration
+   */
+  public ITextHover getTextHover(ISourceViewer sourceViewer, String contentType) {
+    return new PHPTextHover();
+  }
 }