]> gerrit.simantics Code Review - simantics/platform.git/blobdiff - bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/extension/ContributorBindingExtensionManager.java
Migrated source code from Simantics SVN
[simantics/platform.git] / bundles / org.simantics.browsing.ui.common / src / org / simantics / browsing / ui / common / extension / ContributorBindingExtensionManager.java
diff --git a/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/extension/ContributorBindingExtensionManager.java b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/extension/ContributorBindingExtensionManager.java
new file mode 100644 (file)
index 0000000..4f03eb1
--- /dev/null
@@ -0,0 +1,170 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.browsing.ui.common.extension;\r
+\r
+import java.util.Arrays;\r
+import java.util.HashSet;\r
+import java.util.Set;\r
+\r
+import org.eclipse.core.runtime.CoreException;\r
+import org.eclipse.core.runtime.IConfigurationElement;\r
+import org.eclipse.core.runtime.IExtension;\r
+import org.eclipse.core.runtime.IExtensionPoint;\r
+import org.eclipse.core.runtime.Platform;\r
+import org.eclipse.core.runtime.dynamichelpers.ExtensionTracker;\r
+import org.eclipse.core.runtime.dynamichelpers.IExtensionChangeHandler;\r
+import org.eclipse.core.runtime.dynamichelpers.IExtensionTracker;\r
+import org.eclipse.core.runtime.dynamichelpers.IFilter;\r
+import org.simantics.browsing.ui.common.Activator;\r
+import org.simantics.browsing.ui.common.extension.internal.ContributorBindingExtension;\r
+import org.simantics.browsing.ui.common.extension.internal.ContributorImplementationBinding;\r
+import org.simantics.browsing.ui.common.extension.internal.ContributorReferenceBinding;\r
+import org.simantics.browsing.ui.content.Contributor;\r
+import org.simantics.browsing.ui.content.ContributorBinding;\r
+import org.simantics.scl.reflection.OntologyVersions;\r
+import org.simantics.utils.strings.StringUtils;\r
+\r
+/**\r
+ * @author Antti Villberg\r
+ */\r
+public abstract class ContributorBindingExtensionManager<Factory> implements IExtensionChangeHandler {\r
+\r
+    private final static String                    NAMESPACE  = Activator.PLUGIN_ID;\r
+\r
+    private ExtensionTracker                       tracker;\r
+\r
+    private static final OntologyVersions VERSIONS = OntologyVersions.getInstance();\r
+    \r
+    @SuppressWarnings("unchecked")\r
+    private ContributorBindingExtension<Factory>[] extensions = new ContributorBindingExtension[0];\r
+\r
+    abstract String getExtensionPointName();\r
+\r
+    ContributorBindingExtensionManager() {\r
+        tracker = new ExtensionTracker();\r
+\r
+        // Cache defined actions\r
+        IExtensionPoint expt = Platform.getExtensionRegistry().getExtensionPoint(NAMESPACE, getExtensionPointName());\r
+        loadExtensions(expt.getConfigurationElements());\r
+\r
+        // Start tracking for new and removed extensions\r
+        IFilter filter = ExtensionTracker.createExtensionPointFilter(expt);\r
+        tracker.registerHandler(this, filter);\r
+    }\r
+\r
+    @SuppressWarnings("unchecked")\r
+    void close() {\r
+        tracker.close();\r
+        tracker = null;\r
+        extensions = new ContributorBindingExtension[0];\r
+    }\r
+\r
+    public ContributorBindingExtension<Factory>[] getExtensions() {\r
+        return extensions;\r
+    }\r
+\r
+    abstract ContributorReferenceBinding<Factory> createReferenceBinding(double preference, String browseContext, String factoryId);\r
+\r
+    @SuppressWarnings("unchecked")\r
+    private void loadExtensions(IConfigurationElement[] elements) {\r
+\r
+        Set<ContributorBindingExtension<Factory>> newExtensions = new HashSet<ContributorBindingExtension<Factory>>(Arrays.asList(extensions));\r
+\r
+        for (IConfigurationElement el : elements) {\r
+\r
+            String browseContext = VERSIONS.currentVersion(StringUtils.safeString(el.getAttribute("browseContext")));\r
+\r
+            for(IConfigurationElement child : el.getChildren("reference")) {\r
+\r
+                double preference = StringUtils.safeDouble(child.getAttribute("preference"));\r
+                String factoryId = StringUtils.safeString(child.getAttribute("id"));\r
+//                ContributionBindingExtension<Factory> ext = new ImagerContributionReferenceBinding(preference, browseContext, factoryId);\r
+                ContributorBindingExtension<Factory> ext = createReferenceBinding(preference, browseContext, factoryId);\r
+\r
+                // Start tracking the new extension object, its removal will be notified of\r
+                // with removeExtension(extension, Object[]).\r
+                tracker.registerObject(el.getDeclaringExtension(), ext, IExtensionTracker.REF_STRONG);\r
+\r
+                newExtensions.add(ext);\r
+\r
+            }\r
+\r
+            for(IConfigurationElement child : el.getChildren("implementation")) {\r
+\r
+                double preference = StringUtils.safeDouble(child.getAttribute("preference"));\r
+\r
+                try {\r
+\r
+                    Contributor<Factory> factory = (Contributor<Factory>) child.createExecutableExtension("class");\r
+                    ContributorBindingExtension<Factory> ext = new ContributorImplementationBinding<Factory>(preference, browseContext, factory);\r
+\r
+                    // Start tracking the new extension object, its removal will be notified of\r
+                    // with removeExtension(extension, Object[]).\r
+                    tracker.registerObject(el.getDeclaringExtension(), ext, IExtensionTracker.REF_STRONG);\r
+\r
+                    newExtensions.add(ext);\r
+\r
+                } catch (CoreException e) {\r
+\r
+                    System.out.println(" == Could not load ViewpointContributionFactory '" + child.getAttribute("class") + "' due to the following error: " + e.getMessage()  );\r
+                       \r
+                }\r
+\r
+            }\r
+\r
+        }\r
+\r
+        // Atomic assignment\r
+        this.extensions = newExtensions.toArray(new ContributorBindingExtension[newExtensions.size()]);\r
+    }\r
+\r
+    @Override\r
+    public void addExtension(IExtensionTracker tracker, IExtension extension) {\r
+        loadExtensions(extension.getConfigurationElements());\r
+    }\r
+\r
+    @SuppressWarnings("unchecked")\r
+    @Override\r
+    public void removeExtension(IExtension extension, Object[] objects) {\r
+        Set<ContributorBindingExtension<Factory>> newExtensions = new HashSet<ContributorBindingExtension<Factory>>(Arrays.asList(extensions));\r
+\r
+        for (Object o : objects) {\r
+            tracker.unregisterObject(extension, o);\r
+            newExtensions.remove(o);\r
+        }\r
+\r
+        // Atomic assignment\r
+        this.extensions = newExtensions.toArray(new ContributorBindingExtension[newExtensions.size()]);\r
+    }\r
+\r
+    public Set<ContributorBinding<Factory>> getBoundContributions(Set<String> browseContexts) {\r
+\r
+        HashSet<ContributorBinding<Factory>> result = new HashSet<ContributorBinding<Factory>>();\r
+\r
+        for(ContributorBindingExtension<Factory> binding : getExtensions()) {\r
+            if(browseContexts.contains(binding.getBrowseContext())) {\r
+                Contributor<Factory> factory = binding.getFactory();\r
+                if(factory != null) {\r
+//                    System.out.println("----------- Plugin contribution " + binding.getFactory() + " " + binding.getPreference());\r
+                    result.add(new ContributorBindingImpl<Factory>(binding.getPreference(), factory));\r
+                } else {\r
+//                    System.out.println("FAILED: ----------- No factory for " + binding);\r
+                }\r
+\r
+            }\r
+        }\r
+\r
+        return result;\r
+\r
+    }\r
+\r
+}\r