fix from durel_b:
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / ui / text / JavaTextTools.java
index b727794..6d4f394 100644 (file)
@@ -8,8 +8,11 @@ package net.sourceforge.phpdt.ui.text;
 import net.sourceforge.phpdt.internal.ui.text.FastJavaPartitionScanner;
 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.SmartyCodeScanner;
+import net.sourceforge.phpeclipse.phpeditor.php.SmartyDocCodeScanner;
 
 import org.eclipse.jface.preference.IPreferenceStore;
 import org.eclipse.jface.text.IDocumentPartitioner;
@@ -26,7 +29,6 @@ import org.eclipse.jface.util.PropertyChangeEvent;
 //import org.phpeclipse.phpdt.internal.ui.text.php.JavaCodeScanner;
 //import org.phpeclipse.phpdt.internal.ui.text.phpdoc.JavaDocScanner;
 
-
 /**
  * Tools required to configure a Java text viewer. 
  * The color manager and all scanner exist only one time, i.e.
@@ -37,114 +39,119 @@ import org.eclipse.jface.util.PropertyChangeEvent;
  * </p>
  */
 public class JavaTextTools {
-       
-       private class PreferenceListener implements IPropertyChangeListener {
-               public void propertyChange(PropertyChangeEvent event) {
-                       adaptToPreferenceChange(event);
-               }
-       };
-               
-       /** The color manager */
-       private JavaColorManager fColorManager;
-       /** The PHP source code scanner */
-       private PHPCodeScanner fCodeScanner;
-       /** The PHP multiline comment scanner */
-       private SingleTokenPHPScanner fMultilineCommentScanner;
-       /** The Java singleline comment scanner */
-       private SingleTokenPHPScanner fSinglelineCommentScanner;
-       /** The Java string scanner */
-       private SingleTokenPHPScanner fStringScanner;
-       /** The PHPDoc scanner */
-       private PHPDocCodeScanner fJavaDocScanner;
+
+  private class PreferenceListener implements IPropertyChangeListener {
+    public void propertyChange(PropertyChangeEvent event) {
+      adaptToPreferenceChange(event);
+    }
+  };
+
+  /** The color manager */
+  private JavaColorManager fColorManager;
+  /** The PHP source code scanner */
+  private PHPCodeScanner fCodeScanner;
+  /** The PHP multiline comment scanner */
+  private SingleTokenPHPScanner fMultilineCommentScanner;
+  /** The Java singleline comment scanner */
+  private SingleTokenPHPScanner fSinglelineCommentScanner;
+  /** The Java string scanner */
+  private SingleTokenPHPScanner fStringScanner;
+  /** The PHPDoc scanner */
+  private PHPDocCodeScanner fPHPDocScanner;
   /** The HTML scanner */
   private HTMLCodeScanner fHTMLScanner;
-       /** The Java partitions scanner */
-       private FastJavaPartitionScanner fPartitionScanner;     
-       
-       /** The preference store */
-       private IPreferenceStore fPreferenceStore;
-       /** The preference change listener */
-       private PreferenceListener fPreferenceListener= new PreferenceListener();
+  /** The Smarty scanner */
+  private SmartyCodeScanner fSmartyScanner;
+  /** The SmartyDoc scanner */
+  private SmartyDocCodeScanner fSmartyDocScanner;
+  /** The Java partitions scanner */
+  private FastJavaPartitionScanner fPartitionScanner;
+
+  /** The preference store */
+  private IPreferenceStore fPreferenceStore;
+  /** The preference change listener */
+  private PreferenceListener fPreferenceListener = new PreferenceListener();
+
+  /**
+   * 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.
+   * 
+   * @see org.phpeclipse.phpdt.ui.PreferenceConstants#getPreferenceStore()
+   * @since 2.0
+   */
+  public JavaTextTools(IPreferenceStore store) {
+    fPreferenceStore = store;
+    fPreferenceStore.addPropertyChangeListener(fPreferenceListener);
 
-       
-       /**
-        * 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.
-        * 
-        * @see org.phpeclipse.phpdt.ui.PreferenceConstants#getPreferenceStore()
-        * @since 2.0
-        */
-       public JavaTextTools(IPreferenceStore store) {
-               fPreferenceStore= store;
-               fPreferenceStore.addPropertyChangeListener(fPreferenceListener);
-               
-               fColorManager= new JavaColorManager();
-               fCodeScanner= new PHPCodeScanner(fColorManager, store);
-               fMultilineCommentScanner= new SingleTokenPHPScanner(fColorManager, store, IJavaColorConstants.PHP_MULTI_LINE_COMMENT);
-               fSinglelineCommentScanner= new SingleTokenPHPScanner(fColorManager, store, IJavaColorConstants.PHP_SINGLE_LINE_COMMENT);
-               fStringScanner= new SingleTokenPHPScanner(fColorManager, store, IJavaColorConstants.PHP_STRING);
-               fJavaDocScanner= new PHPDocCodeScanner(fColorManager, store);
-    fHTMLScanner= new HTMLCodeScanner(fColorManager, store);
-               fPartitionScanner= new FastJavaPartitionScanner();
-       }
-       
-       /**
-        * Disposes all the individual tools of this tools collection.
-        */
-       public void dispose() {
-               
-               fCodeScanner= null;
-               fMultilineCommentScanner= null;
-               fSinglelineCommentScanner= null;
-               fStringScanner= null;
-               fJavaDocScanner= null;
-               fPartitionScanner= null;
-               
-               if (fColorManager != null) {
-                       fColorManager.dispose();
-                       fColorManager= null;
-               }
-               
-               if (fPreferenceStore != null) {
-                       fPreferenceStore.removePropertyChangeListener(fPreferenceListener);
-                       fPreferenceStore= null;
-                       fPreferenceListener= null;
-               }
-       }
-       
-       /**
-        * Returns the color manager which is used to manage
-        * any Java-specific colors needed for such things like syntax highlighting.
-        *
-        * @return the color manager to be used for Java text viewers
-        */
-       public JavaColorManager getColorManager() {
-               return fColorManager;
-       }
-       
-       /**
-        * Returns a scanner which is configured to scan Java source code.
-        *
-        * @return a Java source code scanner
-        */
-       public RuleBasedScanner getCodeScanner() {
-               return fCodeScanner;
-       }
-       
-       /**
-        * Returns a scanner which is configured to scan Java multiline comments.
-        *
-        * @return a Java multiline comment scanner
-        * 
-        * @since 2.0
-        */
-       public RuleBasedScanner getMultilineCommentScanner() {
-               return fMultilineCommentScanner;
-       }
+    fColorManager = new JavaColorManager();
+    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();
+  }
+
+  /**
+   * Disposes all the individual tools of this tools collection.
+   */
+  public void dispose() {
+
+    fCodeScanner = null;
+    fMultilineCommentScanner = null;
+    fSinglelineCommentScanner = null;
+    fStringScanner = null;
+    fPHPDocScanner = null;
+    fPartitionScanner = null;
+
+    if (fColorManager != null) {
+      fColorManager.dispose();
+      fColorManager = null;
+    }
+
+    if (fPreferenceStore != null) {
+      fPreferenceStore.removePropertyChangeListener(fPreferenceListener);
+      fPreferenceStore = null;
+      fPreferenceListener = null;
+    }
+  }
+
+  /**
+   * Returns the color manager which is used to manage
+   * any Java-specific colors needed for such things like syntax highlighting.
+   *
+   * @return the color manager to be used for Java text viewers
+   */
+  public IColorManager getColorManager() {
+    return fColorManager;
+  }
+
+  /**
+   * Returns a scanner which is configured to scan Java source code.
+   *
+   * @return a Java source code scanner
+   */
+  public RuleBasedScanner getCodeScanner() {
+    return fCodeScanner;
+  }
+
+  /**
+   * Returns a scanner which is configured to scan Java multiline comments.
+   *
+   * @return a Java multiline comment scanner
+   * 
+   * @since 2.0
+   */
+  public RuleBasedScanner getMultilineCommentScanner() {
+    return fMultilineCommentScanner;
+  }
 
   /**
    * Returns a scanner which is configured to scan HTML code.
@@ -155,118 +162,139 @@ public class JavaTextTools {
    */
   public RuleBasedScanner getHTMLScanner() {
     return fHTMLScanner;
-  } 
-  
-       /**
-        * Returns a scanner which is configured to scan Java singleline comments.
-        *
-        * @return a Java singleline comment scanner
-        * 
-        * @since 2.0
-        */
-       public RuleBasedScanner getSinglelineCommentScanner() {
-               return fSinglelineCommentScanner;
-       }
-       
-       /**
-        * Returns a scanner which is configured to scan Java strings.
-        *
-        * @return a Java string scanner
-        * 
-        * @since 2.0
-        */
-       public RuleBasedScanner getStringScanner() {
-               return fStringScanner;
-       }
-       
-       /**
-        * Returns a scanner which is configured to scan JavaDoc compliant comments.
-        * Notes that the start sequence "/**" and the corresponding end sequence
-        * are part of the JavaDoc comment.
-        *
-        * @return a JavaDoc scanner
-        */
-       public RuleBasedScanner getJavaDocScanner() {
-               return fJavaDocScanner;
-       }
-       
-       /**
-        * Returns a scanner which is configured to scan 
-        * Java-specific partitions, which are multi-line comments,
-        * JavaDoc comments, and regular Java source code.
-        *
-        * @return a Java partition scanner
-        */
-       public IPartitionTokenScanner getPartitionScanner() {
-               return fPartitionScanner;
-       }
-       
-       /**
-        * Factory method for creating a Java-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[] types= new String[] {
-      FastJavaPartitionScanner.JAVA_DOC,
-      FastJavaPartitionScanner.JAVA_MULTI_LINE_COMMENT,
-      FastJavaPartitionScanner.JAVA_SINGLE_LINE_COMMENT,
-      FastJavaPartitionScanner.JAVA_STRING
-               };
+  }
 
-               return new DefaultPartitioner(getPartitionScanner(), types);
-       }
-       
-       /**
-        * 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 };
-       }
-       
-       /**
-        * Determines whether the preference change encoded by the given event
-        * changes the behavior of one its contained components.
-        * 
-        * @param event the event to be investigated
-        * @return <code>true</code> if event causes a behavioral change
-        * 
-        * @since 2.0
-        */
-       public boolean affectsBehavior(PropertyChangeEvent event) {
-               return // fCodeScanner.affectsBehavior(event) ||
-                                       fMultilineCommentScanner.affectsBehavior(event) ||
-                                       fSinglelineCommentScanner.affectsBehavior(event) ||
-                                       fStringScanner.affectsBehavior(event); // ||
-//                                     fJavaDocScanner.affectsBehavior(event);
-       }
-       
-       /**
-        * Adapts the behavior of the contained components to the change
-        * encoded in the given event.
-        * 
-        * @param event the event to which to adapt
-        * @since 2.0
-        */
-       protected void adaptToPreferenceChange(PropertyChangeEvent event) {
-//             if (fCodeScanner.affectsBehavior(event))
-//                     fCodeScanner.adaptToPreferenceChange(event);
-               if (fMultilineCommentScanner.affectsBehavior(event))
-                       fMultilineCommentScanner.adaptToPreferenceChange(event);
-               if (fSinglelineCommentScanner.affectsBehavior(event))
-                       fSinglelineCommentScanner.adaptToPreferenceChange(event);
-               if (fStringScanner.affectsBehavior(event))
-                       fStringScanner.adaptToPreferenceChange(event);
-//             if (fJavaDocScanner.affectsBehavior(event))
-//                     fJavaDocScanner.adaptToPreferenceChange(event);
-       }
+  /**
+   * Returns a scanner which is configured to scan Smarty code.
+   *
+   * @return a Smarty scanner
+   * 
+   * @since 2.0
+   */
+  public RuleBasedScanner getSmartyScanner() {
+    return fSmartyScanner;
+  }
+
+  /**
+        * Returns a scanner which is configured to scan Smarty code.
+        *
+        * @return a Smarty scanner
+        * 
+        * @since 2.0
+        */
+  public RuleBasedScanner getSmartyDocScanner() {
+    return fSmartyDocScanner;
+  }
+  /**
+   * Returns a scanner which is configured to scan Java singleline comments.
+   *
+   * @return a Java singleline comment scanner
+   * 
+   * @since 2.0
+   */
+  public RuleBasedScanner getSinglelineCommentScanner() {
+    return fSinglelineCommentScanner;
+  }
+
+  /**
+   * Returns a scanner which is configured to scan Java strings.
+   *
+   * @return a Java string scanner
+   * 
+   * @since 2.0
+   */
+  public RuleBasedScanner getStringScanner() {
+    return fStringScanner;
+  }
+
+  /**
+   * Returns a scanner which is configured to scan JavaDoc compliant comments.
+   * Notes that the start sequence "/**" and the corresponding end sequence
+   * are part of the JavaDoc comment.
+   *
+   * @return a JavaDoc scanner
+   */
+  public RuleBasedScanner getJavaDocScanner() {
+    return fPHPDocScanner;
+  }
+
+  /**
+   * Returns a scanner which is configured to scan 
+   * Java-specific partitions, which are multi-line comments,
+   * JavaDoc comments, and regular Java source code.
+   *
+   * @return a Java partition scanner
+   */
+  public IPartitionTokenScanner getPartitionScanner() {
+    return fPartitionScanner;
+  }
+
+  /**
+   * Factory method for creating a Java-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[] types =
+      new String[] {
+        FastJavaPartitionScanner.JAVA_DOC,
+        FastJavaPartitionScanner.JAVA_MULTI_LINE_COMMENT,
+        FastJavaPartitionScanner.JAVA_SINGLE_LINE_COMMENT,
+        FastJavaPartitionScanner.JAVA_STRING };
+
+    return new DefaultPartitioner(getPartitionScanner(), types);
+  }
+
+  /**
+   * 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 };
+  }
+
+  /**
+   * Determines whether the preference change encoded by the given event
+   * changes the behavior of one its contained components.
+   * 
+   * @param event the event to be investigated
+   * @return <code>true</code> if event causes a behavioral change
+   * 
+   * @since 2.0
+   */
+  public boolean affectsBehavior(PropertyChangeEvent event) {
+    return fCodeScanner.affectsBehavior(event)
+      || fMultilineCommentScanner.affectsBehavior(event)
+      || fSinglelineCommentScanner.affectsBehavior(event)
+      || fStringScanner.affectsBehavior(event)
+      || fPHPDocScanner.affectsBehavior(event);
+  }
+
+  /**
+   * Adapts the behavior of the contained components to the change
+   * encoded in the given event.
+   * 
+   * @param event the event to which to adapt
+   * @since 2.0
+   */
+  protected void adaptToPreferenceChange(PropertyChangeEvent event) {
+    if (fCodeScanner.affectsBehavior(event))
+      fCodeScanner.adaptToPreferenceChange(event);
+    if (fMultilineCommentScanner.affectsBehavior(event))
+      fMultilineCommentScanner.adaptToPreferenceChange(event);
+    if (fSinglelineCommentScanner.affectsBehavior(event))
+      fSinglelineCommentScanner.adaptToPreferenceChange(event);
+    if (fStringScanner.affectsBehavior(event))
+      fStringScanner.adaptToPreferenceChange(event);
+    if (fPHPDocScanner.affectsBehavior(event))
+      fPHPDocScanner.adaptToPreferenceChange(event);
+  }
 }
\ No newline at end of file