summaryrefslogtreecommitdiff
path: root/platform/platform-impl/src/com/intellij/openapi/progress/util/ProgressIndicatorUtils.java
blob: 0c18cb7706d9f5a76c888b69f012c02aa14f9e99 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/*
 * Copyright 2000-2014 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.intellij.openapi.progress.util;

import com.intellij.openapi.Disposable;
import com.intellij.openapi.application.Application;
import com.intellij.openapi.application.ApplicationAdapter;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.progress.ProcessCanceledException;
import com.intellij.openapi.progress.ProgressIndicator;
import com.intellij.openapi.progress.ProgressManager;
import org.jetbrains.annotations.NotNull;

/**
 * @author gregsh
 */
public class ProgressIndicatorUtils {
  private ProgressIndicatorUtils() {
  }

  @NotNull
  public static ProgressIndicator forceWriteActionPriority(@NotNull final ProgressIndicator progress, @NotNull final Disposable builder) {
    ApplicationManager.getApplication().addApplicationListener(new ApplicationAdapter() {
        @Override
        public void beforeWriteActionStart(Object action) {
          if (progress.isRunning()) {
            progress.cancel();
          }
        }
      }, builder);
    return progress;
  }

  public static void runWithWriteActionPriority(@NotNull final Runnable action) {
    runWithWriteActionPriority(new ReadTask() {
      @Override
      public void computeInReadAction(@NotNull ProgressIndicator indicator) {
        action.run();
      }

      @Override
      public void onCanceled(@NotNull ProgressIndicator indicator) {
      }
    });
  }

  public static void runWithWriteActionPriority(@NotNull final ReadTask task) {
    runWithWriteActionPriority(new ProgressIndicatorBase(), task);
  }

  private static void surroundWithListener(@NotNull final ProgressIndicator progressIndicator, @NotNull Runnable runnable) {
    final ApplicationAdapter listener = new ApplicationAdapter() {
      @Override
      public void beforeWriteActionStart(Object action) {
        progressIndicator.cancel();
      }
    };
    final Application application = ApplicationManager.getApplication();
    application.addApplicationListener(listener);
    try {
      runnable.run();
    }
    finally {
      application.removeApplicationListener(listener);
    }
  }


  public static void runWithWriteActionPriority(@NotNull final ProgressIndicator progressIndicator, @NotNull final ReadTask task) {
    surroundWithListener(progressIndicator, new Runnable() {
      @Override
      public void run() {
        runUnderProgress(progressIndicator, task);
      }
    });
  }

  private static void runUnderProgress(@NotNull final ProgressIndicator progressIndicator, @NotNull final ReadTask task) {
    ProgressManager.getInstance().runProcess(new Runnable() {
        @Override
        public void run() {
          // This read action can possible last for a long time, we want it to stop immediately on the first write access.
          // For this purpose we launch it under empty progress and invoke progressIndicator#cancel on write access to avoid possible write lock delays.
          try {
            ApplicationManager.getApplication().runReadAction(new Runnable() {
              @Override
              public void run() {
                task.computeInReadAction(progressIndicator);
              }
            });
          }
          catch (ProcessCanceledException ignore) {
          }
          finally {
            if (progressIndicator.isCanceled()) {
              task.onCanceled(progressIndicator);
            }
          }
        }
      }, progressIndicator);
  }

  public static void scheduleWithWriteActionPriority(@NotNull final ReadTask task) {
    scheduleWithWriteActionPriority(new ProgressIndicatorBase(), task);
  }

  public static void scheduleWithWriteActionPriority(@NotNull final ProgressIndicator indicator, @NotNull final ReadTask task) {
    // we have to attach listeners in EDT to avoid "fire write action started while attach listeners from another thread" race condition
    ApplicationManager.getApplication().invokeLater(new Runnable() {
      @Override
      public void run() {
        surroundWithListener(indicator, new Runnable() {
          @Override
          public void run() {
            ApplicationManager.getApplication().executeOnPooledThread(new Runnable() {
              @Override
              public void run() {
                runUnderProgress(indicator, task);
              }
            });
          }
        });
      }
    });
  }
}