[jbosstools-commits] JBoss Tools SVN: r2285 - in trunk/common/plugins/org.jboss.tools.common.text.xml: schema and 2 other directories.

Author: vrubezhny Date: 2007-07-04 10:14:20 -0400 (Wed, 04 Jul 2007) New Revision: 2285 Added: trunk/common/plugins/org.jboss.tools.common.text.xml/schema/contentAssistProcessor.exsd trunk/common/plugins/org.jboss.tools.common.text.xml/src/org/jboss/tools/common/text/xml/contentassist/ trunk/common/plugins/org.jboss.tools.common.text.xml/src/org/jboss/tools/common/text/xml/contentassist/ContentAssistProcessorBuilder.java trunk/common/plugins/org.jboss.tools.common.text.xml/src/org/jboss/tools/common/text/xml/contentassist/ContentAssistProcessorDefinition.java Modified: trunk/common/plugins/org.jboss.tools.common.text.xml/plugin.xml trunk/common/plugins/org.jboss.tools.common.text.xml/src/org/jboss/tools/common/text/xml/RedHatStructuredTextViewerConfigurationXML.java Log: http://jira.jboss.org/jira/browse/EXIN-330 The schema added due to allow the xml-editor configuration to load and use custom content assist processors dependig on the partition type. Modified: trunk/common/plugins/org.jboss.tools.common.text.xml/plugin.xml =================================================================== --- trunk/common/plugins/org.jboss.tools.common.text.xml/plugin.xml 2007-07-04 14:10:54 UTC (rev 2284) +++ trunk/common/plugins/org.jboss.tools.common.text.xml/plugin.xml 2007-07-04 14:14:20 UTC (rev 2285) @@ -2,6 +2,8 @@ <?eclipse version="3.0"?> <plugin> + <extension-point id="contentAssistProcessor" name="Content Assist Processor Extension Point Extension" schema="schema/contentAssistProcessor.exsd"/> + <!-- <extension-point id="foldingStructureProviders" name="%foldingStructureProvidersExtensionPoint" schema="schema/foldingStructureProviders.exsd"/> Copied: trunk/common/plugins/org.jboss.tools.common.text.xml/schema/contentAssistProcessor.exsd (from rev 2278, trunk/common/plugins/org.jboss.tools.common.text.ext/schema/contentAssistProcessor.exsd) =================================================================== --- trunk/common/plugins/org.jboss.tools.common.text.xml/schema/contentAssistProcessor.exsd (rev 0) +++ trunk/common/plugins/org.jboss.tools.common.text.xml/schema/contentAssistProcessor.exsd 2007-07-04 14:14:20 UTC (rev 2285) @@ -0,0 +1,153 @@ +<?xml version='1.0' encoding='UTF-8'?> +<!-- Schema file written by PDE --> +<schema targetNamespace="org.jboss.tools.common.text.xml"> +<annotation> + <appInfo> + <meta.schema plugin="org.jboss.tools.common.text.xml" id="contentAssistProcessor" name="Content Assist Processor Extension Point Extension"/> + </appInfo> + <documentation> + Content Assist Processor + </documentation> + </annotation> + + <element name="extension"> + <annotation> + <documentation> + Defines an extension point for the Content Assist Processor definitions. + </documentation> + </annotation> + <complexType> + <sequence> + <element ref="contentAssistProcessor" minOccurs="1" maxOccurs="unbounded"/> + </sequence> + <attribute name="point" type="string" use="required"> + <annotation> + <documentation> + A unique ID for this extension point. It is recommended that the plugin ID be used to prefix any extensions. + </documentation> + </annotation> + </attribute> + <attribute name="id" type="string"> + <annotation> + <documentation> + A unique ID for this extension. It is recommended that the plugin ID be used to prefix any extensions. + </documentation> + </annotation> + </attribute> + <attribute name="name" type="string"> + <annotation> + <documentation> + A brief name to show to the user. + </documentation> + </annotation> + </attribute> + </complexType> + </element> + + <element name="contentAssistProcessor"> + <annotation> + <documentation> + Defines a Content Assist Processor item. Contains information on a class to be used to perform content assist depending on the content and partition types. + </documentation> + </annotation> + <complexType> + <sequence> + <element ref="partitiontype" minOccurs="1" maxOccurs="unbounded"/> + </sequence> + <attribute name="id" type="string" use="required"> + <annotation> + <documentation> + A unique ID for this Content Assist Processor. + </documentation> + </annotation> + </attribute> + <attribute name="class" type="string" use="required"> + <annotation> + <documentation> + An implementor of org.eclipse.jface.text.contentassist.IContentAssistProcessor, it controls the content assist within text editor. + </documentation> + <appInfo> + <meta.attribute kind="java"/> + </appInfo> + </annotation> + </attribute> + </complexType> + </element> + + <element name="partitiontype"> + <annotation> + <documentation> + Defined the editor&apos;s partition type to be assotiated with the Content Assist Processor. The value is either one of the WTP structured model partition type ID or any other structured text partition ID + </documentation> + </annotation> + <complexType> + <attribute name="id" type="string" use="required"> + <annotation> + <documentation> + A unique ID for this partitiontype. The value is either one of the WTP structured model partition type ID or any other structured text partition ID. + </documentation> + </annotation> + </attribute> + </complexType> + </element> + + <annotation> + <appInfo> + <meta.section type="since"/> + </appInfo> + <documentation> + V3.0 + </documentation> + </annotation> + + <annotation> + <appInfo> + <meta.section type="examples"/> + </appInfo> + <documentation> + &lt;pre&gt; + &lt;extension-point id=&quot;contentAssistProcessor&quot; name=&quot;Content Assist Processor Extension Point Extension&quot;/&gt; + + &lt;extension + point=&quot;org.jboss.tools.common.text.ext.contentAssistProcesor&quot; + id=&quot;org.jboss.tools.common.text.ext.contentAssistProcessor&quot; + name=&quot;org.jboss.tools.common.text.ext.contentAssistProcessor&quot;&gt; + + &lt;contentAssistProcessor + class=&quot;org.jboss.tools.common.text.xml.contentassist.MyContentAssistProcessor&quot; + id=&quot;org.jboss.tools.common.text.xml.contentassist.MyContentAssistProcessorID&quot;&gt; + &lt;partitiontype id=&quot;org.jboss.tools.common.text.xml.XML_DOCTYPE&quot; /&gt; + &lt;/contentAssistProcessor&gt; + &lt;/extension&gt; +&lt;/pre&gt; + </documentation> + </annotation> + + <annotation> + <appInfo> + <meta.section type="apiInfo"/> + </appInfo> + <documentation> + The baseline for API and extension point stability is RedHat Developer Studio + </documentation> + </annotation> + + <annotation> + <appInfo> + <meta.section type="implementation"/> + </appInfo> + <documentation> + The supplied implementation of the contentAssistProcessor functionality requires the WTP components. + </documentation> + </annotation> + + <annotation> + <appInfo> + <meta.section type="copyright"/> + </appInfo> + <documentation> + RedHat + </documentation> + </annotation> + +</schema> Modified: trunk/common/plugins/org.jboss.tools.common.text.xml/src/org/jboss/tools/common/text/xml/RedHatStructuredTextViewerConfigurationXML.java =================================================================== --- trunk/common/plugins/org.jboss.tools.common.text.xml/src/org/jboss/tools/common/text/xml/RedHatStructuredTextViewerConfigurationXML.java 2007-07-04 14:10:54 UTC (rev 2284) +++ trunk/common/plugins/org.jboss.tools.common.text.xml/src/org/jboss/tools/common/text/xml/RedHatStructuredTextViewerConfigurationXML.java 2007-07-04 14:14:20 UTC (rev 2285) @@ -23,8 +23,9 @@ import org.eclipse.jface.text.source.SourceViewerConfiguration; import org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants; import org.eclipse.wst.xml.ui.StructuredTextViewerConfigurationXML; +import org.jboss.tools.common.text.xml.contentassist.ContentAssistProcessorBuilder; +import org.jboss.tools.common.text.xml.contentassist.ContentAssistProcessorDefinition; - /** * @author Igels */ @@ -41,17 +42,44 @@ } protected IContentAssistProcessor[] getContentAssistProcessors(ISourceViewer sourceViewer, String partitionType) { - //TODO if we have our own processors we need - // create them here and decide if we need merge - // them with initial and super processors. + + // if we have our own processors we need + // to define them in plugin.xml file of their + // plugins using extention point + // "org.jboss.tools.common.text.xml.contentAssistProcessor" + + ContentAssistProcessorDefinition[] defs = ContentAssistProcessorBuilder.getInstance().getContentAssistProcessorDefinitions(partitionType); + + if(defs==null) return null; + + List processors = new ArrayList(); + for(int i=0; i<defs.length; i++) { + IContentAssistProcessor processor = defs[i].createContentAssistProcessor(); + if(!processors.contains(processor)) { + processors.add(processor); + } + } + IContentAssistProcessor[] in = getInitialProcessors(sourceViewer, partitionType); if(in != null && in.length > 0) { + //we do not need super processors - make initial processors responcible for that - return in; + for(int i=0; i<in.length; i++) { + if(!processors.contains(in[i])) { + processors.add(in[i]); + } + } + } else { + IContentAssistProcessor[] ps = super.getContentAssistProcessors(sourceViewer, partitionType); + for(int i=0; ps != null && i<ps.length; i++) { + if(!processors.contains(ps[i])) { + processors.add(ps[i]); + } + } } - IContentAssistProcessor[] ps = super.getContentAssistProcessors(sourceViewer, partitionType); - return ps; + return (IContentAssistProcessor[])processors.toArray(new IContentAssistProcessor[0]); } + /* * @see org.eclipse.jface.text.source.SourceViewerConfiguration#getHyperlinkDetectors(org.eclipse.jface.text.source.ISourceViewer) * @since 3.1 Copied: trunk/common/plugins/org.jboss.tools.common.text.xml/src/org/jboss/tools/common/text/xml/contentassist/ContentAssistProcessorBuilder.java (from rev 2278, trunk/common/plugins/org.jboss.tools.common.text.ext/src/org/jboss/tools/common/text/ext/contentassist/ContentAssistProcessorBuilder.java) =================================================================== --- trunk/common/plugins/org.jboss.tools.common.text.xml/src/org/jboss/tools/common/text/xml/contentassist/ContentAssistProcessorBuilder.java (rev 0) +++ trunk/common/plugins/org.jboss.tools.common.text.xml/src/org/jboss/tools/common/text/xml/contentassist/ContentAssistProcessorBuilder.java 2007-07-04 14:14:20 UTC (rev 2285) @@ -0,0 +1,224 @@ +/******************************************************************************* + * Copyright (c) 2007 Red Hat, Inc. + * Distributed under license by Red Hat, Inc. All rights reserved. + * This program is made available under the terms of the + * Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + * + * Contributor: + * Red Hat, Inc. - initial API and implementation + ******************************************************************************/ + +package org.jboss.tools.common.text.xml.contentassist; + +import java.util.ArrayList; +import java.util.List; + +import org.eclipse.core.runtime.IConfigurationElement; +import org.eclipse.core.runtime.IExtension; +import org.eclipse.core.runtime.IExtensionRegistry; +import org.eclipse.core.runtime.Platform; +import org.eclipse.wst.sse.ui.internal.util.Sorter; +import org.jboss.tools.common.text.xml.XmlEditorPlugin; + +public class ContentAssistProcessorBuilder extends org.eclipse.wst.sse.ui.internal.extension.RegistryReader { + // extension point ID + public static final String PL_CONTENTASSISTPROCESSOR = "contentAssistProcessor"; //$NON-NLS-1$ + + public static final String TAG_CONTENTASSISTPROCESSOR = "contentAssistProcessor"; //$NON-NLS-1$ + public static final String TAG_PARTITION_TYPE = "partitiontype"; //$NON-NLS-1$ + + public static final String ATT_ID = "id"; //$NON-NLS-1$ + public static final String ATT_CLASS = "class"; //$NON-NLS-1$ + + protected String targetContributionTag; + + private static ContentAssistProcessorBuilder fInstance; + + private List<ContentAssistProcessorDefinition> fContentAssistProcessorDefs = null; + private ContentAssistProcessorDefinition fCurrentDefinition = null; + + /** + * returns singleton instance of ContentAssistProcessorBuilder + * + * @return ContentAssistProcessorBuilder + */ + public synchronized static ContentAssistProcessorBuilder getInstance() { + if (fInstance == null) { + fInstance = new ContentAssistProcessorBuilder(); + } + return fInstance; + } + + /** + * Returns the name of the part ID attribute that is expected + * in the target extension. + * + * @param element + * @return String + */ + protected String getId(IConfigurationElement element) { + String value = element.getAttribute(ATT_ID); + return value; + } + + protected String getContentAssistProcessorClass(IConfigurationElement element) { + String value = element.getAttribute(ATT_CLASS); + return value; + } + + /** + * Processes element which should be a configuration element specifying an + * open on object. Creates a new ContentAssistProcessor definitio object and adds it to the + * list of ContentAssistProcessor definition objects + * + * @param element ContentAssistProcessor configuration element + */ + private void processContentAssistProcessorTag(IConfigurationElement element) { + String theId = getId(element); + String theClass = getContentAssistProcessorClass(element); + + if (theId != null && theClass != null) { + // start building new HyperlinkDefinition + fCurrentDefinition = new ContentAssistProcessorDefinition(theId, theClass, element); + + // create a new list of open on definitions if it hasn't been created yet + if (fContentAssistProcessorDefs == null) { + fContentAssistProcessorDefs = new ArrayList<ContentAssistProcessorDefinition>(); + } + fContentAssistProcessorDefs.add(fCurrentDefinition); + } + else { + fCurrentDefinition = null; + } + } + + /** + * Processes element which should be a configuration element specifying a partition + * type for the current contentAssistProcessor tag. Assumes that there is a valid + * current contentAssistProcessor tag. + * + * @param element partitiontype configuration element + */ + private void processPartitionTypeTag(IConfigurationElement element) { + // add to current HyperlinkDefinition/contentType + String theId = getId(element); + + if (theId != null) { + fCurrentDefinition.addPartitionType(theId); + } + } + + /* (non-Javadoc) + * @see com.ibm.sse.editor.internal.extension.RegistryReader#readElement(org.eclipse.core.runtime.IConfigurationElement) + */ + protected boolean readElement(IConfigurationElement element) { + String tag = element.getName(); + + if (tag.equals(targetContributionTag)) { + processContentAssistProcessorTag(element); + + if (fCurrentDefinition != null) { + readElementChildren(element); + } + return true; + } + else if (tag.equals(TAG_PARTITION_TYPE)) { + processPartitionTypeTag(element); + return true; + } + + return false; + } + + private void initCache() { + if (fContentAssistProcessorDefs == null) { + readContributions(TAG_CONTENTASSISTPROCESSOR, PL_CONTENTASSISTPROCESSOR); + } + } + + /** + * Returns all the ContentAssistProcessor definition objects + * @return + */ + public ContentAssistProcessorDefinition[] getContentAssistProcessorDefinitions() { + initCache(); + return (fContentAssistProcessorDefs == null ? new ContentAssistProcessorDefinition[0] : + (ContentAssistProcessorDefinition[])fContentAssistProcessorDefs.toArray(new ContentAssistProcessorDefinition[fContentAssistProcessorDefs.size()])); + } + + /** + * Returns all the ContentAssistProcessor definition objects valid for partitionType + * + * @param partitionType + * @return if partitionType is null, null is returned + */ + public ContentAssistProcessorDefinition[] getContentAssistProcessorDefinitions(String partitionType) { + if (partitionType == null) { + return null; + } + + ContentAssistProcessorDefinition[] allDefs = getContentAssistProcessorDefinitions(); + List defs = new ArrayList(); + List lastDefs = new ArrayList(); + + for (int i = 0; i < allDefs.length; ++i) { + List partitions = (List) allDefs[i].getPartitionTypes(); + if (partitions != null) { + if (partitions.isEmpty()) { + lastDefs.add(allDefs[i]); + } + else { + int j = 0; + boolean added = false; + while (j < partitions.size() && !added) { + if (partitionType.equals(partitions.get(j))) { + defs.add(allDefs[i]); + added = true; + } + else { + ++j; + } + } + } + } + } + defs.addAll(lastDefs); + + return (ContentAssistProcessorDefinition[]) defs.toArray(new ContentAssistProcessorDefinition[defs.size()]); + } + + /** + * @param tag + * @param extensionPoint + */ + protected void readContributions(String tag, String extensionPoint) { + targetContributionTag = tag; + IExtensionRegistry registry = Platform.getExtensionRegistry(); + readRegistry(registry, XmlEditorPlugin.PLUGIN_ID, extensionPoint); + } + + /** + * Override to improve sorting + */ + protected IExtension[] orderExtensions(IExtension[] extensions) { + Object[] sorted = createSorter().sort(extensions); + IExtension[] sortedExtension = new IExtension[sorted.length]; + System.arraycopy(sorted, 0, sortedExtension, 0, sorted.length); + return sortedExtension; + } + + protected Sorter createSorter() { + return new Sorter() { + public boolean compare(Object extension1, Object extension2) { + String s1 = ((IExtension) extension1).getUniqueIdentifier().toUpperCase(); + String s2 = ((IExtension) extension2).getUniqueIdentifier().toUpperCase(); + return s2.compareTo(s1) > 0; + } + }; + } + + protected void logUnknownElement(IConfigurationElement element) { + //do nothing + } +} Copied: trunk/common/plugins/org.jboss.tools.common.text.xml/src/org/jboss/tools/common/text/xml/contentassist/ContentAssistProcessorDefinition.java (from rev 2279, trunk/common/plugins/org.jboss.tools.common.text.ext/src/org/jboss/tools/common/text/ext/contentassist/ContentAssistProcessorDefinition.java) =================================================================== --- trunk/common/plugins/org.jboss.tools.common.text.xml/src/org/jboss/tools/common/text/xml/contentassist/ContentAssistProcessorDefinition.java (rev 0) +++ trunk/common/plugins/org.jboss.tools.common.text.xml/src/org/jboss/tools/common/text/xml/contentassist/ContentAssistProcessorDefinition.java 2007-07-04 14:14:20 UTC (rev 2285) @@ -0,0 +1,139 @@ +/******************************************************************************* + * Copyright (c) 2007 Red Hat, Inc. + * Distributed under license by Red Hat, Inc. All rights reserved. + * This program is made available under the terms of the + * Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + * + * Contributor: + * Red Hat, Inc. - initial API and implementation + ******************************************************************************/ + +package org.jboss.tools.common.text.xml.contentassist; + +import java.util.ArrayList; +import java.util.List; + +import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IConfigurationElement; +import org.eclipse.core.runtime.Platform; +import org.eclipse.jface.text.contentassist.IContentAssistProcessor; +import org.eclipse.swt.custom.BusyIndicator; +import org.jboss.tools.common.text.xml.XmlEditorPlugin; +import org.osgi.framework.Bundle; + +public class ContentAssistProcessorDefinition { + private String fId = null; + private String fClassName = null; + + // a list of partition types (String) + private List fPartitionTypes = null; + + private IConfigurationElement fConfigurationElement = null; + + /** + * @param id + * @param class1 + * @param configurationElement + */ + public ContentAssistProcessorDefinition(String id, String class1, IConfigurationElement configurationElement) { + super(); + fId = id; + fClassName = class1; + fConfigurationElement = configurationElement; + fPartitionTypes = new ArrayList(); + } + + public void addPartitionType(String partitionType) { + if (!fPartitionTypes.contains(partitionType)) + fPartitionTypes.add(partitionType); + } + + /** + * @return Returns the fClass. + */ + public String getClassName() { + return fClassName; + } + + /** + * @return Returns the fConfigurationElement. + */ + public IConfigurationElement getConfigurationElement() { + return fConfigurationElement; + } + + /** + * @return Returns the fId. + */ + public String getId() { + return fId; + } + + /** + * @return IContentAssistProcessor for this definition + */ + public IContentAssistProcessor createContentAssistProcessor() { + IContentAssistProcessor contentAssistProcessor = null; + + if (getClassName() != null) { + contentAssistProcessor = (IContentAssistProcessor) createExtension(ContentAssistProcessorBuilder.ATT_CLASS); + } + + return contentAssistProcessor; + } + + /** + * Creates an extension. If the extension plugin has not + * been loaded a busy cursor will be activated during the duration of + * the load. + * @param propertyName + * @return Object + */ + private Object createExtension(String propertyName) { + // If plugin has been loaded create extension. + // Otherwise, show busy cursor then create extension. + final IConfigurationElement element = getConfigurationElement(); + final String name = propertyName; + + final Object[] result = new Object[1]; + Bundle bundle = Platform.getBundle(element.getDeclaringExtension().getNamespaceIdentifier()); + if (bundle.getState() == org.osgi.framework.Bundle.ACTIVE) { + try { + return element.createExecutableExtension(name); + } + catch (CoreException e) { + handleCreateExecutableException(result, e); + } + } + else { + BusyIndicator.showWhile(null, new Runnable() { + public void run() { + try { + result[0] = element.createExecutableExtension(name); + } + catch (Exception e) { + handleCreateExecutableException(result, e); + } + } + }); + } + return result[0]; + } + + /** + * @param result + * @param e + */ + private void handleCreateExecutableException(Object[] result, Exception x) { + XmlEditorPlugin.getPluginLog().logError("Error in creating extension", x); + result[0] = null; + } + + /** + * @return Returns the fPartitionTypes. + */ + public List getPartitionTypes() { + return fPartitionTypes; + } +}