net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/ui/text/JavaTextTools.java

   1 package net.sourceforge.phpdt.ui.text;
   2
   3 /*
   4  * (c) Copyright IBM Corp. 2000, 2001.
   5  * All Rights Reserved.
   6  */
   7
   8 import net.sourceforge.phpdt.internal.ui.text.FastJavaPartitionScanner;
   9 import net.sourceforge.phpdt.internal.ui.text.IPHPPartitions;
  10 import net.sourceforge.phpdt.internal.ui.text.JavaColorManager;
  11 import net.sourceforge.phpdt.internal.ui.text.phpdoc.PHPDocCodeScanner;
  12 import net.sourceforge.phpeclipse.IPreferenceConstants;
  13 import net.sourceforge.phpeclipse.phpeditor.php.HTMLPartitionScanner;
  14 import net.sourceforge.phpeclipse.phpeditor.php.PHPCodeScanner;
  15 import net.sourceforge.phpeclipse.phpeditor.php.PHPDocumentPartitioner;
  16 import net.sourceforge.phpeclipse.phpeditor.php.PHPPartitionScanner;
  17 import net.sourceforge.phpeclipse.phpeditor.php.SmartyCodeScanner;
  18 import net.sourceforge.phpeclipse.phpeditor.php.SmartyDocCodeScanner;
  19 import net.sourceforge.phpeclipse.xml.ui.XMLPlugin;
  20 import net.sourceforge.phpeclipse.xml.ui.internal.text.XMLPartitionScanner;
  21 import net.sourceforge.phpeclipse.xml.ui.text.XMLTextTools;
  22
  23 import org.eclipse.core.runtime.Preferences;
  24 import org.eclipse.jface.preference.IPreferenceStore;
  25 import org.eclipse.jface.text.IDocument;
  26 import org.eclipse.jface.text.IDocumentExtension3;
  27 import org.eclipse.jface.text.IDocumentPartitioner;
  28 import org.eclipse.jface.text.rules.DefaultPartitioner;
  29 import org.eclipse.jface.text.rules.RuleBasedScanner;
  30 import org.eclipse.jface.util.IPropertyChangeListener;
  31 import org.eclipse.jface.util.PropertyChangeEvent;
  32
  33 //
  34 //import org.phpeclipse.phpdt.internal.ui.text.FastJavaPartitionScanner;
  35 //import org.phpeclipse.phpdt.internal.ui.text.JavaColorManager;
  36 //import org.phpeclipse.phpdt.internal.ui.text.JavaPartitionScanner;
  37 //import org.phpeclipse.phpdt.internal.ui.text.SingleTokenJavaScanner;
  38 //import org.phpeclipse.phpdt.internal.ui.text.php.JavaCodeScanner;
  39 //import org.phpeclipse.phpdt.internal.ui.text.phpdoc.JavaDocScanner;
  40
  41 /**
  42  * Tools required to configure a Java text viewer. The color manager and all scanner exist only one time, i.e. the same instances
  43  * are returned to all clients. Thus, clients share those tools.
  44  * <p>
  45  * This class may be instantiated; it is not intended to be subclassed.
  46  * </p>
  47  */
  48 public class JavaTextTools implements IPHPPartitions {
  49   //  private static final String[] TOKENS = {
  50   //  JSPScriptScanner.JSP_DEFAULT,
  51   //  JSPScriptScanner.JSP_BRACKET };
  52   private final static String[] LEGAL_CONTENT_TYPES = new String[] {
  53       PHP_PHPDOC_COMMENT,
  54       PHP_MULTILINE_COMMENT,
  55       PHP_SINGLELINE_COMMENT,
  56       PHP_STRING_DQ,
  57       PHP_STRING_SQ };
  58
  59   private static XMLPartitionScanner HTML_PARTITION_SCANNER = null;
  60
  61   private static FastJavaPartitionScanner PHP_PARTITION_SCANNER = null;
  62
  63   private static HTMLPartitionScanner SMARTY_PARTITION_SCANNER = null;
  64
  65   private static XMLPartitionScanner XML_PARTITION_SCANNER = null;
  66
  67   // private final static String[] TYPES= new String[] { PHPPartitionScanner.PHP, PHPPartitionScanner.JAVA_DOC,
  68   // PHPPartitionScanner.JAVA_MULTILINE_COMMENT };
  69   //  private final static String[] TYPES = new String[] {
  70   //      IPHPPartitions.PHP_PARTITIONING,
  71   //      IPHPPartitions.PHP_PHPDOC_COMMENT,
  72   //  // IPHPPartitions.HTML,
  73   //      // IPHPPartitions.HTML_MULTILINE_COMMENT,
  74   //      IPHPPartitions.JAVASCRIPT,
  75   //      IPHPPartitions.CSS,
  76   //      IPHPPartitions.SMARTY,
  77   //      IPHPPartitions.SMARTY_MULTILINE_COMMENT };
  78
  79   /**
  80    * This tools' preference listener.
  81    */
  82   private class PreferenceListener implements IPropertyChangeListener, Preferences.IPropertyChangeListener {
  83     public void propertyChange(PropertyChangeEvent event) {
  84       adaptToPreferenceChange(event);
  85     }
  86
  87     public void propertyChange(Preferences.PropertyChangeEvent event) {
  88       adaptToPreferenceChange(new PropertyChangeEvent(event.getSource(), event.getProperty(), event.getOldValue(), event
  89           .getNewValue()));
  90     }
  91   };
  92
  93   //  /** The color manager */
  94   private JavaColorManager colorManager;
  95
  96   /** The PHP source code scanner */
  97   private PHPCodeScanner fCodeScanner;
  98
  99   /** The PHP multiline comment scanner */
 100   private SingleTokenPHPScanner fMultilineCommentScanner;
 101
 102   /** The Java singleline comment scanner */
 103   private SingleTokenPHPScanner fSinglelineCommentScanner;
 104
 105   /** The Java string scanner */
 106   private SingleTokenPHPScanner fStringScanner;
 107
 108   /** The PHPDoc scanner */
 109   private PHPDocCodeScanner fPHPDocScanner;
 110
 111   /** The HTML scanner */
 112   //  private HTMLCodeScanner fHTMLScanner;
 113   /** The Smarty scanner */
 114   private SmartyCodeScanner fSmartyScanner;
 115
 116   /** The SmartyDoc scanner */
 117   private SmartyDocCodeScanner fSmartyDocScanner;
 118
 119   /** The Java partitions scanner. */
 120   private FastJavaPartitionScanner fPartitionScanner;
 121
 122   /** The preference store */
 123   private IPreferenceStore fPreferenceStore;
 124
 125   /** The XML Language text tools */
 126   private XMLTextTools xmlTextTools;
 127
 128   /**
 129    * The core preference store.
 130    *
 131    * @since 2.1
 132    */
 133   private Preferences fCorePreferenceStore;
 134
 135   /** The preference change listener */
 136   private PreferenceListener fPreferenceListener = new PreferenceListener();
 137
 138   /** The JSP partitions scanner */
 139   private PHPPartitionScanner jspPartitionScanner = null;
 140
 141   /** The JSP script subpartitions scanner */
 142   //  private JSPScriptScanner jspScriptScanner;
 143   /** The PHP plain text scanner */
 144   //  private RuleBasedScanner jspTextScanner;
 145   /** The PHP brackets scanner */
 146   //  private RuleBasedScanner jspBracketScanner;
 147   /**
 148    * Creates a new Java text tools collection.
 149    *
 150    * @param store
 151    *          the preference store to initialize the text tools. The text tool instance installs a listener on the passed preference
 152    *          store to adapt itself to changes in the preference store. In general <code>PreferenceConstants.
 153    *                    getPreferenceStore()</code>
 154    *          should be used to initialize the text tools.
 155    * @param coreStore
 156    *          optional preference store to initialize the text tools. The text tool instance installs a listener on the passed
 157    *          preference store to adapt itself to changes in the preference store.
 158    * @see net.sourceforge.phpdt.ui.PreferenceConstants#getPreferenceStore()
 159    * @since 2.1
 160    */
 161   public JavaTextTools(IPreferenceStore store, Preferences coreStore) {
 162     this(store, coreStore, true);
 163   }
 164
 165   /**
 166    * Creates a new Java text tools collection.
 167    *
 168    * @param store
 169    *          the preference store to initialize the text tools. The text tool instance installs a listener on the passed preference
 170    *          store to adapt itself to changes in the preference store. In general <code>PreferenceConstants.
 171    *                    getPreferenceStore()</code>
 172    *          shoould be used to initialize the text tools.
 173    * @param coreStore
 174    *          optional preference store to initialize the text tools. The text tool instance installs a listener on the passed
 175    *          preference store to adapt itself to changes in the preference store.
 176    * @param autoDisposeOnDisplayDispose
 177    *          if <code>true</code> the color manager automatically disposes all managed colors when the current display gets
 178    *          disposed and all calls to {@link org.eclipse.jface.text.source.ISharedTextColors#dispose()}are ignored.
 179    * @see net.sourceforge.phpdt.ui.PreferenceConstants#getPreferenceStore()
 180    * @since 2.1
 181    */
 182   public JavaTextTools(IPreferenceStore store, Preferences coreStore, boolean autoDisposeOnDisplayDispose) {
 183     //    super(store, TOKENS, );
 184     //  REVISIT: preference store
 185     xmlTextTools = new XMLTextTools(XMLPlugin.getDefault().getPreferenceStore());
 186
 187     colorManager = new JavaColorManager(autoDisposeOnDisplayDispose);
 188     fPreferenceStore = store;
 189     fPreferenceStore.addPropertyChangeListener(fPreferenceListener);
 190
 191     fCorePreferenceStore = coreStore;
 192     if (fCorePreferenceStore != null)
 193       fCorePreferenceStore.addPropertyChangeListener(fPreferenceListener);
 194
 195     fCodeScanner = new PHPCodeScanner((JavaColorManager) colorManager, store);
 196     fMultilineCommentScanner = new SingleTokenPHPScanner((JavaColorManager) colorManager, store,
 197         IPreferenceConstants.PHP_MULTILINE_COMMENT);
 198     fSinglelineCommentScanner = new SingleTokenPHPScanner((JavaColorManager) colorManager, store,
 199         IPreferenceConstants.PHP_SINGLELINE_COMMENT);
 200     fStringScanner = new SingleTokenPHPScanner((JavaColorManager) colorManager, store, IPreferenceConstants.PHP_STRING);
 201     fPHPDocScanner = new PHPDocCodeScanner((JavaColorManager) colorManager, store);
 202     //    fHTMLScanner = new HTMLCodeScanner((JavaColorManager)fColorManager, store);
 203     fSmartyScanner = new SmartyCodeScanner((JavaColorManager) colorManager, store);
 204     fSmartyDocScanner = new SmartyDocCodeScanner((JavaColorManager) colorManager, store);
 205
 206     fPartitionScanner = new FastJavaPartitionScanner();
 207
 208     //    jspScriptScanner = new JSPScriptScanner();
 209     //  fPartitionScanner = new FastJavaPartitionScanner();
 210     //    fPartitionScanner = new PHPPartitionScanner();
 211
 212     //    jspBracketScanner = new RuleBasedScanner();
 213     //    jspBracketScanner.setDefaultReturnToken(new Token(JSPScriptScanner.JSP_BRACKET));
 214     //    jspTextScanner = new RuleBasedScanner();
 215     //    jspTextScanner.setDefaultReturnToken(new Token(JSPScriptScanner.JSP_DEFAULT));
 216   }
 217
 218   /**
 219    *
 220    */
 221   public XMLTextTools getXMLTextTools() {
 222     return xmlTextTools;
 223   }
 224
 225   /**
 226    * Disposes all the individual tools of this tools collection.
 227    */
 228   public void dispose() {
 229
 230     fCodeScanner = null;
 231     fMultilineCommentScanner = null;
 232     fSinglelineCommentScanner = null;
 233     fStringScanner = null;
 234     fPHPDocScanner = null;
 235     //    fPartitionScanner = null;
 236
 237     if (colorManager != null) {
 238       colorManager.dispose();
 239       colorManager = null;
 240     }
 241
 242     if (fPreferenceStore != null) {
 243       fPreferenceStore.removePropertyChangeListener(fPreferenceListener);
 244       fPreferenceStore = null;
 245
 246       if (fCorePreferenceStore != null) {
 247         fCorePreferenceStore.removePropertyChangeListener(fPreferenceListener);
 248         fCorePreferenceStore = null;
 249       }
 250
 251       fPreferenceListener = null;
 252     }
 253   }
 254
 255   /**
 256    * Returns the color manager which is used to manage any Java-specific colors needed for such things like syntax highlighting.
 257    *
 258    * @return the color manager to be used for Java text viewers
 259    */
 260   public JavaColorManager getColorManager() {
 261     return (JavaColorManager) colorManager;
 262   }
 263
 264   /**
 265    * Returns a scanner which is configured to scan Java source code.
 266    *
 267    * @return a Java source code scanner
 268    */
 269   public RuleBasedScanner getCodeScanner() {
 270     return fCodeScanner;
 271   }
 272
 273   /**
 274    * Returns a scanner which is configured to scan Java multiline comments.
 275    *
 276    * @return a Java multiline comment scanner
 277    *
 278    * @since 2.0
 279    */
 280   public RuleBasedScanner getMultilineCommentScanner() {
 281     return fMultilineCommentScanner;
 282   }
 283
 284   /**
 285    * Returns a scanner which is configured to scan HTML code.
 286    *
 287    * @return a HTML scanner
 288    *
 289    * @since 2.0
 290    */
 291   //  public RuleBasedScanner getHTMLScanner() {
 292   //    return fHTMLScanner;
 293   //  }
 294   /**
 295    * Returns a scanner which is configured to scan Smarty code.
 296    *
 297    * @return a Smarty scanner
 298    *
 299    * @since 2.0
 300    */
 301   public RuleBasedScanner getSmartyScanner() {
 302     return fSmartyScanner;
 303   }
 304
 305   /**
 306    * Returns a scanner which is configured to scan Smarty code.
 307    *
 308    * @return a Smarty scanner
 309    *
 310    * @since 2.0
 311    */
 312   public RuleBasedScanner getSmartyDocScanner() {
 313     return fSmartyDocScanner;
 314   }
 315
 316   /**
 317    * Returns a scanner which is configured to scan Java singleline comments.
 318    *
 319    * @return a Java singleline comment scanner
 320    *
 321    * @since 2.0
 322    */
 323   public RuleBasedScanner getSinglelineCommentScanner() {
 324     return fSinglelineCommentScanner;
 325   }
 326
 327   /**
 328    * Returns a scanner which is configured to scan Java strings.
 329    *
 330    * @return a Java string scanner
 331    *
 332    * @since 2.0
 333    */
 334   public RuleBasedScanner getStringScanner() {
 335     return fStringScanner;
 336   }
 337
 338   /**
 339    * Returns a scanner which is configured to scan JavaDoc compliant comments. Notes that the start sequence "/**" and the
 340    * corresponding end sequence are part of the JavaDoc comment.
 341    *
 342    * @return a JavaDoc scanner
 343    */
 344   public RuleBasedScanner getJavaDocScanner() {
 345     return fPHPDocScanner;
 346   }
 347
 348   /**
 349    * Returns a scanner which is configured to scan Java-specific partitions, which are multi-line comments, JavaDoc comments, and
 350    * regular Java source code.
 351    *
 352    * @return a Java partition scanner
 353    */
 354   //  public IPartitionTokenScanner getPartitionScanner() {
 355   //    return fPartitionScanner;
 356   //  }
 357   /**
 358    * Factory method for creating a PHP-specific document partitioner using this object's partitions scanner. This method is a
 359    * convenience method.
 360    *
 361    * @return a newly created Java document partitioner
 362    */
 363   public IDocumentPartitioner createDocumentPartitioner() {
 364     return createDocumentPartitioner(".php");
 365   }
 366
 367   /**
 368    * Factory method for creating a PHP-specific document partitioner using this object's partitions scanner. This method is a
 369    * convenience method.
 370    *
 371    * @return a newly created Java document partitioner
 372    */
 373   public IDocumentPartitioner createDocumentPartitioner(String extension) {
 374
 375     //    String[] types =
 376     //      new String[] {
 377     //        FastJavaPartitionScanner.JAVA_DOC,
 378     //        FastJavaPartitionScanner.JAVA_MULTI_LINE_COMMENT,
 379     //        FastJavaPartitionScanner.JAVA_SINGLE_LINE_COMMENT,
 380     //        FastJavaPartitionScanner.JAVA_STRING };
 381     //
 382     //    return new DefaultPartitioner(getPartitionScanner(), types);
 383     IDocumentPartitioner partitioner = null;
 384     //  System.out.println(extension);
 385     if (extension.equalsIgnoreCase(".html") || extension.equalsIgnoreCase(".htm")) {
 386       // html
 387       partitioner = createHTMLPartitioner();
 388       partitioner = createJSPPartitioner();
 389     } else if (extension.equalsIgnoreCase(".xml")) {
 390       // xml
 391       partitioner = createXMLPartitioner();
 392       //    } else if (extension.equalsIgnoreCase(".js")) {
 393       //      // javascript
 394       //      partitioner = createJavaScriptPartitioner();
 395       //    } else if (extension.equalsIgnoreCase(".css")) {
 396       //      // cascading style sheets
 397       //      partitioner = createCSSPartitioner();
 398     } else if (extension.equalsIgnoreCase(".tpl")) {
 399       // smarty ?
 400       partitioner = createSmartyPartitioner();
 401       //    } else if (extension.equalsIgnoreCase(".inc")) {
 402       //      // php include files ?
 403       //      partitioner = createIncludePartitioner();
 404     }
 405
 406     if (partitioner == null) {
 407       partitioner = createJSPPartitioner();
 408     }
 409
 410     return partitioner;
 411   }
 412
 413   /**
 414    * Sets up the Java document partitioner for the given document for the given partitioning.
 415    *
 416    * @param document
 417    *          the document to be set up
 418    * @param partitioning
 419    *          the document partitioning
 420    * @param element
 421    *          TODO
 422    *
 423    * @since 3.0
 424    */
 425   //  public void setupJavaDocumentPartitioner(IDocument document, String partitioning, Object element) {
 426   //    IDocumentPartitioner partitioner = createDocumentPartitioner(".php");
 427   //
 428   //    // if (document instanceof IDocumentExtension3) {
 429   //    // IDocumentExtension3 extension3= (IDocumentExtension3) document;
 430   //    // extension3.setDocumentPartitioner(partitioning, partitioner);
 431   //    // } else {
 432   //    document.setDocumentPartitioner(partitioner);
 433   //    // }
 434   //    partitioner.connect(document);
 435   //  }
 436   public void setupHTMLDocumentPartitioner(IDocument document, String partitioning, Object element) {
 437     IDocumentPartitioner partitioner = createDocumentPartitioner(".html");
 438
 439     //          if (document instanceof IDocumentExtension3) {
 440     //                  IDocumentExtension3 extension3= (IDocumentExtension3) document;
 441     //                  extension3.setDocumentPartitioner(partitioning, partitioner);
 442     //          } else {
 443     document.setDocumentPartitioner(partitioner);
 444     //          }
 445     partitioner.connect(document);
 446   }
 447
 448   public void setupSmartyDocumentPartitioner(IDocument document, String partitioning, Object element) {
 449     IDocumentPartitioner partitioner = createDocumentPartitioner(".tpl");
 450
 451     //          if (document instanceof IDocumentExtension3) {
 452     //                  IDocumentExtension3 extension3= (IDocumentExtension3) document;
 453     //                  extension3.setDocumentPartitioner(partitioning, partitioner);
 454     //          } else {
 455     document.setDocumentPartitioner(partitioner);
 456     //          }
 457     partitioner.connect(document);
 458   }
 459
 460   /**
 461    * Returns the names of the document position categories used by the document partitioners created by this object to manage their
 462    * partition information. If the partitioners don't use document position categories, the returned result is <code>null</code>.
 463    *
 464    * @return the partition managing position categories or <code>null</code> if there is none
 465    */
 466   public String[] getPartitionManagingPositionCategories() {
 467     return new String[] { DefaultPartitioner.CONTENT_TYPES_CATEGORY };
 468   }
 469
 470   /**
 471    * Determines whether the preference change encoded by the given event changes the behavior of one its contained components.
 472    *
 473    * @param event
 474    *          the event to be investigated
 475    * @return <code>true</code> if event causes a behavioral change
 476    * @since 2.0
 477    * @deprecated As of 3.0, replaced by
 478    *             {@link net.sourceforge.phpdt.ui.text.JavaSourceViewerConfiguration#affectsTextPresentation(PropertyChangeEvent)}
 479    */
 480   //  public boolean affectsBehavior(PropertyChangeEvent event) {
 481   //    return fCodeScanner.affectsBehavior(event)
 482   //        || fMultilineCommentScanner.affectsBehavior(event)
 483   //        || fSinglelineCommentScanner.affectsBehavior(event)
 484   //        || fStringScanner.affectsBehavior(event)
 485   //        || fPHPDocScanner.affectsBehavior(event);
 486   //  }
 487   /**
 488    * Adapts the behavior of the contained components to the change encoded in the given event.
 489    *
 490    * @param event
 491    *          the event to which to adapt
 492    * @since 2.0
 493    */
 494   protected void adaptToPreferenceChange(PropertyChangeEvent event) {
 495     if (fCodeScanner.affectsBehavior(event))
 496       fCodeScanner.adaptToPreferenceChange(event);
 497     if (fMultilineCommentScanner.affectsBehavior(event))
 498       fMultilineCommentScanner.adaptToPreferenceChange(event);
 499     if (fSinglelineCommentScanner.affectsBehavior(event))
 500       fSinglelineCommentScanner.adaptToPreferenceChange(event);
 501     //    if (fStringScanner.affectsBehavior(event))
 502     //      fStringScanner.adaptToPreferenceChange(event);
 503     if (fPHPDocScanner.affectsBehavior(event))
 504       fPHPDocScanner.adaptToPreferenceChange(event);
 505     //    if (fHTMLScanner.affectsBehavior(event))
 506     //      fHTMLScanner.adaptToPreferenceChange(event);
 507     if (fSmartyScanner.affectsBehavior(event))
 508       fSmartyScanner.adaptToPreferenceChange(event);
 509     if (fSmartyDocScanner.affectsBehavior(event))
 510       fSmartyDocScanner.adaptToPreferenceChange(event);
 511     //    if (XMLPlugin.getDefault().getXMLTextTools().affectsBehavior(event)) {
 512     //      XMLPlugin.getDefault().getXMLTextTools().adaptToPreferenceChange(event);
 513     //    }
 514   }
 515
 516   /**
 517    * Return a partitioner for .html files.
 518    */
 519   public IDocumentPartitioner createHTMLPartitioner() {
 520     //    return new DefaultPartitioner(getHTMLPartitionScanner(), TYPES);
 521     return xmlTextTools.createXMLPartitioner();
 522   }
 523
 524   //  private static IDocumentPartitioner createIncludePartitioner() {
 525   //    // return new DefaultPartitioner(getPHPPartitionScanner(), TYPES);
 526   //    return new DefaultPartitioner(getPHPPartitionScanner(), FastJavaPartitionScanner.PHP_PARTITION_TYPES);
 527   //
 528   //  }
 529
 530   //  private static IDocumentPartitioner createJavaScriptPartitioner() {
 531   //    return new DefaultPartitioner(getHTMLPartitionScanner(), TYPES);
 532   //  }
 533
 534   /**
 535    * Return a partitioner for .php files.
 536    */
 537   public IDocumentPartitioner createPHPPartitioner() {
 538     //    return new DefaultPartitioner(getPHPPartitionScanner(), TYPES);
 539     return new DefaultPartitioner(getPHPPartitionScanner(), LEGAL_CONTENT_TYPES);
 540   }
 541
 542   private IDocumentPartitioner createJSPPartitioner() {
 543     return new PHPDocumentPartitioner(getJSPPartitionScanner(), getPHPPartitionScanner());
 544     //    return new JSPDocumentPartitioner(getJSPPartitionScanner(), jspScriptScanner);
 545   }
 546
 547   /**
 548    *
 549    */
 550   //  public IPartitionTokenScanner getJSPScriptScanner() {
 551   //    return jspScriptScanner;
 552   //  }
 553   private IDocumentPartitioner createSmartyPartitioner() {
 554     return new DefaultPartitioner(getSmartyPartitionScanner(), XMLTextTools.TYPES);
 555   }
 556
 557   private IDocumentPartitioner createXMLPartitioner() {
 558     //    return new DefaultPartitioner(getXMLPartitionScanner(), XMLTextTools.TYPES);
 559     return xmlTextTools.createXMLPartitioner();
 560   }
 561
 562   //  private IDocumentPartitioner createCSSPartitioner() {
 563   //    return new DefaultPartitioner(getHTMLPartitionScanner(), XMLTextTools.TYPES);
 564   //  }
 565
 566   /**
 567    * Return a scanner for creating html partitions.
 568    */
 569   //  private static XMLPartitionScanner getHTMLPartitionScanner() {
 570   //    // if (HTML_PARTITION_SCANNER == null)
 571   //    // HTML_PARTITION_SCANNER = new HTMLPartitionScanner(IPHPPartitions.HTML_FILE);
 572   //    // return HTML_PARTITION_SCANNER;^
 573   //    if (HTML_PARTITION_SCANNER == null)
 574   //      HTML_PARTITION_SCANNER = new XMLPartitionScanner(false);
 575   //    return HTML_PARTITION_SCANNER;
 576   //  }
 577   /**
 578    * Return a scanner for creating php partitions.
 579    */
 580   private FastJavaPartitionScanner getPHPPartitionScanner() {
 581     //    if (PHP_PARTITION_SCANNER == null)
 582     //      PHP_PARTITION_SCANNER = new FastJavaPartitionScanner(); //new PHPPartitionScanner(IPHPPartitions.PHP_FILE);
 583     //    return PHP_PARTITION_SCANNER;
 584     return fPartitionScanner;
 585   }
 586
 587   /**
 588    * Returns a scanner which is configured to scan plain text in JSP.
 589    *
 590    * @return a JSP text scanner
 591    */
 592   //  public RuleBasedScanner getJSPTextScanner() {
 593   //    return jspTextScanner;
 594   //  }
 595   /**
 596    * Returns a scanner which is configured to scan plain text in JSP.
 597    *
 598    * @return a JSP text scanner
 599    */
 600   //  public RuleBasedScanner getJSPBracketScanner() {
 601   //    return jspBracketScanner;
 602   //  }
 603   /**
 604    * Return a scanner for creating smarty partitions.
 605    */
 606   private static HTMLPartitionScanner getSmartyPartitionScanner() {
 607     if (SMARTY_PARTITION_SCANNER == null)
 608       SMARTY_PARTITION_SCANNER = new HTMLPartitionScanner(IPHPPartitions.SMARTY_FILE);
 609     return SMARTY_PARTITION_SCANNER;
 610   }
 611
 612   /**
 613    * Return a scanner for creating xml partitions.
 614    */
 615   private static XMLPartitionScanner getXMLPartitionScanner() {
 616     //    if (XML_PARTITION_SCANNER == null)
 617     //      XML_PARTITION_SCANNER = new HTMLPartitionScanner(IPHPPartitions.XML_FILE);
 618     //    return XML_PARTITION_SCANNER;
 619     if (XML_PARTITION_SCANNER == null)
 620       XML_PARTITION_SCANNER = new XMLPartitionScanner(false);
 621     return XML_PARTITION_SCANNER;
 622   }
 623
 624   private PHPPartitionScanner getJSPPartitionScanner() {
 625     if (jspPartitionScanner == null)
 626       jspPartitionScanner = new PHPPartitionScanner();
 627     return jspPartitionScanner;
 628   }
 629
 630   /**
 631    * Sets up the Java document partitioner for the given document for the default partitioning.
 632    *
 633    * @param document
 634    *          the document to be set up
 635    * @since 3.0
 636    */
 637   public void setupJavaDocumentPartitioner(IDocument document) {
 638     setupJavaDocumentPartitioner(document, IDocumentExtension3.DEFAULT_PARTITIONING);
 639   }
 640
 641   /**
 642    * Sets up the Java document partitioner for the given document for the given partitioning.
 643    *
 644    * @param document
 645    *          the document to be set up
 646    * @param partitioning
 647    *          the document partitioning
 648    * @since 3.0
 649    */
 650   public void setupJavaDocumentPartitioner(IDocument document, String partitioning) {
 651     IDocumentPartitioner partitioner = createDocumentPartitioner();
 652     if (document instanceof IDocumentExtension3) {
 653       IDocumentExtension3 extension3 = (IDocumentExtension3) document;
 654       extension3.setDocumentPartitioner(partitioning, partitioner);
 655     } else {
 656       document.setDocumentPartitioner(partitioner);
 657     }
 658     partitioner.connect(document);
 659   }
 660
 661   /**
 662    * Returns this text tool's preference store.
 663    *
 664    * @return the preference store
 665    * @since 3.0
 666    */
 667   protected IPreferenceStore getPreferenceStore() {
 668     return fPreferenceStore;
 669   }
 670
 671   /**
 672    * Returns this text tool's core preference store.
 673    *
 674    * @return the core preference store
 675    * @since 3.0
 676    */
 677   protected Preferences getCorePreferenceStore() {
 678     return fCorePreferenceStore;
 679   }
 680 }