Advanced Ecore Switching: Composability, new switch API, bytecode-accelerated dynamic cross-package switching

.checkstyle

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<fileset-config file-format-version="1.2.0" simple-config="true" sync-formatter="false">
+  <fileset name="all" enabled="true" check-config-name="Copy of Google Checks" local="false">
+    <file-match-pattern match-pattern="." include-pattern="true"/>
+  </fileset>
+  <filter name="DerivedFiles" enabled="true"/>
+</fileset-config>

.gitignore

@@ -1,6 +1,6 @@
 target/
 bin/
+**/.polyglot.build.properties
 xtend-gen/
-
 *.xtendbin
-*._trace
+*._trace

README.md

@@ -1 +1,3 @@
-# Ecore-Workflow
+# Ecore-Workflow
+
+* see also [Switch Documentation](docu/switches.MD)

bundles/tools.mdsd.ecoreworkflow.mwe2lib/META-INF/MANIFEST.MF

@@ -6,10 +6,13 @@ Bundle-Version: 0.1.0.qualifier
 Automatic-Module-Name: tools.mdsd.ecoreworkflow.mwe2lib
 Bundle-RequiredExecutionEnvironment: JavaSE-1.8
 Export-Package: tools.mdsd.ecoreworkflow.mwe2lib.bean,
- tools.mdsd.ecoreworkflow.mwe2lib.component
+ tools.mdsd.ecoreworkflow.mwe2lib.component,
+ tools.mdsd.ecoreworkflow.mwe2lib.util
 Require-Bundle: org.eclipse.emf.mwe.utils,
  org.eclipse.emf.ecore,
  org.eclipse.emf.mwe.core,
  org.apache.commons.logging,
- org.eclipse.core.resources
+ org.eclipse.core.resources,
+ org.eclipse.emf.codegen.ecore;bundle-version="2.18.0"
 Import-Package: org.eclipse.core.runtime
+DynamicImport-Package: *

bundles/tools.mdsd.ecoreworkflow.mwe2lib/src/tools/mdsd/ecoreworkflow/mwe2lib/component/AdditionalTemplateGenerator.java

