summaryrefslogtreecommitdiff
path: root/xml/openapi/src/com/intellij/ide/browsers/WebBrowserUrlProvider.java
blob: 372c28a338b3bf848c389c92745e021cf5e468eb (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
/*
 * Copyright 2000-2013 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.ide.browsers;

import com.intellij.openapi.extensions.ExtensionPointName;
import com.intellij.openapi.util.Ref;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiFile;
import com.intellij.util.Url;
import com.intellij.util.containers.ContainerUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.Collection;
import java.util.Set;

public abstract class WebBrowserUrlProvider {
  public static final ExtensionPointName<WebBrowserUrlProvider> EP_NAME = ExtensionPointName.create("com.intellij.webBrowserUrlProvider");

  private final boolean myDeprecatedMethodOverridden;

  protected WebBrowserUrlProvider() {
    boolean deprecatedMethodOverridden;
    try {
      deprecatedMethodOverridden =
        getClass().getMethod("canHandleElement", PsiElement.class, PsiFile.class, Ref.class).getDeclaringClass() != WebBrowserUrlProvider.class ||
        getClass().getMethod("canHandle", PsiElement.class, PsiFile.class, Ref.class).getDeclaringClass() != WebBrowserUrlProvider.class;
    }
    catch (Throwable ignored) {
      deprecatedMethodOverridden = false;
    }
    myDeprecatedMethodOverridden = deprecatedMethodOverridden;
  }

  /**
   * Browser exceptions are printed in Error Dialog when user presses any browser button
   */
  public static class BrowserException extends Exception {
    public BrowserException(final String message) {
      super(message);
    }
  }

  @Deprecated
  /**
   * @deprecated to remove in IDEA 14
   */
  public boolean canHandleElement(@NotNull PsiElement element, @NotNull PsiFile psiFile, @NotNull Ref<Set<Url>> result) {
    Ref<Collection<Url>> ref = Ref.create();
    @SuppressWarnings("deprecation")
    boolean canHandle = canHandle(element, psiFile, ref);
    if (!ref.isNull()) {
      result.set(ContainerUtil.newHashSet(ref.get()));
    }
    return canHandle;
  }

  @SuppressWarnings("UnusedParameters")
  @Deprecated
  /**
   * @deprecated to remove in IDEA 15
   */
  public boolean canHandle(@NotNull PsiElement element, @NotNull PsiFile psiFile, @NotNull Ref<Collection<Url>> result) {
    return false;
  }

  public boolean canHandleElement(@NotNull OpenInBrowserRequest request) {
    if (myDeprecatedMethodOverridden) {
      Ref<Set<Url>> resultRef = Ref.create();
      //noinspection deprecation
      if (canHandleElement(request.getElement(), request.getFile(), resultRef)) {
        request.setResult(resultRef.get());
        return true;
      }
    }

    try {
      Collection<Url> urls = getUrls(request);
      if (!urls.isEmpty()) {
        request.setResult(urls);
        return true;
      }
    }
    catch (BrowserException ignored) {
    }

    return false;
  }

  @Nullable
  protected Url getUrl(@NotNull OpenInBrowserRequest request, @NotNull VirtualFile virtualFile) throws BrowserException {
    //noinspection deprecation
    return myDeprecatedMethodOverridden ? getUrl(request.getElement(), request.getFile(), virtualFile) : null;
  }

  @SuppressWarnings("UnusedParameters")
  @Deprecated
  @Nullable
  /**
   * @deprecated to remove in IDEA 14
   */
  public Url getUrl(@NotNull PsiElement element, @NotNull PsiFile psiFile, @NotNull VirtualFile virtualFile) throws BrowserException {
    return null;
  }

  @NotNull
  public Collection<Url> getUrls(@NotNull OpenInBrowserRequest request) throws BrowserException {
    return ContainerUtil.createMaybeSingletonList(getUrl(request, request.getVirtualFile()));
  }

  @SuppressWarnings({"UnusedParameters", "UnusedDeclaration"})
  @Nullable
  @Deprecated
  public String getOpenInBrowserActionText(@NotNull PsiFile file) {
    return null;
  }

  @Nullable
  public String getOpenInBrowserActionDescription(@NotNull PsiFile file) {
    return null;
  }
}