Merge remote-tracking branch 'upstream/master' into ntSource

Author: AustinShalit

.pullapprove.yml

@@ -0,0 +1,10 @@
+approve_by_comment: true
+approve_regex: ^(Approved|LGTM)
+reject_regex: ^Rejected
+reset_on_push: true
+reviewers:
+  -
+    name: "GRIP Merge Approvers"
+    required: 1
+    teams:
+      - grip-merge-approvers

.travis.yml

@@ -30,7 +30,7 @@ install:
   - '[ "${TRAVIS_PULL_REQUEST}" = "false" ] && ./gradlew :ui:jfxNative --stacktrace || ./gradlew --stacktrace '
 
 script:
-  - ./gradlew checkstyleMain checkstyleTest pmdMain jacocoTestReport jacocoRootReport test --stacktrace -Pheadless=true -PlogTests
+  - ./gradlew checkstyleMain checkstyleTest pmdMain pmdTest jacocoTestReport jacocoRootReport test --stacktrace -Pheadless=true -PlogTests
 
 after_success:
   - if [[ "$TRAVIS_OS_NAME" != "osx" ]]; then codecov         ; fi

CONTRIBUTING.md

@@ -69,4 +69,4 @@ Include details about your configuration and environment:</br>
 
 ### Code Formatting
 
-* GRIP uses standard Java formatting rules, although we don't care if your line length is over 80 characters. You can probably use your IDE's built-in formatter. This helps keep the code more consistent and readable.
+* GRIP follows the [Google Java Styleguide](https://google.github.io/styleguide/javaguide.html) with a few modifications regarding import order. We use the gradle [checkstyle](http://checkstyle.sourceforge.net/) plugin to ensure that code conforms to this styleguide. There are plugins for most major IDE's that support importing the `checkstyle.xml` file.

appveyor.yml

@@ -6,7 +6,7 @@ build_script:
 
 # to run your custom scripts instead of automatic tests
 test_script:
-  - gradlew.bat checkstyleMain checkstyleTest pmdMain jacocoTestReport jacocoRootReport test --stacktrace -Pheadless=true -PlogTests
+  - gradlew.bat checkstyleMain checkstyleTest pmdMain pmdTest jacocoTestReport jacocoRootReport test --stacktrace -Pheadless=true -PlogTests
 
 platform:
   - x64

build.gradle

@@ -7,7 +7,7 @@ buildscript {
     }
 
     dependencies {
-        classpath group: 'de.dynamicfiles.projects.gradle.plugins', name: 'javafx-gradle-plugin', version: '8.5.1'
+        classpath group: 'de.dynamicfiles.projects.gradle.plugins', name: 'javafx-gradle-plugin', version: '8.5.2'
         classpath 'com.netflix.nebula:gradle-aggregate-javadocs-plugin:2.2.+'
         classpath 'net.ltgt.gradle:gradle-errorprone-plugin:0.0.8'
     }
@@ -85,7 +85,7 @@ def getVersionSimple = { ->
     }
 }
 
