bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/extension/ContributorBindingExtensionManager.java

   1 /*******************************************************************************
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management
   3  * in Industry THTH ry.
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *     VTT Technical Research Centre of Finland - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.browsing.ui.common.extension;
  13
  14 import java.util.Arrays;
  15 import java.util.HashSet;
  16 import java.util.Set;
  17
  18 import org.eclipse.core.runtime.CoreException;
  19 import org.eclipse.core.runtime.IConfigurationElement;
  20 import org.eclipse.core.runtime.IExtension;
  21 import org.eclipse.core.runtime.IExtensionPoint;
  22 import org.eclipse.core.runtime.Platform;
  23 import org.eclipse.core.runtime.dynamichelpers.ExtensionTracker;
  24 import org.eclipse.core.runtime.dynamichelpers.IExtensionChangeHandler;
  25 import org.eclipse.core.runtime.dynamichelpers.IExtensionTracker;
  26 import org.eclipse.core.runtime.dynamichelpers.IFilter;
  27 import org.simantics.browsing.ui.common.Activator;
  28 import org.simantics.browsing.ui.common.extension.internal.ContributorBindingExtension;
  29 import org.simantics.browsing.ui.common.extension.internal.ContributorImplementationBinding;
  30 import org.simantics.browsing.ui.common.extension.internal.ContributorReferenceBinding;
  31 import org.simantics.browsing.ui.content.Contributor;
  32 import org.simantics.browsing.ui.content.ContributorBinding;
  33 import org.simantics.scl.reflection.OntologyVersions;
  34 import org.simantics.utils.strings.StringUtils;
  35
  36 /**
  37  * @author Antti Villberg
  38  */
  39 public abstract class ContributorBindingExtensionManager<Factory> implements IExtensionChangeHandler {
  40
  41     private final static String                    NAMESPACE  = Activator.PLUGIN_ID;
  42
  43     private ExtensionTracker                       tracker;
  44
  45     private static final OntologyVersions VERSIONS = OntologyVersions.getInstance();
  46
  47     @SuppressWarnings("unchecked")
  48     private ContributorBindingExtension<Factory>[] extensions = new ContributorBindingExtension[0];
  49
  50     abstract String getExtensionPointName();
  51
  52     ContributorBindingExtensionManager() {
  53         tracker = new ExtensionTracker();
  54
  55         // Cache defined actions
  56         IExtensionPoint expt = Platform.getExtensionRegistry().getExtensionPoint(NAMESPACE, getExtensionPointName());
  57         loadExtensions(expt.getConfigurationElements());
  58
  59         // Start tracking for new and removed extensions
  60         IFilter filter = ExtensionTracker.createExtensionPointFilter(expt);
  61         tracker.registerHandler(this, filter);
  62     }
  63
  64     @SuppressWarnings("unchecked")
  65     void close() {
  66         tracker.close();
  67         tracker = null;
  68         extensions = new ContributorBindingExtension[0];
  69     }
  70
  71     public ContributorBindingExtension<Factory>[] getExtensions() {
  72         return extensions;
  73     }
  74
  75     abstract ContributorReferenceBinding<Factory> createReferenceBinding(double preference, String browseContext, String factoryId);
  76
  77     @SuppressWarnings("unchecked")
  78     private void loadExtensions(IConfigurationElement[] elements) {
  79
  80         Set<ContributorBindingExtension<Factory>> newExtensions = new HashSet<ContributorBindingExtension<Factory>>(Arrays.asList(extensions));
  81
  82         for (IConfigurationElement el : elements) {
  83
  84             String browseContext = VERSIONS.currentVersion(StringUtils.safeString(el.getAttribute("browseContext")));
  85
  86             for(IConfigurationElement child : el.getChildren("reference")) {
  87
  88                 double preference = StringUtils.safeDouble(child.getAttribute("preference"));
  89                 String factoryId = StringUtils.safeString(child.getAttribute("id"));
  90 //                ContributionBindingExtension<Factory> ext = new ImagerContributionReferenceBinding(preference, browseContext, factoryId);
  91                 ContributorBindingExtension<Factory> ext = createReferenceBinding(preference, browseContext, factoryId);
  92
  93                 // Start tracking the new extension object, its removal will be notified of
  94                 // with removeExtension(extension, Object[]).
  95                 tracker.registerObject(el.getDeclaringExtension(), ext, IExtensionTracker.REF_STRONG);
  96
  97                 newExtensions.add(ext);
  98
  99             }
 100
 101             for(IConfigurationElement child : el.getChildren("implementation")) {
 102
 103                 double preference = StringUtils.safeDouble(child.getAttribute("preference"));
 104
 105                 try {
 106
 107                     Contributor<Factory> factory = (Contributor<Factory>) child.createExecutableExtension("class");
 108                     ContributorBindingExtension<Factory> ext = new ContributorImplementationBinding<Factory>(preference, browseContext, factory);
 109
 110                     // Start tracking the new extension object, its removal will be notified of
 111                     // with removeExtension(extension, Object[]).
 112                     tracker.registerObject(el.getDeclaringExtension(), ext, IExtensionTracker.REF_STRONG);
 113
 114                     newExtensions.add(ext);
 115
 116                 } catch (CoreException e) {
 117
 118                     System.out.println(" == Could not load ViewpointContributionFactory '" + child.getAttribute("class") + "' due to the following error: " + e.getMessage()  );
 119
 120                 }
 121
 122             }
 123
 124         }
 125
 126         // Atomic assignment
 127         this.extensions = newExtensions.toArray(new ContributorBindingExtension[newExtensions.size()]);
 128     }
 129
 130     @Override
 131     public void addExtension(IExtensionTracker tracker, IExtension extension) {
 132         loadExtensions(extension.getConfigurationElements());
 133     }
 134
 135     @SuppressWarnings("unchecked")
 136     @Override
 137     public void removeExtension(IExtension extension, Object[] objects) {
 138         Set<ContributorBindingExtension<Factory>> newExtensions = new HashSet<ContributorBindingExtension<Factory>>(Arrays.asList(extensions));
 139
 140         for (Object o : objects) {
 141             tracker.unregisterObject(extension, o);
 142             newExtensions.remove(o);
 143         }
 144
 145         // Atomic assignment
 146         this.extensions = newExtensions.toArray(new ContributorBindingExtension[newExtensions.size()]);
 147     }
 148
 149     public Set<ContributorBinding<Factory>> getBoundContributions(Set<String> browseContexts) {
 150
 151         HashSet<ContributorBinding<Factory>> result = new HashSet<ContributorBinding<Factory>>();
 152
 153         for(ContributorBindingExtension<Factory> binding : getExtensions()) {
 154             if(browseContexts.contains(binding.getBrowseContext())) {
 155                 Contributor<Factory> factory = binding.getFactory();
 156                 if(factory != null) {
 157 //                    System.out.println("----------- Plugin contribution " + binding.getFactory() + " " + binding.getPreference());
 158                     result.add(new ContributorBindingImpl<Factory>(binding.getPreference(), factory));
 159                 } else {
 160 //                    System.out.println("FAILED: ----------- No factory for " + binding);
 161                 }
 162
 163             }
 164         }
 165
 166         return result;
 167
 168     }
 169
 170 }