@@ -0,0 +1,129 @@
+package tools.mdsd.ecoreworkflow.mwe2lib.component;
+
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.lang.reflect.InvocationTargetException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.eclipse.emf.codegen.ecore.genmodel.GenModel;
+import org.eclipse.emf.codegen.ecore.genmodel.GenPackage;
+import org.eclipse.emf.codegen.ecore.genmodel.impl.GenModelImpl;
+import org.eclipse.emf.common.util.URI;
+import org.eclipse.emf.ecore.resource.Resource;
+import org.eclipse.emf.ecore.resource.ResourceSet;
+import org.eclipse.emf.ecore.resource.impl.ResourceSetImpl;
+import org.eclipse.emf.mwe.core.WorkflowContext;
+import org.eclipse.emf.mwe.core.issues.Issues;
+import org.eclipse.emf.mwe.core.lib.AbstractWorkflowComponent2;
+import org.eclipse.emf.mwe.core.monitor.ProgressMonitor;
+import org.eclipse.emf.mwe2.runtime.Mandatory;
+
+import tools.mdsd.ecoreworkflow.mwe2lib.util.URIToPath;
+
+/**
+ * MWE2 component used to generate an additional extra file for an ecore package
+ * based on a template.
+ *
+ */
+public class AdditionalTemplateGenerator extends AbstractWorkflowComponent2 {
+
+    private String destPath;
+	private String genModel;
+	private List<PackageLevelCodeFileGenerator> packageLevelGenerators;
+
+
+	public AdditionalTemplateGenerator() {
+		packageLevelGenerators = new ArrayList<>();
+	}
+
+	/**
+	 * Set the path to the base folder.
+     * (This is usually a platform:-URL pointing at the target project's src-gen folder).
+     * The template's relative path will be resolved against this URL.
+     * 
+	 * @param destPath path to the base folder
+	 */
+	@Mandatory
+	public void setDestPath(String destPath) {
+		this.destPath = destPath;
+	}
+
+	/**
+     * Set the path to the .genmodel-file.
+     * The template will have acces to the genmodel.
+     * 
+	 * @param genModel path to the .genmodel file
+	 */
+	@Mandatory
+	public void setGenModel(String genModel) {
+		this.genModel = genModel;
+	}
+
+	/**
+	 * Add a template (=generator) to be executed.
+	 * @param gen classname of the generator to be added. Must be on the classpath and must be a subclass of tools.mdsd.ecoreworkflow.mwe2lib.component.PackageLevelCodeFileGenerator.
+	 */
+	public void addPackageLevelGenerator(String gen) {
+		try {
+			packageLevelGenerators.add((PackageLevelCodeFileGenerator) Class.forName(gen).getConstructor().newInstance());
+		} catch (InstantiationException | IllegalAccessException | IllegalArgumentException | InvocationTargetException | NoSuchMethodException | SecurityException | ClassNotFoundException e) {
+			throw new RuntimeException(e);
+		}
+	}
+
+	// This method is the workflow component's entry point.
+	@Override
+	protected void invokeInternal(WorkflowContext workflowContext, ProgressMonitor progressMonitor, Issues issues) {
+		// ProgressMonitor is a (useless) NullProgressMonitor in the mwe2 context :(
+		progressMonitor.beginTask("Creating additional templates", 20);
+
+		GenModel loadedGenModel = loadGenModel(this.genModel);
+		runGenerator(loadedGenModel);
+
+		progressMonitor.done();
+
+	}
+
+	/**
+	 * Load the genmodel as an ecore resource
+	 * @param pathToGenmodelFile TODO
+	 * @return
+	 */
+    private GenModel loadGenModel(String pathToGenmodelFile) {
+        ResourceSet resSet = new ResourceSetImpl();
+  		Resource resource = resSet.getResource(URI.createURI(pathToGenmodelFile), true);
+  		GenModel genModel = (GenModelImpl) resource.getContents().get(0);
+        return genModel;
+    }
+
+	private void runGenerator(GenModel genModel) {
+		genModel.getGenPackages().forEach(this::generatePackageLevelCode);
+	}
+
+	private void generatePackageLevelCode(GenPackage genPackage) {
+		Path path = Paths.get(new URIToPath().convertUri(URI.createURI(destPath)));
+		for (PackageLevelCodeFileGenerator gen : packageLevelGenerators) {
+			gen.setGenPackage(genPackage);
+			Path outfilePath = path.resolve(gen.getRelativePath());
+
+			try {
+				Files.createDirectories(outfilePath.getParent());
+			} catch (IOException e) {
+				throw new RuntimeException("Parent directory could not be created", e);
+			}
+
+			try (FileOutputStream out = new FileOutputStream(outfilePath.toFile())) {
+				gen.generateCode(out);
+			} catch (IOException e) {
+				throw new RuntimeException("Error writing the generated code", e);
+			}
+		}
+	}
+
+
+
+}

bundles/tools.mdsd.ecoreworkflow.mwe2lib/src/tools/mdsd/ecoreworkflow/mwe2lib/component/GapPatternPostProcessor.java

@@ -17,17 +17,16 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
-import org.eclipse.core.resources.ResourcesPlugin;
-import org.eclipse.core.runtime.Platform;
 import org.eclipse.emf.common.util.URI;
-import org.eclipse.emf.ecore.plugin.EcorePlugin;
 import org.eclipse.emf.ecore.resource.URIConverter;
 import org.eclipse.emf.ecore.resource.impl.ExtensibleURIConverterImpl;
 import org.eclipse.emf.mwe.core.WorkflowContext;
 import org.eclipse.emf.mwe.core.issues.Issues;
 import org.eclipse.emf.mwe.core.lib.AbstractWorkflowComponent2;
 import org.eclipse.emf.mwe.core.monitor.ProgressMonitor;
 
