- * This class may be instantiated; it is not intended to be subclassed. - *
- */ -public class JavaTextTools { - - 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[] { - IPHPPartitionScannerConstants.PHP, - IPHPPartitionScannerConstants.PHP_MULTILINE_COMMENT, - IPHPPartitionScannerConstants.HTML, - IPHPPartitionScannerConstants.HTML_MULTILINE_COMMENT, - IPHPPartitionScannerConstants.JAVASCRIPT, - IPHPPartitionScannerConstants.CSS, - IPHPPartitionScannerConstants.SMARTY, - IPHPPartitionScannerConstants.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 */ - 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 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 core preference store. - * @since 2.1 - */ - private Preferences fCorePreferenceStore; - /** 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 generalPreferenceConstants.
- * getPreferenceStore() 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, 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();
- }
-
- /**
- * 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 PreferenceConstants.
- * getPreferenceStore() 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 true 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();
- }
-
- /**
- * 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;
-
- if (fCorePreferenceStore != null) {
- fCorePreferenceStore.removePropertyChangeListener(fPreferenceListener);
- fCorePreferenceStore = 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.
- *
- * @return a HTML scanner
- *
- * @since 2.0
- */
- public RuleBasedScanner getHTMLScanner() {
- return fHTMLScanner;
- }
-
- /**
- * 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 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");
- }
-
- /**
- * 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) {
-
- // 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;
- }
-
- /**
- * 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 null.
- *
- * @return the partition managing position categories or null
- * 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 true 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);
- }
-
- /**
- * 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(IPHPPartitionScannerConstants.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(IPHPPartitionScannerConstants.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(IPHPPartitionScannerConstants.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(IPHPPartitionScannerConstants.XML_FILE);
- return XML_PARTITION_SCANNER;
- }
-
-}
\ No newline at end of file