Merge remote-tracking branch 'origin/master'
[idea/community.git] / platform / core-api / src / com / intellij / openapi / progress / ProgressIndicatorProvider.java
1 /*
2  * Copyright 2000-2011 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.openapi.progress;
17
18 import org.jetbrains.annotations.NotNull;
19 import org.jetbrains.annotations.Nullable;
20
21 /**
22  * @author yole
23  */
24 public abstract class ProgressIndicatorProvider {
25   @Nullable
26   public static volatile ProgressIndicatorProvider ourInstance;
27
28   @Nullable
29   public static ProgressIndicatorProvider getInstance() {
30     return ourInstance;
31   }
32
33   public abstract ProgressIndicator getProgressIndicator();
34
35   protected abstract void doCheckCanceled() throws ProcessCanceledException;
36
37   @Nullable
38   public static ProgressIndicator getGlobalProgressIndicator() {
39     ProgressIndicatorProvider provider = ourInstance;
40     return provider != null ? provider.getProgressIndicator() : null;
41   }
42
43   public abstract NonCancelableSection startNonCancelableSection();
44
45   @NotNull
46   public static NonCancelableSection startNonCancelableSectionIfSupported() {
47     ProgressIndicatorProvider provider = ourInstance;
48     return provider != null ? provider.startNonCancelableSection() : NonCancelableSection.EMPTY;
49   }
50
51   public static volatile boolean ourNeedToCheckCancel = false;
52   public static void checkCanceled() throws ProcessCanceledException {
53     // smart optimization! There's a thread started in ProgressManagerImpl, that set's this flag up once in 10 milliseconds
54     if (ourNeedToCheckCancel) {
55       ProgressIndicatorProvider provider = ourInstance;
56       if (provider != null) {
57         provider.doCheckCanceled();
58         ourNeedToCheckCancel = false;
59       }
60     }
61   }
62 }