+import tools.mdsd.ecoreworkflow.mwe2lib.util.URIToPath;
+
 public class GapPatternPostProcessor extends AbstractWorkflowComponent2 {
 	private static final String CLASSNAME_MATCHER_PATTERN =
 			"(?<=[^a-zA-Z\\d_$])(%s)(?=[^a-zA-Z\\d_$])";
@@ -61,11 +60,11 @@ protected void invokeInternal(WorkflowContext arg0, ProgressMonitor arg1, Issues
 			try {
 				List<Path> manualFolders = set.getManualSourceFolders().stream()
 						.map(URI::createURI)
-						.map(this::convertUri)
+						.map(new URIToPath()::convertUri)
 						.map(Paths::get).collect(Collectors.toList());
 				List<Path> generatedFolders = set.getGeneratedSourceFolders().stream()
 						.map(URI::createURI)
-						.map(this::convertUri)
+						.map(new URIToPath()::convertUri)
 						.map(Paths::get)
 						.collect(Collectors.toList());
 
@@ -117,19 +116,4 @@ public FileVisitResult visitFile(Path arg0, BasicFileAttributes arg1) throws IOE
 		}
 		arg1.done();
 	}
-
-	protected String convertUri(URI uri) {
-		if (uri.isPlatform()) {
-			if (Platform.isRunning()) {
-				return ResourcesPlugin.getWorkspace().getRoot()
-						.getFile(new org.eclipse.core.runtime.Path(uri.toPlatformString(true))).getLocation()
-						.toString();
-			} else {
-				return EcorePlugin.resolvePlatformResourcePath(uri.toPlatformString(true)).toFileString();
-			}
-		} else {
-			return uriConverter.normalize(uri).toFileString();
-		}
-	}
-
 }

bundles/tools.mdsd.ecoreworkflow.mwe2lib/src/tools/mdsd/ecoreworkflow/mwe2lib/component/PackageLevelCodeFileGenerator.java

@@ -0,0 +1,32 @@
+package tools.mdsd.ecoreworkflow.mwe2lib.component;
+
+import java.io.OutputStream;
+import java.nio.file.Path;
+
+import org.eclipse.emf.codegen.ecore.genmodel.GenPackage;
+
+/**
+ * Generator that can generate an additional single code file given a GenPackage.
+ * The kind and contents of the generated is completely up to the implementation.
+ */
+public interface PackageLevelCodeFileGenerator {
+    /**
+     * Generate the code now.
+     * Must only be invoked after setGenPackage
+     * @param out the output stream to write the code to.
+     */
+	public void generateCode(OutputStream out);
+
+	/**
+	 * Specify where the generated code is to be written to, 
+	 * relative to the src-gen folder of the ecore code generation
+	 * @return a relative Path
+	 */
+	public Path getRelativePath();
+
+	/**
+	 * Set the GenPackage that the code is to be based upon / created for.
+	 * @param genPackage
+	 */
+	public void setGenPackage(GenPackage genPackage);
+}

bundles/tools.mdsd.ecoreworkflow.mwe2lib/src/tools/mdsd/ecoreworkflow/mwe2lib/util/URIToPath.java

@@ -0,0 +1,32 @@
+package tools.mdsd.ecoreworkflow.mwe2lib.util;
+
+import org.eclipse.core.resources.ResourcesPlugin;
+import org.eclipse.core.runtime.Platform;
+import org.eclipse.emf.common.util.URI;
+import org.eclipse.emf.ecore.plugin.EcorePlugin;
+import org.eclipse.emf.ecore.resource.URIConverter;
+import org.eclipse.emf.ecore.resource.impl.ExtensibleURIConverterImpl;
+
+/**
+ * utility class for converting platform: and other URIs to absolute file paths 
+ * (method copied from {@link tools.mdsd.ecoreworkflow.mwe2lib.component.GapPatternPostProcessor})
+ * 
+ *
+ */
+
+public class URIToPath {
+	public String convertUri(URI uri) {
+		if (uri.isPlatform()) {
+			if (Platform.isRunning()) {
+				return ResourcesPlugin.getWorkspace().getRoot()
+						.getFile(new org.eclipse.core.runtime.Path(uri.toPlatformString(true))).getLocation()
+						.toString();
+			} else {
+				return EcorePlugin.resolvePlatformResourcePath(uri.toPlatformString(true)).toFileString();
+			}
+		} else {
+			URIConverter uriConverter = new ExtensibleURIConverterImpl();
+			return uriConverter.normalize(uri).toFileString();
+		}
+	}
+}

