From 628da4e670ad27bb2b2fc5e4ff1cbd737e93c1c3 Mon Sep 17 00:00:00 2001
From: Nikolay Krasko <nikolay.krasko@jetbrains.com>
Date: Mon, 27 Aug 2012 15:56:31 +0400
Subject: [PATCH] - Don't restart action if previous task was finished for same
 location - Do some user-defined action if location became invalid

---
 .../jet/plugin/util/LongRunningReadTask.java  | 49 +++++++++++++++----
 1 file changed, 39 insertions(+), 10 deletions(-)

diff --git a/idea/src/org/jetbrains/jet/plugin/util/LongRunningReadTask.java b/idea/src/org/jetbrains/jet/plugin/util/LongRunningReadTask.java
index 51cfe1c7454..39fe4617090 100644
--- a/idea/src/org/jetbrains/jet/plugin/util/LongRunningReadTask.java
+++ b/idea/src/org/jetbrains/jet/plugin/util/LongRunningReadTask.java
@@ -34,7 +34,8 @@ public abstract class LongRunningReadTask<RequestInfo, ResultData> {
         NOT_INITIALIZED,
         INITIALIZED,
         STARTED,
-        FINISHED
+        FINISHED,
+        FINISHED_AND_PROCESSED
     }
 
     private ProgressIndicator progressIndicator = null;
@@ -51,19 +52,31 @@ public abstract class LongRunningReadTask<RequestInfo, ResultData> {
             throw new IllegalStateException("Task should be initialized state. Call init() method.");
         }
 
+        // Cancel previous task if necessary
+        if (previousTask != null && previousTask.currentState == State.STARTED) {
+            if (requestInfo == null || !requestInfo.equals(previousTask.requestInfo)) {
+                previousTask.progressIndicator.cancel();
+            }
+        }
+
         if (requestInfo == null) {
+            if (previousTask != null && (previousTask.currentState == State.FINISHED_AND_PROCESSED || previousTask.currentState == State.FINISHED)) {
+                previousTask.hideResultOnInvalidLocation();
+            }
+
             return false;
         }
 
-        if (previousTask != null && previousTask.currentState == State.STARTED) {
-            if (!requestInfo.equals(previousTask.requestInfo)) {
-                // Previous task counting data for outdated request - cancel it.
-                previousTask.progressIndicator.cancel();
-                return true;
+
+        if (previousTask != null) {
+            if (previousTask.currentState == State.STARTED) {
+                // Start new task only if previous isn't working on similar request
+                return !requestInfo.equals(previousTask.requestInfo);
             }
-            else {
-                // If previous task is in progress and counting result for similar result don't start new task
-                return false;
+            else if (previousTask.currentState == State.FINISHED_AND_PROCESSED) {
+                if (requestInfo.equals(previousTask.requestInfo)) {
+                    return false;
+                }
             }
         }
 
@@ -78,6 +91,10 @@ public abstract class LongRunningReadTask<RequestInfo, ResultData> {
             throw new IllegalStateException("Task should be initialized with init() method");
         }
 
+        if (requestInfo == null) {
+            throw new IllegalStateException("Invalid request for task beginning");
+        }
+
         currentState = State.STARTED;
 
         beforeRun();
@@ -123,7 +140,14 @@ public abstract class LongRunningReadTask<RequestInfo, ResultData> {
         ApplicationManager.getApplication().assertIsDispatchThread();
 
         currentState = State.FINISHED;
-        onResultReady(requestInfo, resultData);
+
+        if (resultData != null) {
+            RequestInfo actualInfo = prepareRequestInfo();
+            if (requestInfo.equals(actualInfo)) {
+                currentState = State.FINISHED_AND_PROCESSED;
+                onResultReady(actualInfo, resultData);
+            }
+        }
     }
 
     /**
@@ -152,6 +176,11 @@ public abstract class LongRunningReadTask<RequestInfo, ResultData> {
     @Nullable
     protected abstract RequestInfo prepareRequestInfo();
 
+    /**
+     * Executed in GUI Thread.
+     */
+    protected void hideResultOnInvalidLocation() {}
+
     /**
      * Executed in GUI Thread right before task run. Do nothing by default.
      */