Merge pull request #547 from JLLeitschuh/feat/dynamicTypedOperations

Adds Dynamic Typed Operations Valve & Switch

Author: JLLeitschuh

buildSrc/src/main/java/edu/wpi/gripgenerator/templates/Operation.java

@@ -25,8 +25,7 @@
 
 public class Operation {
     private static final ImportDeclaration OPERATION_IMPORT = new ImportDeclaration(new NameExpr("edu.wpi.grip.core.operations.opencv.CVOperation"), false, false);
-    private static final ImportDeclaration INPUT_SOCKET_IMPORT = new ImportDeclaration(new NameExpr("edu.wpi.grip.core.InputSocket"), false, false);
-    private static final ImportDeclaration OUTPUT_SOCKET_IMPORT = new ImportDeclaration(new NameExpr("edu.wpi.grip.core.OutputSocket"), false, false);
+    private static final ImportDeclaration SOCKETS_IMPORT = new ImportDeclaration(new NameExpr("edu.wpi.grip.core.sockets"), false, true);
     private static final ImportDeclaration EVENT_BUS_IMPORT = new ImportDeclaration(new NameExpr("com.google.common.eventbus.EventBus"), false, false);
     private static final ImportDeclaration CV_CORE_IMPORT = new ImportDeclaration(new NameExpr("org.bytedeco.javacpp.opencv_core"), true, true);
     private static final ClassOrInterfaceType iOperation = new ClassOrInterfaceType("CVOperation");
@@ -309,11 +308,9 @@ private ClassOrInterfaceDeclaration getClassDeclaration() {
      */
     public CompilationUnit getDeclaration() {
         Set<ImportDeclaration> importList = Sets.newHashSet(
-                SocketHintDeclaration.SOCKET_IMPORT,
                 OPERATION_IMPORT,
                 CV_CORE_IMPORT,
-                INPUT_SOCKET_IMPORT,
-                OUTPUT_SOCKET_IMPORT,
+                SOCKETS_IMPORT,
                 EVENT_BUS_IMPORT
         );
         importList.addAll(getAdditionalImports());

buildSrc/src/main/java/edu/wpi/gripgenerator/templates/SocketHintDeclaration.java

@@ -1,7 +1,6 @@
 package edu.wpi.gripgenerator.templates;
 
 import com.github.javaparser.ASTHelper;
-import com.github.javaparser.ast.ImportDeclaration;
 import com.github.javaparser.ast.body.*;
 import com.github.javaparser.ast.expr.*;
 import com.github.javaparser.ast.type.ClassOrInterfaceType;
@@ -32,8 +31,6 @@
 public class SocketHintDeclaration {
     public static final String SOCKET_HINT_CLASS_NAME = "SocketHint";
     public static final String SOCKET_HINT_BUILDER_CLASS_NAME = "Builder";
-    public static final ImportDeclaration SOCKET_IMPORT = new ImportDeclaration(
-            new NameExpr("edu.wpi.grip.core." + SOCKET_HINT_CLASS_NAME), false, false);
     public static final String HINT_POSTFIX = "Hint";
     public static final String INPUT_POSTFIX = "Input";
     public static final String OUTPUT_POSTFIX = "Output";

core/src/main/java/edu/wpi/grip/core/Connection.java

@@ -6,6 +6,8 @@
 import com.google.inject.assistedinject.Assisted;
 import com.thoughtworks.xstream.annotations.XStreamAlias;
 import edu.wpi.grip.core.events.*;
+import edu.wpi.grip.core.sockets.InputSocket;
+import edu.wpi.grip.core.sockets.OutputSocket;
 
 import static com.google.common.base.Preconditions.checkArgument;
 
@@ -20,21 +22,21 @@ public class Connection<T> {
     private final InputSocket<T> inputSocket;
 
 
-    public interface Factory <T> {
+    public interface Factory<T> {
         Connection<T> create(OutputSocket<? extends T> outputSocket, InputSocket<T> inputSocket);
     }
 
     /**
-     * @param pipeline     The pipeline to create the connection inside of.
-     * @param outputSocket The socket to listen for changes in.
-     * @param inputSocket  A different socket to update when a change occurs in the first.
+     * @param connectionValidator An object to validate that the connection can be made
+     * @param outputSocket        The socket to listen for changes in.
+     * @param inputSocket         A different socket to update when a change occurs in the first.
      */
     @Inject
-    Connection(EventBus eventBus, Pipeline pipeline, @Assisted OutputSocket<? extends T> outputSocket, @Assisted InputSocket<T> inputSocket) {
+    Connection(EventBus eventBus, ConnectionValidator connectionValidator, @Assisted OutputSocket<? extends T> outputSocket, @Assisted InputSocket<T> inputSocket) {
         this.eventBus = eventBus;
         this.outputSocket = outputSocket;
         this.inputSocket = inputSocket;
-        checkArgument(pipeline.canConnect(outputSocket, inputSocket), "Cannot connect sockets");
+        checkArgument(connectionValidator.canConnect(outputSocket, inputSocket), "Cannot connect sockets");
     }
 
     public OutputSocket<? extends T> getOutputSocket() {

core/src/main/java/edu/wpi/grip/core/ConnectionValidator.java

@@ -0,0 +1,48 @@
+package edu.wpi.grip.core;
+
+import edu.wpi.grip.core.sockets.InputSocket;
+import edu.wpi.grip.core.sockets.OutputSocket;
+import edu.wpi.grip.core.sockets.Socket;
+
+/**
+ * Allows {@link Connection Connections} to be validated to ensure that the pipeline will remain valid.
+ */
+public interface ConnectionValidator {
+
+    /**
+     * Resolves which {@link Socket} is the {@link OutputSocket} and which is the {@link InputSocket}
+     * and calls {@link #canConnect(OutputSocket, InputSocket)}
+     * @param socket1 The first socket
+     * @param socket2 The second socket
+     * @return The return value of {@link #canConnect(OutputSocket, InputSocket)}
+     */
+    default boolean canConnect(Socket socket1, Socket socket2) {
+        final OutputSocket<?> outputSocket;
+        final InputSocket<?> inputSocket;
+
+        // One socket must be an input and one must be an output
+        if (socket1.getDirection() == socket2.getDirection()) {
+            return false;
+        }
+
+        if (socket1.getDirection().equals(Socket.Direction.OUTPUT)) {
+            outputSocket = (OutputSocket) socket1;
+            inputSocket = (InputSocket) socket2;
+        } else {
+            inputSocket = (InputSocket) socket1;
+            outputSocket = (OutputSocket) socket2;
+        }
+
+        // DO NOT DO ANY OTHER SORT OF VALIDATION HERE. We just want to resolve the types.
+
+        return canConnect(outputSocket, inputSocket);
+    }
+
+    /**
+     * Determines if an output socket can be connected to an input socket
+     * @param outputSocket The output socket to connect to the input socket
+     * @param inputSocket The input socket to accept the output value of the output socket
+     * @return True if a valid connection can be made from these two Sockets
+     */
+    boolean canConnect(OutputSocket<?> outputSocket, InputSocket<?> inputSocket);
+}

core/src/main/java/edu/wpi/grip/core/GRIPCoreModule.java

@@ -103,7 +103,7 @@ public <I> void hear(TypeLiteral<I> type, TypeEncounter<I> encounter) {
         install(new FactoryModuleBuilder().build(new TypeLiteral<Connection.Factory<Object>>() {
         }));
 
-
+        bind(ConnectionValidator.class).to(Pipeline.class);
         bind(Source.SourceFactory.class).to(Source.SourceFactoryImpl.class);
         bind(CameraSource.FrameGrabberFactory.class).to(CameraSource.FrameGrabberFactoryImpl.class);
         install(new FactoryModuleBuilder()

core/src/main/java/edu/wpi/grip/core/Operation.java

@@ -2,6 +2,9 @@
 
 import com.google.common.collect.ImmutableSet;
 import com.google.common.eventbus.EventBus;
+import edu.wpi.grip.core.sockets.InputSocket;
+import edu.wpi.grip.core.sockets.OutputSocket;
+import edu.wpi.grip.core.sockets.SocketsProvider;
 
 import java.io.InputStream;
 import java.util.Optional;
@@ -16,6 +19,7 @@ enum Category {
         IMAGE_PROCESSING,
         FEATURE_DETECTION,
         NETWORK,
+        LOGICAL,
         OPENCV,
         MISCELLANEOUS,
     }
@@ -53,6 +57,9 @@ default Optional<InputStream> getIcon() {
         return Optional.empty();
     }
 
+    default SocketsProvider createSockets(EventBus eventBus) {
+        return new SocketsProvider(createInputSockets(eventBus), createOutputSockets(eventBus));
+    }
     /**
      * @param eventBus The Guava {@link EventBus} used by the application.
      * @return An array of sockets for the inputs that the operation expects.

core/src/main/java/edu/wpi/grip/core/Pipeline.java

@@ -8,6 +8,9 @@
 import com.thoughtworks.xstream.annotations.XStreamOmitField;
 import edu.wpi.grip.core.events.*;
 import edu.wpi.grip.core.settings.ProjectSettings;
+import edu.wpi.grip.core.sockets.InputSocket;
+import edu.wpi.grip.core.sockets.OutputSocket;
+import edu.wpi.grip.core.sockets.SocketHint;
 
 import javax.inject.Inject;
 import java.util.*;
@@ -30,7 +33,7 @@
  */
 @Singleton
 @XStreamAlias(value = "grip:Pipeline")
-public class Pipeline {
+public class Pipeline implements ConnectionValidator {
 
     @Inject
     @XStreamOmitField
@@ -176,28 +179,13 @@ public ProjectSettings getProjectSettings() {
      * @return true if a connection can be made from the given output socket to the given input socket
      */
     @SuppressWarnings("unchecked")
-    public boolean canConnect(Socket socket1, Socket socket2) {
-        final OutputSocket<?> outputSocket;
-        final InputSocket<?> inputSocket;
-
-        // One socket must be an input and one must be an output
-        if (socket1.getDirection() == socket2.getDirection()) {
-            return false;
-        }
-
-        if (socket1.getDirection().equals(Socket.Direction.OUTPUT)) {
-            outputSocket = (OutputSocket) socket1;
-            inputSocket = (InputSocket) socket2;
-        } else {
-            inputSocket = (InputSocket) socket1;
-            outputSocket = (OutputSocket) socket2;
-        }
-
-        final SocketHint outputHint = socket1.getSocketHint();
-        final SocketHint inputHint = socket2.getSocketHint();
+    @Override
+    public boolean canConnect(OutputSocket<?> outputSocket, InputSocket<?> inputSocket) {
+        final SocketHint outputHint = outputSocket.getSocketHint();
+        final SocketHint inputHint = inputSocket.getSocketHint();
 
         // The input socket must be able to hold the type of value that the output socket contains
-        if (!inputHint.getType().isAssignableFrom(outputHint.getType())) {
+        if (!inputHint.isCompatibleWith(outputHint)) {
             return false;
         }
 

core/src/main/java/edu/wpi/grip/core/SocketHint.java

@@ -1,6 +1,7 @@
 package edu.wpi.grip.core;
 
 import com.google.inject.Inject;
+import edu.wpi.grip.core.sockets.OutputSocket;
 import edu.wpi.grip.core.sources.CameraSource;
 import edu.wpi.grip.core.sources.ImageFileSource;
 import edu.wpi.grip.core.sources.MultiImageFileSource;

core/src/main/java/edu/wpi/grip/core/Source.java

@@ -4,6 +4,10 @@
 import com.google.inject.Inject;
 import com.google.inject.Singleton;
 import com.thoughtworks.xstream.annotations.XStreamAlias;
+import edu.wpi.grip.core.sockets.InputSocket;
+import edu.wpi.grip.core.sockets.OutputSocket;
+import edu.wpi.grip.core.sockets.Socket;
+import edu.wpi.grip.core.sockets.SocketsProvider;
 import edu.wpi.grip.core.util.ExceptionWitness;
 
 import java.util.Optional;
@@ -44,8 +48,9 @@ public Factory(EventBus eventBus, ExceptionWitness.Factory exceptionWitnessFacto
         public Step create(Operation operation) {
             checkNotNull(operation, "The operation can not be null");
             // Create the list of input and output sockets, and mark this step as their owner.
-            final InputSocket<?>[] inputSockets = operation.createInputSockets(eventBus);
-            final OutputSocket<?>[] outputSockets = operation.createOutputSockets(eventBus);
+            final SocketsProvider socketsProvider = operation.createSockets(eventBus);
+            final InputSocket<?>[] inputSockets = socketsProvider.inputSockets();
+            final OutputSocket<?>[] outputSockets = socketsProvider.outputSockets();
 
             final Step step = new Step(
                     operation,