-allprojects {
+configure(allprojects - project(':ui:linuxLauncher')) {
     apply plugin: 'java'
     apply plugin: 'application'
     apply plugin: 'jacoco'
@@ -301,6 +301,30 @@ project(":core") {
     }
 }
 
+project (":ui:linuxLauncher") {
+    apply plugin: 'cpp'
+
+    model {
+        binaries {
+            all {
+                cppCompiler.args '-pthread', '-ldl'
+                linker.args '-pthread', '-ldl'
+            }
+        }
+        components {
+            linuxLauncher(NativeExecutableSpec) {
+                sources {
+                    cpp {
+                        source {
+                            srcDir "src/cpp"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}
+
 project (":ui:preloader") {
     apply plugin: 'java'
     apply plugin: 'idea'
@@ -339,7 +363,10 @@ project(":ui") {
     }
 
     evaluationDependsOn(':core')
-    evaluationDependsOnChildren()
+    evaluationDependsOn(':ui:preloader')
+    if (System.getProperty("os.name").toLowerCase().contains("linux")) {
+        jfxNative.dependsOn tasks.getByPath(':ui:linuxLauncher:linuxLauncherExecutable')
+    }
     compileTestJava.dependsOn tasks.getByPath(':core:testClasses')
 
     idea.module {
@@ -375,10 +402,9 @@ project(":ui") {
         // See: https://plumbr.eu/blog/java/on-a-quest-for-missing-stacktraces
         jvmArgs = ["-XX:-OmitStackTraceInFastThrow"]
 
-        // This was a workaround introduced by the plugin dev.  For some reason the build fails
-        // when the workaround is enabled in Java 1.8.0_101.  If you are building with a version
-        // less than _101 you may need to set this to false.
-        skipNativeLauncherWorkaround124 = true
+        bundleArguments = [
+                "linux.launcher.url": file('linuxLauncher/build/exe/linuxLauncher/linuxLauncher').toURI().toURL()
+        ]
     }
     mainClassName = jfx.mainClass
 }
@@ -389,20 +415,22 @@ project(":ui") {
  */
 task jacocoRootReport(type: JacocoReport, group: 'Coverage reports') {
     description = 'Generates an aggregate report from all subprojects'
-    dependsOn(subprojects.test)
+    configure(subprojects - project(':ui:linuxLauncher')) {
+        dependsOn(test)
 
-    additionalSourceDirs = files(subprojects.sourceSets.main.allSource.srcDirs)
-    sourceDirectories = files(subprojects.sourceSets.main.allSource.srcDirs)
-    classDirectories = files(subprojects.sourceSets.main.output)
-    executionData = files(subprojects.jacocoTestReport.executionData)
+        additionalSourceDirs = files(sourceSets.main.allSource.srcDirs)
+        sourceDirectories = files(sourceSets.main.allSource.srcDirs)
+        classDirectories = files(sourceSets.main.output)
+        executionData = files(jacocoTestReport.executionData)
 
-    reports {
-        html.enabled = true
-        xml.enabled = true
-    }
+        reports {
+            html.enabled = true
+            xml.enabled = true
+        }
 
-    doFirst {
-        executionData = files(executionData.findAll { it.exists() })
+        doFirst {
+            executionData = files(executionData.findAll { it.exists() })
+        }
     }
 }
 

core/src/main/java/edu/wpi/grip/core/events/ConnectionAddedEvent.java

@@ -10,7 +10,7 @@
  * An event that occurs when a new connection is added to the pipeline.  This is triggered by the
  * user adding a connection with the GUI.
  */
-public class ConnectionAddedEvent implements RunPipelineEvent {
+public class ConnectionAddedEvent implements RunPipelineEvent, DirtiesSaveEvent {
   private final Connection connection;
 
   /**

core/src/main/java/edu/wpi/grip/core/events/ConnectionRemovedEvent.java

@@ -10,7 +10,7 @@
  * An event that occurs when a connection is removed from the pipeline.  This is triggered by the
  * user deleting a connection with the GUI.
  */
-public class ConnectionRemovedEvent {
+public class ConnectionRemovedEvent implements DirtiesSaveEvent {
   private final Connection connection;
 
   /**

core/src/main/java/edu/wpi/grip/core/events/DirtiesSaveEvent.java

@@ -0,0 +1,19 @@
+package edu.wpi.grip.core.events;
+
+/**
+ * An event that can potentially dirty the save file.
+ *
+ * <p>These events ensure that anything that changes causes the save file to be flagged as dirty and
+ * in need of being saved for the project to be deemed "clean" again.
+ */
+public interface DirtiesSaveEvent {
+
+  /**
+   * Some events may have more logic regarding whether they make the save dirty or not.
+   *
+   * @return True if this event should dirty the project save
+   */
+  default boolean doesDirtySave() {
+    return true;
+  }
+}

core/src/main/java/edu/wpi/grip/core/events/SocketChangedEvent.java

@@ -10,7 +10,7 @@
  * An event that occurs when the value stored in a socket changes.  This can happen, for example, as
  * the result of an operation completing, or as a response to user input.
  */
-public class SocketChangedEvent implements RunPipelineEvent {
+public class SocketChangedEvent implements RunPipelineEvent, DirtiesSaveEvent {
   private final Socket socket;
 
   /**
@@ -31,19 +31,26 @@ public boolean isRegarding(Socket socket) {
     return socket.equals(this.socket);
   }
 
+  /**
+   * This event will only dirty the save if the InputSocket does not have connections.
+   * Thus the value can only have been changed by a UI component.
+   * If the socket has connections then the value change is triggered by another socket's change.
+   *
+   * @return True if this should dirty the save.
+   */
+  @Override
+  public boolean doesDirtySave() {
+    return pipelineShouldRun();
+  }
+
   @Override
   public boolean pipelineShouldRun() {
     /*
      * The pipeline should only flag an update when it is an input changing. A changed output
-      * doesn't mean
-     * the pipeline is dirty.
-     * If the socket is connected to another socket then then the input will only change
-     * because of the
-     * pipeline thread.
-     * In that case we don't want the pipeline to be releasing itself.
-     * If the connections are empty then the change must have come from the UI so we need to
-     * run the pipeline
-     * with the new values.
+     * doesn't mean the pipeline is dirty. If the socket is connected to another socket then then
+     * the input will only change because of the pipeline thread. In that case we don't want the
+     * pipeline to be releasing itself. If the connections are empty then the change must have come
+     * from the UI so we need to run the pipeline with the new values.
      */
     return socket.getDirection().equals(Socket.Direction.INPUT) && socket.getConnections()
         .isEmpty();

core/src/main/java/edu/wpi/grip/core/events/SocketPreviewChangedEvent.java

@@ -10,7 +10,7 @@
  * An event that occurs when a {@link OutputSocket} is set to be either previewed or not previewed.
  * The GUI listens for these events so it knows which sockets to show previews for.
  */
-public class SocketPreviewChangedEvent {
+public class SocketPreviewChangedEvent implements DirtiesSaveEvent {
   private final OutputSocket socket;
 
   /**