eclipse-archived#190 TqCL added javadoc

rtotaro · Feb 13, 2017 · 2cee22e · 2cee22e
1 parent 1117bba
commit 2cee22e
Show file tree

Hide file tree

Showing 15 changed files with 153 additions and 16 deletions.
diff --git a/...xtext.ide/src/main/java/org/eclipse/triquetrum/commands/xtext/ide/TqCLLaunchShortcut.java b/...xtext.ide/src/main/java/org/eclipse/triquetrum/commands/xtext/ide/TqCLLaunchShortcut.java
@@ -1,7 +1,5 @@
 package org.eclipse.triquetrum.commands.xtext.ide;
 
-import java.util.Arrays;
-
 import org.eclipse.core.resources.IFile;
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.debug.ui.ILaunchShortcut;
@@ -10,13 +8,14 @@
 import org.eclipse.triquetrum.commands.interpreter.TqclInterpreter;
 import org.eclipse.ui.IEditorInput;
 import org.eclipse.ui.IEditorPart;
-import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.console.ConsolePlugin;
 import org.eclipse.ui.console.IConsole;
 import org.eclipse.ui.console.IConsoleManager;
 import org.eclipse.ui.console.MessageConsole;
 import org.eclipse.ui.console.MessageConsoleStream;
 
+
+//TODO: TqCL Macro launcher
 public class TqCLLaunchShortcut implements ILaunchShortcut {
 
 	@Override

diff --git a/...de/src/main/java/org/eclipse/triquetrum/commands/xtext/ide/TqCLPtolemyLaunchShortcut.java b/...de/src/main/java/org/eclipse/triquetrum/commands/xtext/ide/TqCLPtolemyLaunchShortcut.java
@@ -15,12 +15,20 @@
 import org.eclipse.ui.console.IConsole;
 import org.eclipse.ui.console.IConsoleManager;
 import org.eclipse.ui.console.MessageConsole;
-import org.eclipse.ui.console.MessageConsoleStream;
 
 import ptolemy.actor.CompositeActor;
 
+/**
+ * Launcher to create and start a ptolemy model
+ * 
+ * @author rtotaro
+ *
+ */
 public class TqCLPtolemyLaunchShortcut implements ILaunchShortcut {
 
+	/* (non-Javadoc)
+	 * @see org.eclipse.debug.ui.ILaunchShortcut#launch(org.eclipse.jface.viewers.ISelection, java.lang.String)
+	 */
 	@SuppressWarnings({ "rawtypes", "unchecked" })
 	@Override
 	public void launch(ISelection selection, String mode) {
@@ -32,16 +40,11 @@ public void launch(ISelection selection, String mode) {
 				IConsoleManager consoleManager = ConsolePlugin.getDefault().getConsoleManager();
 				MessageConsole messageConsole = new MessageConsole(file.getName(), "TqCL", null, false);
 				consoleManager.addConsoles(new IConsole[] { messageConsole });
-//				MessageConsoleStream newMessageStream = messageConsole.newMessageStream();
-				// newMessageStream
 
 				TqclInterpreter interpreter = new TqclInterpreter();
 				CompositeActor model = (CompositeActor) interpreter.interpret(file.getName(), file.getContents(),
 						file.getParent().getLocationURI(), CompositeActor.class);
 
-//				String moml = model.exportMoML();
-//				
-//				System.out.println(moml);
 
 				//workflow service could be exposed by a different plugin; not workflow editor
 				WorkflowExecutionService executionService = TriqEditorPlugin.getDefault().getWorkflowExecutionService();
@@ -54,6 +57,9 @@ public void launch(ISelection selection, String mode) {
 		}
 	}
 
+	/* (non-Javadoc)
+	 * @see org.eclipse.debug.ui.ILaunchShortcut#launch(org.eclipse.ui.IEditorPart, java.lang.String)
+	 */
 	@Override
 	public void launch(IEditorPart editor, String mode) {
 		// TODO Auto-generated method stub

diff --git a/.../src/main/java/org/eclipse/triquetrum/commands/ui/contentassist/TqclProposalProvider.java b/.../src/main/java/org/eclipse/triquetrum/commands/ui/contentassist/TqclProposalProvider.java
@@ -166,7 +166,6 @@ public void completeInsert_Name(EObject model, Assignment assignment, ContentAss
 	@Override
 	public void completeConnectionPort_Port(EObject model, Assignment assignment, ContentAssistContext context,
 			ICompletionProposalAcceptor acceptor) {
-		// TODO Auto-generated method stub
 		super.completeConnectionPort_Port(model, assignment, context, acceptor);
 		if (model instanceof ConnectionPort) {
 			ConnectionPort connectionPort = (ConnectionPort) model;

diff --git a/...t.ui/src/main/java/org/eclipse/triquetrum/commands/ui/editor/TriquetrumCommandEditor.java b/...t.ui/src/main/java/org/eclipse/triquetrum/commands/ui/editor/TriquetrumCommandEditor.java
@@ -10,8 +10,6 @@
  *******************************************************************************/
 package org.eclipse.triquetrum.commands.ui.editor;
 
-import org.eclipse.jface.text.ITextSelection;
-import org.eclipse.jface.viewers.ISelection;
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.events.KeyAdapter;
 import org.eclipse.swt.events.KeyEvent;

diff --git a/...ava/org/eclipse/triquetrum/commands/interpreter/CompositeCommandInterpreterComponent.java b/...ava/org/eclipse/triquetrum/commands/interpreter/CompositeCommandInterpreterComponent.java
@@ -10,8 +10,16 @@
 import org.eclipse.triquetrum.commands.tqcl.Go;
 import org.eclipse.triquetrum.commands.tqcl.TqclPackage;
 
+/**
+ * Interpreter component for {@link CompositeCommand}
+ * @author rtotaro
+ */
 public class CompositeCommandInterpreterComponent implements TqclInterpreterComponent {
 
+	/* (non-Javadoc)
+	 * @see org.eclipse.triquetrum.commands.interpreter.TqclInterpreterComponent#interpret(org.eclipse.emf.ecore.EObject, org.eclipse.triquetrum.commands.interpreter.InterpretContext)
+	 */
+	@SuppressWarnings({ "rawtypes", "unchecked" })
 	@Override
 	public void interpret(EObject element, InterpretContext context) {
 		if (element instanceof CompositeCommand) {
@@ -29,6 +37,9 @@ public void interpret(EObject element, InterpretContext context) {
 
 	}
 
+	/* (non-Javadoc)
+	 * @see org.eclipse.triquetrum.commands.interpreter.TqclInterpreterComponent#intepretedEClasses()
+	 */
 	@Override
 	public List<EClass> intepretedEClasses() {
 		return Arrays.asList(TqclPackage.Literals.COMPOSITE_COMMAND);

diff --git a/...rc/main/java/org/eclipse/triquetrum/commands/interpreter/ConnectInterpreterComponent.java b/...rc/main/java/org/eclipse/triquetrum/commands/interpreter/ConnectInterpreterComponent.java
@@ -6,12 +6,20 @@
 import org.eclipse.emf.common.util.EList;
 import org.eclipse.emf.ecore.EClass;
 import org.eclipse.emf.ecore.EObject;
+import org.eclipse.triquetrum.commands.tqcl.CompositeCommand;
 import org.eclipse.triquetrum.commands.tqcl.Connect;
 import org.eclipse.triquetrum.commands.tqcl.ConnectionPort;
 import org.eclipse.triquetrum.commands.tqcl.TqclPackage;
 
+/**
+ * Interpreter component for {@link Connect}
+ * @author rtotaro
+ */
 public class ConnectInterpreterComponent implements TqclInterpreterComponent {
 
+	/* (non-Javadoc)
+	 * @see org.eclipse.triquetrum.commands.interpreter.TqclInterpreterComponent#interpret(org.eclipse.emf.ecore.EObject, org.eclipse.triquetrum.commands.interpreter.InterpretContext)
+	 */
 	@Override
 	public void interpret(EObject element, InterpretContext context) {
 		if (element instanceof Connect) {
@@ -28,10 +36,17 @@ public void interpret(EObject element, InterpretContext context) {
 
 	}
 
+	/**
+	 * @param port
+	 * @return
+	 */
 	private String createPortPath(ConnectionPort port) {
 		return port.getActor().getName()+"."+port.getPort();
 	}
 
+	/* (non-Javadoc)
+	 * @see org.eclipse.triquetrum.commands.interpreter.TqclInterpreterComponent#intepretedEClasses()
+	 */
 	@Override
 	public List<EClass> intepretedEClasses() {
 		return Arrays.asList(TqclPackage.Literals.CONNECT);

diff --git a/...ext/src/main/java/org/eclipse/triquetrum/commands/interpreter/GoInterpreterComponent.java b/...ext/src/main/java/org/eclipse/triquetrum/commands/interpreter/GoInterpreterComponent.java
@@ -5,12 +5,20 @@
 
 import org.eclipse.emf.ecore.EClass;
 import org.eclipse.emf.ecore.EObject;
+import org.eclipse.triquetrum.commands.tqcl.CompositeCommand;
 import org.eclipse.triquetrum.commands.tqcl.Go;
 import org.eclipse.triquetrum.commands.tqcl.Insert;
 import org.eclipse.triquetrum.commands.tqcl.TqclPackage;
 
+/**
+ * Interpreter component for {@link Go}
+ * @author rtotaro
+ */
 public class GoInterpreterComponent implements TqclInterpreterComponent {
 
+	/* (non-Javadoc)
+	 * @see org.eclipse.triquetrum.commands.interpreter.TqclInterpreterComponent#interpret(org.eclipse.emf.ecore.EObject, org.eclipse.triquetrum.commands.interpreter.InterpretContext)
+	 */
 	@SuppressWarnings({ "unchecked", "rawtypes" })
 	@Override
 	public void interpret(EObject element, InterpretContext context) {
@@ -34,6 +42,9 @@ public void interpret(EObject element, InterpretContext context) {
 		}
 	}
 
+	/* (non-Javadoc)
+	 * @see org.eclipse.triquetrum.commands.interpreter.TqclInterpreterComponent#intepretedEClasses()
+	 */
 	@Override
 	public List<EClass> intepretedEClasses() {
 		return Arrays.asList(TqclPackage.Literals.GO);

diff --git a/...src/main/java/org/eclipse/triquetrum/commands/interpreter/InsertInterpreterComponent.java b/...src/main/java/org/eclipse/triquetrum/commands/interpreter/InsertInterpreterComponent.java
@@ -9,13 +9,21 @@
 import org.eclipse.emf.ecore.EObject;
 import org.eclipse.triquetrum.commands.api.services.TcQLException;
 import org.eclipse.triquetrum.commands.tqcl.Category;
+import org.eclipse.triquetrum.commands.tqcl.CompositeCommand;
 import org.eclipse.triquetrum.commands.tqcl.Insert;
 import org.eclipse.triquetrum.commands.tqcl.Parameter;
 import org.eclipse.triquetrum.commands.tqcl.TqclPackage;
 import org.eclipse.triquetrum.commands.validation.TqCLUtils;
 
+/**
+ * Interpreter component for {@link Insert}
+ * @author rtotaro
+ */
 public class InsertInterpreterComponent implements TqclInterpreterComponent {
 
+	/* (non-Javadoc)
+	 * @see org.eclipse.triquetrum.commands.interpreter.TqclInterpreterComponent#interpret(org.eclipse.emf.ecore.EObject, org.eclipse.triquetrum.commands.interpreter.InterpretContext)
+	 */
 	@SuppressWarnings({ "unchecked", "rawtypes" })
 	@Override
 	public void interpret(EObject element, InterpretContext context) {
@@ -51,6 +59,9 @@ private Map<String, String> extractParameterMap(Insert insert) {
 		return params;
 	}
 
+	/* (non-Javadoc)
+	 * @see org.eclipse.triquetrum.commands.interpreter.TqclInterpreterComponent#intepretedEClasses()
+	 */
 	@Override
 	public List<EClass> intepretedEClasses() {
 		return Arrays.asList(TqclPackage.Literals.INSERT);

diff --git a/...nds.xtext/src/main/java/org/eclipse/triquetrum/commands/interpreter/InterpretContext.java b/...nds.xtext/src/main/java/org/eclipse/triquetrum/commands/interpreter/InterpretContext.java
@@ -2,6 +2,15 @@
 
 import org.eclipse.triquetrum.commands.api.services.ModelBuilderService;
 
+
+/**
+ * Object that contains the result of interpretation
+ * 
+ * @author rtotaro
+ *
+ * @param <CompositeActor> class used to represent the composite actor
+ * @param <Actor> class used to represent the simple actor
+ */
 public class InterpretContext<CompositeActor,Actor> {
 
 	private ModelBuilderService<CompositeActor,Actor> modelBuilderService;
@@ -12,6 +21,11 @@ public class InterpretContext<CompositeActor,Actor> {
 
 	private Actor currentActor;
 
+	/**
+	 * @param interpreter is used by interpreter component 
+	 * @param model root of the model to interpret
+	 * @param modelBuilderService is used to build the model 
+	 */
 	public InterpretContext(TqclInterpreter<CompositeActor,Actor> interpreter,CompositeActor model,ModelBuilderService<CompositeActor,Actor> modelBuilderService) {
 		super();
 		this.interpreter = interpreter;
@@ -35,6 +49,11 @@ public Actor getCurrentActor() {
 		return currentActor;
 	}
 
+	/**
+	 * Is used to set the current level in the actor hierarchy
+	 * Could be also a simple actor for adding ports or parameters
+	 * @param currentActor
+	 */
 	public void setCurrentActor(Actor currentActor) {
 		this.currentActor = currentActor;
 	}

diff --git a/...ands.xtext/src/main/java/org/eclipse/triquetrum/commands/interpreter/TqclInterpreter.java b/...ands.xtext/src/main/java/org/eclipse/triquetrum/commands/interpreter/TqclInterpreter.java
@@ -29,6 +29,13 @@
 
 import ptolemy.util.StringUtilities;
 
+/**
+ * The TqCL interpreter, the type of the result is related to the {@link ModelBuilderService} set in the {@link InterpretContext}
+ * @author rtotaro
+ *
+ * @param <CompositeActor> class used to represent the composite actor
+ * @param <Actor> class used to represent the simple acto
+ */
 public class TqclInterpreter<CompositeActor,Actor> {
 
 	private static Map<EClass, TqclInterpreterComponent> components = new HashMap<>(); 
@@ -51,6 +58,15 @@ private static void addComponent(TqclInterpreterComponent component){
 		}
 	}
 
+	/**
+	 * Interpreter the TqCL script
+	 * 
+	 * @param modelName the name of the result model
+	 * @param script to interpret
+	 * @param uri parent directory of the script
+	 * @param modelClass result class, is used to select the right {@link ModelBuilderService}
+	 * @return
+	 */
 	public CompositeActor interpret(String modelName,InputStream script, java.net.URI uri,Class<?> modelClass) {
 		try {
 			Injector injector = new TqclStandaloneSetup().createInjectorAndDoEMFRegistration();

diff --git a/...t/src/main/java/org/eclipse/triquetrum/commands/interpreter/TqclInterpreterComponent.java b/...t/src/main/java/org/eclipse/triquetrum/commands/interpreter/TqclInterpreterComponent.java
@@ -5,9 +5,30 @@
 import org.eclipse.emf.ecore.EClass;
 import org.eclipse.emf.ecore.EObject;
 
+/**
+ * Interface implements by interpreter components. Each component interpret one
+ * or more syntax structure
+ * 
+ * @author rtotaro
+ *
+ */
 public interface TqclInterpreterComponent {
 
+	/**
+	 * Interpret the element adding result to the context
+	 * 
+	 * @param element
+	 * @param context
+	 */
+	@SuppressWarnings("rawtypes")
 	void interpret(EObject element, InterpretContext context);
-
+
+	/**
+	 * Interpreted EClasses, this information is used to choose which component
+	 * call during interpretation. An EClass can be interpreted by only one
+	 * component
+	 * 
+	 * @return the list of interpreted classes
+	 */
 	List<EClass> intepretedEClasses();
 }
diff --git a/...ava/org/eclipse/triquetrum/commands/interpreter/TriquetrumScriptInterpreterComponent.java b/...ava/org/eclipse/triquetrum/commands/interpreter/TriquetrumScriptInterpreterComponent.java
@@ -10,8 +10,14 @@
 import org.eclipse.triquetrum.commands.tqcl.TqclPackage;
 import org.eclipse.triquetrum.commands.tqcl.TriquetrumScript;
 
+/**
+ * Interpreter component for {@link TriquetrumScript}
+ * @author rtotaro
+ *
+ */
 public class TriquetrumScriptInterpreterComponent implements TqclInterpreterComponent {
 
+	@SuppressWarnings({ "rawtypes", "unchecked" })
 	@Override
 	public void interpret(EObject element, InterpretContext context) {
 		if (element instanceof TriquetrumScript) {

diff --git a/...mmands.xtext/src/main/java/org/eclipse/triquetrum/commands/scoping/TqclScopeProvider.java b/...mmands.xtext/src/main/java/org/eclipse/triquetrum/commands/scoping/TqclScopeProvider.java
@@ -13,9 +13,6 @@
  */
 package org.eclipse.triquetrum.commands.scoping;
 
-import java.util.ArrayList;
-import java.util.function.Consumer;
-
 import org.eclipse.emf.ecore.EObject;
 import org.eclipse.emf.ecore.EReference;
 import org.eclipse.triquetrum.commands.tqcl.Category;
@@ -53,6 +50,9 @@ public boolean apply(IEObjectDescription objectDescription) {
 		}
 	};
 
+	/* (non-Javadoc)
+	 * @see org.eclipse.xtext.scoping.impl.DelegatingScopeProvider#getScope(org.eclipse.emf.ecore.EObject, org.eclipse.emf.ecore.EReference)
+	 */
 	@Override
 	public IScope getScope(EObject context, EReference reference) {
 		if (context instanceof Go && reference == TqclPackage.Literals.GO__ACTOR) {

diff --git a/...um.commands.xtext/src/main/java/org/eclipse/triquetrum/commands/validation/TqCLUtils.java b/...um.commands.xtext/src/main/java/org/eclipse/triquetrum/commands/validation/TqCLUtils.java
@@ -19,6 +19,11 @@
 import com.google.common.base.Predicate;
 import com.google.common.collect.Collections2;
 
+/**
+ * Utils class to clean qualified name used in tqcl and create valid name for ptolemy models
+ * @author rtotaro
+ *
+ */
 public class TqCLUtils {
 
 	public static String cleanEntityName(String entityClass) {