Bug 542947 - [doc.gen] add launch config for documentation generator

Change-Id: I0cde2a02f65203e50b199c727b83dfdfc7aaaab4

13 files changed, 292 insertions, 0 deletions

diff --git a/plugins/org.eclipse.etrice.generator.launch.doc/.classpath b/plugins/org.eclipse.etrice.generator.launch.doc/.classpath
new file mode 100644
index 000000000..eca7bdba8
--- /dev/null
+++ b/plugins/org.eclipse.etrice.generator.launch.doc/.classpath
@@ -0,0 +1,7 @@
+<?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="output" path="bin"/>
+</classpath>
diff --git a/plugins/org.eclipse.etrice.generator.launch.doc/.gitignore b/plugins/org.eclipse.etrice.generator.launch.doc/.gitignore
new file mode 100644
index 000000000..fe99505dc
--- /dev/null
+++ b/plugins/org.eclipse.etrice.generator.launch.doc/.gitignore
@@ -0,0 +1,2 @@
+bin
+
diff --git a/plugins/org.eclipse.etrice.generator.launch.doc/.project b/plugins/org.eclipse.etrice.generator.launch.doc/.project
new file mode 100644
index 000000000..288ab87f7
--- /dev/null
+++ b/plugins/org.eclipse.etrice.generator.launch.doc/.project
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>org.eclipse.etrice.generator.launch.doc</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<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>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.pde.PluginNature</nature>
+		<nature>org.eclipse.jdt.core.javanature</nature>
+	</natures>
+</projectDescription>
diff --git a/plugins/org.eclipse.etrice.generator.launch.doc/.settings/org.eclipse.jdt.core.prefs b/plugins/org.eclipse.etrice.generator.launch.doc/.settings/org.eclipse.jdt.core.prefs
new file mode 100644
index 000000000..0c68a61dc
--- /dev/null
+++ b/plugins/org.eclipse.etrice.generator.launch.doc/.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
diff --git a/plugins/org.eclipse.etrice.generator.launch.doc/META-INF/MANIFEST.MF b/plugins/org.eclipse.etrice.generator.launch.doc/META-INF/MANIFEST.MF
new file mode 100644
index 000000000..bc57860c9
--- /dev/null
+++ b/plugins/org.eclipse.etrice.generator.launch.doc/META-INF/MANIFEST.MF
@@ -0,0 +1,19 @@
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-Name: eTrice Doc Generator Launcher
+Bundle-SymbolicName: org.eclipse.etrice.generator.launch.doc;singleton:=true
+Bundle-Version: 2.0.0.qualifier
+Bundle-Activator: org.eclipse.etrice.generator.launch.doc.Activator
+Require-Bundle: org.eclipse.etrice.generator;bundle-version="2.0.0",
+ org.eclipse.etrice.generator.doc;bundle-version="2.0.0",
+ org.eclipse.etrice.generator.base;bundle-version="2.0.0",
+ org.eclipse.ui,
+ org.eclipse.core.runtime,
+ org.eclipse.etrice.generator.launch,
+ org.eclipse.debug.ui,
+ org.eclipse.jdt.launching
+Bundle-RequiredExecutionEnvironment: JavaSE-1.8
+Automatic-Module-Name: org.eclipse.etrice.generator.doc.launch
+Bundle-ActivationPolicy: lazy
+Bundle-Vendor: Eclipse eTrice
+Export-Package: org.eclipse.etrice.generator.launch.doc
diff --git a/plugins/org.eclipse.etrice.generator.launch.doc/build.properties b/plugins/org.eclipse.etrice.generator.launch.doc/build.properties
new file mode 100644
index 000000000..6c480f39f
--- /dev/null
+++ b/plugins/org.eclipse.etrice.generator.launch.doc/build.properties
@@ -0,0 +1,6 @@
+source.. = src/
+output.. = bin/
+bin.includes = META-INF/,\
+               .,\
+               plugin.xml,\
+               icons/
diff --git a/plugins/org.eclipse.etrice.generator.launch.doc/icons/eTrice-launch.gif b/plugins/org.eclipse.etrice.generator.launch.doc/icons/eTrice-launch.gif
new file mode 100644
index 000000000..ca3906465
--- /dev/null
+++ b/plugins/org.eclipse.etrice.generator.launch.doc/icons/eTrice-launch.gif
diff --git a/plugins/org.eclipse.etrice.generator.launch.doc/plugin.xml b/plugins/org.eclipse.etrice.generator.launch.doc/plugin.xml
new file mode 100644
index 000000000..8656524db
--- /dev/null
+++ b/plugins/org.eclipse.etrice.generator.launch.doc/plugin.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?eclipse version="3.4"?>
+<plugin>
+   <extension
+         point="org.eclipse.debug.core.launchConfigurationTypes">
+      <launchConfigurationType
+            delegate="org.eclipse.etrice.generator.launch.doc.DocGeneratorLaunchConfigurationDelegate"
+            delegateDescription="Generates Documentation from ROOM models"
+            delegateName="eTrice Doc Generator Delegate"
+            id="org.eclipse.etrice.generator.launch.doc.launchConfigurationType"
+            modes="run,debug"
+            name="eTrice Doc Generator">
+      </launchConfigurationType>
+   </extension>
+   <extension
+         point="org.eclipse.debug.ui.launchConfigurationTypeImages">
+      <launchConfigurationTypeImage
+            configTypeID="org.eclipse.etrice.generator.launch.doc.launchConfigurationType"
+            icon="icons/eTrice-launch.gif"
+            id="org.eclipse.etrice.generator.launch.doc.launchConfigurationTypeImage">
+      </launchConfigurationTypeImage>
+   </extension>
+   <extension
+         point="org.eclipse.debug.ui.launchConfigurationTabGroups">
+      <launchConfigurationTabGroup
+            class="org.eclipse.etrice.generator.launch.doc.DocGeneratorLaunchConfigurationTabGroup"
+            description="Tab Group for eTrice Doc Generator Launch Configurations"
+            id="org.eclipse.etrice.generator.launch.doc.launchConfigurationTabGroup"
+            type="org.eclipse.etrice.generator.launch.doc.launchConfigurationType">
+      </launchConfigurationTabGroup>
+   </extension>
+</plugin>
diff --git a/plugins/org.eclipse.etrice.generator.launch.doc/src/org/eclipse/etrice/generator/launch/doc/Activator.java b/plugins/org.eclipse.etrice.generator.launch.doc/src/org/eclipse/etrice/generator/launch/doc/Activator.java
new file mode 100644
index 000000000..ac08ceca1
--- /dev/null
+++ b/plugins/org.eclipse.etrice.generator.launch.doc/src/org/eclipse/etrice/generator/launch/doc/Activator.java
@@ -0,0 +1,50 @@
+package org.eclipse.etrice.generator.launch.doc;
+
+import org.eclipse.ui.plugin.AbstractUIPlugin;
+import org.osgi.framework.BundleContext;
+
+/**
+ * The activator class controls the plug-in life cycle
+ */
+public class Activator extends AbstractUIPlugin {
+
+	// The plug-in ID
+	public static final String PLUGIN_ID = "org.eclipse.etrice.generator.doc.launch"; //$NON-NLS-1$
+
+	// The shared instance
+	private static Activator plugin;
+	
+	/**
+	 * The constructor
+	 */
+	public Activator() {
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext)
+	 */
+	public void start(BundleContext context) throws Exception {
+		super.start(context);
+		plugin = this;
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext)
+	 */
+	public void stop(BundleContext context) throws Exception {
+		plugin = null;
+		super.stop(context);
+	}
+
+	/**
+	 * Returns the shared instance
+	 *
+	 * @return the shared instance
+	 */
+	public static Activator getDefault() {
+		return plugin;
+	}
+
+}
diff --git a/plugins/org.eclipse.etrice.generator.launch.doc/src/org/eclipse/etrice/generator/launch/doc/DocGeneratorConfigTab.java b/plugins/org.eclipse.etrice.generator.launch.doc/src/org/eclipse/etrice/generator/launch/doc/DocGeneratorConfigTab.java
new file mode 100644
index 000000000..8d2051370
--- /dev/null
+++ b/plugins/org.eclipse.etrice.generator.launch.doc/src/org/eclipse/etrice/generator/launch/doc/DocGeneratorConfigTab.java
@@ -0,0 +1,28 @@
+/*******************************************************************************
+ * Copyright (c) 2011 protos software gmbh (http://www.protos.de).
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License 2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ * 
+ * CONTRIBUTORS:
+ * 		Juergen Haug (initial contribution)
+ * 
+ *******************************************************************************/
+
+package org.eclipse.etrice.generator.launch.doc;
+
+import org.eclipse.etrice.generator.launch.GeneratorConfigTab;
+
+public class DocGeneratorConfigTab extends GeneratorConfigTab {
+
+	/* (non-Javadoc)
+	 * @see org.eclipse.debug.ui.ILaunchConfigurationTab#getName()
+	 */
+	@Override
+	public String getName() {
+		return "Doc Generator";
+	}
+}
diff --git a/plugins/org.eclipse.etrice.generator.launch.doc/src/org/eclipse/etrice/generator/launch/doc/DocGeneratorLaunchConfigurationDelegate.java b/plugins/org.eclipse.etrice.generator.launch.doc/src/org/eclipse/etrice/generator/launch/doc/DocGeneratorLaunchConfigurationDelegate.java
new file mode 100644
index 000000000..fbfc032b1
--- /dev/null
+++ b/plugins/org.eclipse.etrice.generator.launch.doc/src/org/eclipse/etrice/generator/launch/doc/DocGeneratorLaunchConfigurationDelegate.java
@@ -0,0 +1,41 @@
+/*******************************************************************************
+ * Copyright (c) 2011 protos software gmbh (http://www.protos.de).
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License 2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ * 
+ * CONTRIBUTORS:
+ * 		Juergen Haug (initial contribution)
+ * 
+ *******************************************************************************/
+
+package org.eclipse.etrice.generator.launch.doc;
+
+import org.eclipse.etrice.generator.base.io.ILineOutput;
+import org.eclipse.etrice.generator.doc.Main;
+import org.eclipse.etrice.generator.launch.GeneratorLaunchConfigurationDelegate;
+
+
+public class DocGeneratorLaunchConfigurationDelegate extends GeneratorLaunchConfigurationDelegate {
+
+	/* (non-Javadoc)
+	 * @see org.eclipse.etrice.generator.launch.GeneratorLaunchConfigurationDelegate#runGenerator(java.lang.String[], org.eclipse.etrice.generator.launch.ILineOutput)
+	 */
+	@Override
+	protected void runGenerator(String[] args, ILineOutput out) {
+		Main.setOutput(out);
+		Main.run(args);
+	}
+
+	/* (non-Javadoc)
+	 * @see org.eclipse.etrice.generator.launch.GeneratorLaunchConfigurationDelegate#getConsoleName()
+	 */
+	@Override
+	protected String getConsoleName() {
+		return "eTrice Doc Generator Console";
+	}
+
+}
diff --git a/plugins/org.eclipse.etrice.generator.launch.doc/src/org/eclipse/etrice/generator/launch/doc/DocGeneratorLaunchConfigurationTabGroup.java b/plugins/org.eclipse.etrice.generator.launch.doc/src/org/eclipse/etrice/generator/launch/doc/DocGeneratorLaunchConfigurationTabGroup.java
new file mode 100644
index 000000000..6e7db241c
--- /dev/null
+++ b/plugins/org.eclipse.etrice.generator.launch.doc/src/org/eclipse/etrice/generator/launch/doc/DocGeneratorLaunchConfigurationTabGroup.java
@@ -0,0 +1,38 @@
+/*******************************************************************************
+ * Copyright (c) 2011 protos software gmbh (http://www.protos.de).
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License 2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ * 
+ * CONTRIBUTORS:
+ * 		Juergen Haug (initial contribution)
+ * 
+ *******************************************************************************/
+
+package org.eclipse.etrice.generator.launch.doc;
+
+import org.eclipse.debug.ui.AbstractLaunchConfigurationTabGroup;
+import org.eclipse.debug.ui.CommonTab;
+import org.eclipse.debug.ui.EnvironmentTab;
+import org.eclipse.debug.ui.ILaunchConfigurationDialog;
+import org.eclipse.debug.ui.ILaunchConfigurationTab;
+import org.eclipse.etrice.generator.launch.GeneratorRefreshTab;
+
+public class DocGeneratorLaunchConfigurationTabGroup extends AbstractLaunchConfigurationTabGroup {
+
+	@Override
+	public void createTabs(ILaunchConfigurationDialog dialog, String mode) {
+		ILaunchConfigurationTab[] tabs = new ILaunchConfigurationTab[] {
+				new DocGeneratorMainTab(),
+				new DocGeneratorConfigTab(),
+				new GeneratorRefreshTab(),
+				new EnvironmentTab(),
+				new CommonTab()
+			};
+		setTabs(tabs);
+	}
+
+}
diff --git a/plugins/org.eclipse.etrice.generator.launch.doc/src/org/eclipse/etrice/generator/launch/doc/DocGeneratorMainTab.java b/plugins/org.eclipse.etrice.generator.launch.doc/src/org/eclipse/etrice/generator/launch/doc/DocGeneratorMainTab.java
new file mode 100644
index 000000000..c47c4eb9e
--- /dev/null
+++ b/plugins/org.eclipse.etrice.generator.launch.doc/src/org/eclipse/etrice/generator/launch/doc/DocGeneratorMainTab.java
@@ -0,0 +1,34 @@
+/*******************************************************************************
+ * Copyright (c) 2011 protos software gmbh (http://www.protos.de).
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License 2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ * 
+ * CONTRIBUTORS:
+ * 		Juergen Haug (initial contribution)
+ * 
+ *******************************************************************************/
+
+package org.eclipse.etrice.generator.launch.doc;
+
+import org.eclipse.core.resources.IResource;
+import org.eclipse.etrice.generator.launch.GeneratorMainTab;
+
+
+public class DocGeneratorMainTab extends GeneratorMainTab {
+
+	/* (non-Javadoc)
+	 * @see org.eclipse.etrice.generator.launch.GeneratorMainTab#isValidModelFile(org.eclipse.core.resources.IResource)
+	 */
+	@Override
+	protected boolean isValidModelFile(IResource resource) {
+		return resource.getName().endsWith(".room")
+				|| resource.getName().endsWith(".config")
+				|| resource.getName().endsWith(".etphys")
+				|| resource.getName().endsWith(".etmap");
+	}
+
+}