Adds save dirty checking event (#647)

* Appends "Edited" to the stage title on edit

Author: AustinShalit

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;
 
   /**

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

@@ -13,7 +13,7 @@
  *
  * @see Source
  */
-public class SourceAddedEvent {
+public class SourceAddedEvent implements DirtiesSaveEvent {
   private final Source source;
 
   /**

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

@@ -13,7 +13,7 @@
  *
  * @see Source
  */
-public class SourceRemovedEvent {
+public class SourceRemovedEvent implements DirtiesSaveEvent {
   private final Source source;
 
   /**

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

@@ -15,7 +15,7 @@
  * An event that occurs when a new step is added to the pipeline.  This is triggered by the user
  * adding a step with the GUI.
  */
-public class StepAddedEvent {
+public class StepAddedEvent implements DirtiesSaveEvent {
   private final Step step;
   private final OptionalInt index;
 

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

@@ -9,7 +9,7 @@
 /**
  * An event that occurs when a new step is moved from one position to another in the pipeline.
  */
-public class StepMovedEvent {
+public class StepMovedEvent implements DirtiesSaveEvent {
   private final Step step;
   private final int distance;
 

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

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