improved include detection
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / ui / text / JavaTextTools.java
index 6d4f394..5c025c8 100644 (file)
@@ -5,22 +5,28 @@ package net.sourceforge.phpdt.ui.text;
  * All Rights Reserved.
  */
 
-import net.sourceforge.phpdt.internal.ui.text.FastJavaPartitionScanner;
+import net.sourceforge.phpdt.internal.ui.text.IPHPPartitions;
 import net.sourceforge.phpdt.internal.ui.text.JavaColorManager;
 import net.sourceforge.phpdt.internal.ui.text.phpdoc.PHPDocCodeScanner;
 import net.sourceforge.phpeclipse.IPreferenceConstants;
 import net.sourceforge.phpeclipse.phpeditor.php.HTMLCodeScanner;
 import net.sourceforge.phpeclipse.phpeditor.php.PHPCodeScanner;
+import net.sourceforge.phpeclipse.phpeditor.php.PHPPartitionScanner;
 import net.sourceforge.phpeclipse.phpeditor.php.SmartyCodeScanner;
 import net.sourceforge.phpeclipse.phpeditor.php.SmartyDocCodeScanner;
 
+import org.eclipse.core.resources.IFile;
+import org.eclipse.core.runtime.Preferences;
 import org.eclipse.jface.preference.IPreferenceStore;
+import org.eclipse.jface.text.IDocument;
+import org.eclipse.jface.text.IDocumentExtension3;
 import org.eclipse.jface.text.IDocumentPartitioner;
 import org.eclipse.jface.text.rules.DefaultPartitioner;
 import org.eclipse.jface.text.rules.IPartitionTokenScanner;
 import org.eclipse.jface.text.rules.RuleBasedScanner;
 import org.eclipse.jface.util.IPropertyChangeListener;
 import org.eclipse.jface.util.PropertyChangeEvent;
+import org.eclipse.ui.part.FileEditorInput;
 //
 //import org.phpeclipse.phpdt.internal.ui.text.FastJavaPartitionScanner;
 //import org.phpeclipse.phpdt.internal.ui.text.JavaColorManager;
