7b75f87858ee0a141497b4974e409447010b6581
[idea/community.git] / java / java-psi-api / src / com / intellij / psi / compiled / ClassFileDecompilers.java
1 // Copyright 2000-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
2 package com.intellij.psi.compiled;
3
4 import com.intellij.openapi.application.Application;
5 import com.intellij.openapi.application.ApplicationManager;
6 import com.intellij.openapi.components.Service;
7 import com.intellij.openapi.extensions.ExtensionPointName;
8 import com.intellij.openapi.fileTypes.BinaryFileTypeDecompilers;
9 import com.intellij.openapi.vfs.VirtualFile;
10 import com.intellij.psi.FileViewProvider;
11 import com.intellij.psi.PsiManager;
12 import org.jetbrains.annotations.NotNull;
13 import org.jetbrains.annotations.Nullable;
14
15 /**
16  * An API to extend default IDEA .class file decompiler and handle files compiled from sources other than Java.
17  */
18 @Service
19 public final class ClassFileDecompilers {
20   /**
21    * Actual implementations should extend either {@link Light} or {@link Full} classes -
22    * those that don't are silently ignored.
23    */
24   public interface Decompiler {
25     boolean accepts(@NotNull VirtualFile file);
26   }
27
28   /**
29    * <p>"Light" decompilers are intended for augmenting file text constructed by standard IDEA decompiler
30    * without changing it's structure - i.e. providing additional information in comments,
31    * or replacing standard "compiled code" method body comment with something more meaningful.</p>
32    *
33    * <p>If a plugin by somewhat reason cannot decompile a file it can throw {@link Light.CannotDecompileException}
34    * and thus make IDEA to fall back to a built-in decompiler implementation.</p>
35    *
36    * <p>Plugins registering extension of this type normally should accept all files and use {@code order="last"}
37    * attribute to avoid interfering with other decompilers.</p>
38    */
39   public abstract static class Light implements Decompiler {
40     public static class CannotDecompileException extends RuntimeException {
41       public CannotDecompileException(String message) {
42         super(message);
43       }
44
45       public CannotDecompileException(Throwable cause) {
46         super(cause);
47       }
48     }
49
50     @NotNull
51     public abstract CharSequence getText(@NotNull VirtualFile file) throws CannotDecompileException;
52   }
53
54   /**
55    * <p>"Full" decompilers are designed to provide extended support for languages significantly different from Java.
56    * Extensions of this type should take care of building file stubs and properly indexing them -
57    * in return they have an ability to represent decompiled file in a way natural for original language.</p>
58    */
59   public abstract static class Full implements Decompiler {
60     @NotNull
61     public abstract ClsStubBuilder getStubBuilder();
62
63     /**
64      * <h5>Notes for implementers</h5>
65      *
66      * <p>1. Return a correct language from {@link FileViewProvider#getBaseLanguage()}.</p>
67      *
68      * <p>2. This method is called for both PSI file construction and obtaining document text.
69      * In the latter case the PsiManager is based on default project, and the only method called
70      * on a resulting view provider is {@link FileViewProvider#getContents()}.</p>
71      *
72      * <p>3. A language compiler may produce auxiliary .class files which should be handled as part of their parent classes.
73      * A standard practice is to hide such files by returning {@code null} from
74      * {@link FileViewProvider#getPsi(com.intellij.lang.Language)}.</p>
75      */
76     @NotNull
77     public abstract FileViewProvider createFileViewProvider(@NotNull VirtualFile file, @NotNull PsiManager manager, boolean physical);
78   }
79
80   public static ClassFileDecompilers getInstance() {
81     return ApplicationManager.getApplication().getService(ClassFileDecompilers.class);
82   }
83
84   public final ExtensionPointName<Decompiler> EP_NAME = new ExtensionPointName<>("com.intellij.psi.classFileDecompiler");
85
86   private ClassFileDecompilers() {
87     Application app = ApplicationManager.getApplication();
88     if (!app.isHeadlessEnvironment() || app.isUnitTestMode()) {
89       EP_NAME.addChangeListener(() -> BinaryFileTypeDecompilers.getInstance().notifyDecompilerSetChange(), null);
90     }
91   }
92
93   public @Nullable Decompiler find(@NotNull VirtualFile file) {
94     return EP_NAME.findFirstSafe(decompiler -> (decompiler instanceof Light || decompiler instanceof Full) && decompiler.accepts(file));
95   }
96 }