bundles/tools.mdsd.ecoreworkflow.switches/.checkstyle

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<fileset-config file-format-version="1.2.0" simple-config="true" sync-formatter="false">
+  <fileset name="all" enabled="true" check-config-name="Copy of Google Checks" local="false">
+    <file-match-pattern match-pattern="." include-pattern="true"/>
+  </fileset>
+  <filter name="DerivedFiles" enabled="true"/>
+</fileset-config>

bundles/tools.mdsd.ecoreworkflow.switches/.classpath

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8"/>
+	<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
+	<classpathentry kind="src" path="src"/>
+	<classpathentry kind="src" path="xtend-gen"/>
+	<classpathentry kind="output" path="bin"/>
+</classpath>

bundles/tools.mdsd.ecoreworkflow.switches/.gitignore

@@ -0,0 +1 @@
+xtend-gen

bundles/tools.mdsd.ecoreworkflow.switches/.project

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>tools.mdsd.ecoreworkflow.switches</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.xtext.ui.shared.xtextBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>org.eclipse.jdt.core.javabuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>org.eclipse.pde.ManifestBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>org.eclipse.pde.SchemaBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>net.sf.eclipsecs.core.CheckstyleBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.pde.PluginNature</nature>
+		<nature>org.eclipse.jdt.core.javanature</nature>
+		<nature>org.eclipse.xtext.ui.shared.xtextNature</nature>
+		<nature>net.sf.eclipsecs.core.CheckstyleNature</nature>
+	</natures>
+</projectDescription>

bundles/tools.mdsd.ecoreworkflow.switches/.settings/org.eclipse.jdt.core.prefs

@@ -0,0 +1,7 @@
+eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8
+org.eclipse.jdt.core.compiler.compliance=1.8
+org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
+org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
+org.eclipse.jdt.core.compiler.source=1.8

bundles/tools.mdsd.ecoreworkflow.switches/META-INF/MANIFEST.MF

@@ -0,0 +1,19 @@
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-Name: MDSD Tools Ecore Workflow Switches
+Bundle-SymbolicName: tools.mdsd.ecoreworkflow.switches
+Bundle-Version: 0.1.0.qualifier
+Automatic-Module-Name: tools.mdsd.ecoreworkflow.switches
+Bundle-RequiredExecutionEnvironment: JavaSE-1.8
+Export-Package: tools.mdsd.ecoreworkflow.switches
+Require-Bundle: org.eclipse.emf.mwe.utils,
+ org.eclipse.emf.ecore,
+ org.eclipse.emf.mwe.core,
+ org.apache.commons.logging,
+ org.eclipse.core.resources,
+ org.eclipse.emf.codegen.ecore;bundle-version="2.18.0",
+ org.eclipse.xtext.xbase.lib;bundle-version="2.18.0",
+ tools.mdsd.ecoreworkflow.mwe2lib;bundle-version="0.1.0",
+ net.bytebuddy.byte-buddy;bundle-version="1.9.0"
+Import-Package: org.eclipse.core.runtime
+DynamicImport-Package: *

bundles/tools.mdsd.ecoreworkflow.switches/build.properties

@@ -0,0 +1,5 @@
+source.. = src/,\
+           xtend-gen/
+output.. = bin/
+bin.includes = META-INF/,\
+               .