@@ -40,10 +46,35 @@ import org.eclipse.jface.util.PropertyChangeEvent;
  */
 public class JavaTextTools {
 
-  private class PreferenceListener implements IPropertyChangeListener {
+  private static PHPPartitionScanner HTML_PARTITION_SCANNER = null;
+
+  private static PHPPartitionScanner PHP_PARTITION_SCANNER = null;
+  private static PHPPartitionScanner SMARTY_PARTITION_SCANNER = null;
+
+  // private final static String[] TYPES= new String[] { PHPPartitionScanner.PHP, PHPPartitionScanner.JAVA_DOC, PHPPartitionScanner.JAVA_MULTILINE_COMMENT };
+  private final static String[] TYPES =
+    new String[] {
+      IPHPPartitions.PHP_PARTITIONING,
+      IPHPPartitions.PHP_PHPDOC_COMMENT,
+      IPHPPartitions.HTML,
+      IPHPPartitions.HTML_MULTILINE_COMMENT,
+      IPHPPartitions.JAVASCRIPT,
+      IPHPPartitions.CSS,
+      IPHPPartitions.SMARTY,
+      IPHPPartitions.SMARTY_MULTILINE_COMMENT };
+  private static PHPPartitionScanner XML_PARTITION_SCANNER = null;
+
+  /**
+   * This tools' preference listener. 
+   */
+  private class PreferenceListener implements IPropertyChangeListener, Preferences.IPropertyChangeListener {
     public void propertyChange(PropertyChangeEvent event) {
       adaptToPreferenceChange(event);
     }
+    public void propertyChange(Preferences.PropertyChangeEvent event) {
+      adaptToPreferenceChange(
+        new PropertyChangeEvent(event.getSource(), event.getProperty(), event.getOldValue(), event.getNewValue()));
+    }
   };
 
   /** The color manager */
@@ -65,10 +96,15 @@ public class JavaTextTools {
   /** The SmartyDoc scanner */
   private SmartyDocCodeScanner fSmartyDocScanner;
   /** The Java partitions scanner */
-  private FastJavaPartitionScanner fPartitionScanner;
+  private PHPPartitionScanner fPartitionScanner;
 
   /** The preference store */
   private IPreferenceStore fPreferenceStore;
+  /**
+   * The core preference store.
+   * @since 2.1
+   */
+  private Preferences fCorePreferenceStore;
   /** The preference change listener */
   private PreferenceListener fPreferenceListener = new PreferenceListener();
 
@@ -96,7 +132,45 @@ public class JavaTextTools {
     fHTMLScanner = new HTMLCodeScanner(fColorManager, store);
     fSmartyScanner = new SmartyCodeScanner(fColorManager, store);
     fSmartyDocScanner = new SmartyDocCodeScanner(fColorManager, store);
-    fPartitionScanner = new FastJavaPartitionScanner();
+//    fPartitionScanner = new FastJavaPartitionScanner();
+    fPartitionScanner = new PHPPartitionScanner();
+  }
+
+  /**
+   * Creates a new Java text tools collection.
+   * 
+   * @param store the preference store to initialize the text tools. The text tool
+   *                   instance installs a listener on the passed preference store to adapt itself to 
+   *                   changes in the preference store. In general <code>PreferenceConstants.
+   *                   getPreferenceStore()</code> shoould be used to initialize the text tools.
+   * @param coreStore optional preference store to initialize the text tools. The text tool
+   *                   instance installs a listener on the passed preference store to adapt itself to 
+   *                   changes in the preference store.
+   * @param autoDisposeOnDisplayDispose        if <code>true</code>  the color manager
+   *                   automatically disposes all managed colors when the current display gets disposed
+   *                   and all calls to {@link org.eclipse.jface.text.source.ISharedTextColors#dispose()} are ignored.
+   * @see org.eclipse.jdt.ui.PreferenceConstants#getPreferenceStore()
+   * @since 2.1
+   */
+  public JavaTextTools(IPreferenceStore store, Preferences coreStore, boolean autoDisposeOnDisplayDispose) {
+    fPreferenceStore = store;
+    fPreferenceStore.addPropertyChangeListener(fPreferenceListener);
+
+    fCorePreferenceStore = coreStore;
+    if (fCorePreferenceStore != null)
+      fCorePreferenceStore.addPropertyChangeListener(fPreferenceListener);
+
+    fColorManager = new JavaColorManager(autoDisposeOnDisplayDispose);
+    fCodeScanner = new PHPCodeScanner(fColorManager, store);
+    fMultilineCommentScanner = new SingleTokenPHPScanner(fColorManager, store, IPreferenceConstants.PHP_MULTILINE_COMMENT);
+    fSinglelineCommentScanner = new SingleTokenPHPScanner(fColorManager, store, IPreferenceConstants.PHP_SINGLELINE_COMMENT);
+    fStringScanner = new SingleTokenPHPScanner(fColorManager, store, IPreferenceConstants.PHP_STRING);
+    fPHPDocScanner = new PHPDocCodeScanner(fColorManager, store);
+    fHTMLScanner = new HTMLCodeScanner(fColorManager, store);
+    fSmartyScanner = new SmartyCodeScanner(fColorManager, store);
+    fSmartyDocScanner = new SmartyDocCodeScanner(fColorManager, store);
+  //  fPartitionScanner = new FastJavaPartitionScanner();
+    fPartitionScanner = new PHPPartitionScanner();
   }
 
   /**
@@ -119,6 +193,12 @@ public class JavaTextTools {
     if (fPreferenceStore != null) {
       fPreferenceStore.removePropertyChangeListener(fPreferenceListener);
       fPreferenceStore = null;
+
+      if (fCorePreferenceStore != null) {
+        fCorePreferenceStore.removePropertyChangeListener(fPreferenceListener);
+        fCorePreferenceStore = null;
+      }
+
       fPreferenceListener = null;
     }
   }
@@ -230,24 +310,111 @@ public class JavaTextTools {
   }
 
   /**
-   * Factory method for creating a Java-specific document partitioner
+   * Factory method for creating a PHP-specific document partitioner
    * using this object's partitions scanner. This method is a 
    * convenience method.
    *
    * @return a newly created Java document partitioner
    */
   public IDocumentPartitioner createDocumentPartitioner() {
+    return createDocumentPartitioner(".php");
+  }
 
-    String[] types =
-      new String[] {
-        FastJavaPartitionScanner.JAVA_DOC,
-        FastJavaPartitionScanner.JAVA_MULTI_LINE_COMMENT,
-        FastJavaPartitionScanner.JAVA_SINGLE_LINE_COMMENT,
-        FastJavaPartitionScanner.JAVA_STRING };
+  /**
+   * Factory method for creating a PHP-specific document partitioner
+   * using this object's partitions scanner. This method is a 
+   * convenience method.
+   *
+   * @return a newly created Java document partitioner
+   */
+  public IDocumentPartitioner createDocumentPartitioner(String extension) {
 
-    return new DefaultPartitioner(getPartitionScanner(), types);
-  }
+    //    String[] types =
+    //      new String[] {
+    //        FastJavaPartitionScanner.JAVA_DOC,
+    //        FastJavaPartitionScanner.JAVA_MULTI_LINE_COMMENT,
+    //        FastJavaPartitionScanner.JAVA_SINGLE_LINE_COMMENT,
+    //        FastJavaPartitionScanner.JAVA_STRING };
+    //
+    //    return new DefaultPartitioner(getPartitionScanner(), types);
+    IDocumentPartitioner partitioner = null;
+    // System.out.println(extension);
+    if (extension.equalsIgnoreCase(".html") || extension.equalsIgnoreCase(".htm")) {
+      // html
+      partitioner = createHTMLPartitioner();
+    } else if (extension.equalsIgnoreCase(".xml")) {
+      // xml
+      partitioner = createXMLPartitioner();
+    } else if (extension.equalsIgnoreCase(".js")) {
+      // javascript
+      partitioner = createJavaScriptPartitioner();
+    } else if (extension.equalsIgnoreCase(".css")) {
+      // cascading style sheets
+      partitioner = createCSSPartitioner();
+    } else if (extension.equalsIgnoreCase(".tpl")) {
+      // smarty ?
+      partitioner = createSmartyPartitioner();
+    } else if (extension.equalsIgnoreCase(".inc")) {
+      // php include files ?
+      partitioner = createIncludePartitioner();
+    }
+
+    if (partitioner == null) {
+      partitioner = createPHPPartitioner();
+    }
 
+    return partitioner;
+  }
+       /**
+        * Sets up the Java document partitioner for the given document for the default partitioning.
+        * 
+        * @param document the document to be set up
+        * @since 3.0
+        */
+       public void setupJavaDocumentPartitioner(IDocument document) {
+               setupJavaDocumentPartitioner(document, IDocumentExtension3.DEFAULT_PARTITIONING,null);
+       }
+       /**
+        * Sets up the Java document partitioner for the given document for the given partitioning.
+        * @param document the document to be set up
+        * @param partitioning the document partitioning
+        * @param element TODO
+        * 
+        * @since 3.0
+        */
+       public void setupJavaDocumentPartitioner(IDocument document, String partitioning, Object element) {
+               IDocumentPartitioner partitioner = createDocumentPartitioner(".php");
+                        
+//             if (document instanceof IDocumentExtension3) {
+//                     IDocumentExtension3 extension3= (IDocumentExtension3) document;
+//                     extension3.setDocumentPartitioner(partitioning, partitioner);
+//             } else {
+                       document.setDocumentPartitioner(partitioner);
+//             }
+               partitioner.connect(document);
+       }
+       public void setupHTMLDocumentPartitioner(IDocument document, String partitioning, Object element) {
+               IDocumentPartitioner partitioner = createDocumentPartitioner(".html");
+                        
+//             if (document instanceof IDocumentExtension3) {
+//                     IDocumentExtension3 extension3= (IDocumentExtension3) document;
+//                     extension3.setDocumentPartitioner(partitioning, partitioner);
+//             } else {
+                       document.setDocumentPartitioner(partitioner);
+//             }
+               partitioner.connect(document);
+       }
+       public void setupSmartyDocumentPartitioner(IDocument document, String partitioning, Object element) {
+               IDocumentPartitioner partitioner = createDocumentPartitioner(".tpl");
+                        
+//             if (document instanceof IDocumentExtension3) {
+//                     IDocumentExtension3 extension3= (IDocumentExtension3) document;
+//                     extension3.setDocumentPartitioner(partitioning, partitioner);
+//             } else {
+                       document.setDocumentPartitioner(partitioner);
+//             }
+               partitioner.connect(document);
+       }
   /**
    * Returns the names of the document position categories used by the document
    * partitioners created by this object to manage their partition information.
@@ -297,4 +464,73 @@ public class JavaTextTools {
     if (fPHPDocScanner.affectsBehavior(event))
       fPHPDocScanner.adaptToPreferenceChange(event);
   }
+
+  /**
+        * Return a partitioner for .html files.
+        */
+  private static IDocumentPartitioner createHTMLPartitioner() {
+    return new DefaultPartitioner(getHTMLPartitionScanner(), TYPES);
+  }
+
+  private static IDocumentPartitioner createIncludePartitioner() {
+    return new DefaultPartitioner(getPHPPartitionScanner(), TYPES);
+  }
+
+  private static IDocumentPartitioner createJavaScriptPartitioner() {
+    return new DefaultPartitioner(getHTMLPartitionScanner(), TYPES);
+  }
+
+  /**
+       * Return a partitioner for .php files.
+       */
+  private static IDocumentPartitioner createPHPPartitioner() {
+    return new DefaultPartitioner(getPHPPartitionScanner(), TYPES);
+  }
+
+  private static IDocumentPartitioner createSmartyPartitioner() {
+    return new DefaultPartitioner(getSmartyPartitionScanner(), TYPES);
+  }
+
+  private static IDocumentPartitioner createXMLPartitioner() {
+    return new DefaultPartitioner(getXMLPartitionScanner(), TYPES);
+  }
+
+  private static IDocumentPartitioner createCSSPartitioner() {
+    return new DefaultPartitioner(getHTMLPartitionScanner(), TYPES);
+  }
+  /**
+       * Return a scanner for creating html partitions.
+       */
+  private static PHPPartitionScanner getHTMLPartitionScanner() {
+    if (HTML_PARTITION_SCANNER == null)
+      HTML_PARTITION_SCANNER = new PHPPartitionScanner(IPHPPartitions.HTML_FILE);
+    return HTML_PARTITION_SCANNER;
+  }
+  /**
+       * Return a scanner for creating php partitions.
+       */
+  private static PHPPartitionScanner getPHPPartitionScanner() {
+    if (PHP_PARTITION_SCANNER == null)
+      PHP_PARTITION_SCANNER = new PHPPartitionScanner(IPHPPartitions.PHP_FILE);
+    return PHP_PARTITION_SCANNER;
+  }
+
+  /**
+       * Return a scanner for creating smarty partitions.
+       */
+  private static PHPPartitionScanner getSmartyPartitionScanner() {
+    if (SMARTY_PARTITION_SCANNER == null)
+      SMARTY_PARTITION_SCANNER = new PHPPartitionScanner(IPHPPartitions.SMARTY_FILE);
+    return SMARTY_PARTITION_SCANNER;
+  }
+
+  /**
+       * Return a scanner for creating xml partitions.
+       */
+  private static PHPPartitionScanner getXMLPartitionScanner() {
+    if (XML_PARTITION_SCANNER == null)
+      XML_PARTITION_SCANNER = new PHPPartitionScanner(IPHPPartitions.XML_FILE);
+    return XML_PARTITION_SCANNER;
+  }
+
 }
\ No newline at end of file