Show deprecated info in Documentation view

Author: m0rkeulv

src/main/java/com/intellij/plugins/haxe/ide/documentation/providers/HaxeDocumentationProvider.java

@@ -28,6 +28,9 @@
 import com.intellij.plugins.haxe.lang.parser.HaxePsiDocCommentImpl;
 import com.intellij.plugins.haxe.lang.psi.*;
 import com.intellij.plugins.haxe.lang.psi.fakes.HaxeFakePsiElement;
+import com.intellij.plugins.haxe.metadata.HaxeMetadataList;
+import com.intellij.plugins.haxe.metadata.psi.HaxeMeta;
+import com.intellij.plugins.haxe.metadata.psi.HaxeMetadataContent;
 import com.intellij.plugins.haxe.model.*;
 import com.intellij.plugins.haxe.model.evaluator.HaxeExpressionEvaluator;
 import com.intellij.plugins.haxe.model.evaluator.HaxeExpressionEvaluatorContext;
@@ -69,6 +72,7 @@ public String getQuickNavigateInfo(PsiElement element, PsiElement originalElemen
         resolveTypeAndMakeHeader(mainBuilder, namedComponent);
         return mainBuilder.toString();
       }
+      appendDeprecatedInfo(namedComponent, mainBuilder);
       switch (type) {
         case CLASS, ABSTRACT, INTERFACE, TYPEDEF, ENUM -> processType(mainBuilder, namedComponent, renderer);
         case METHOD, FUNCTION -> processMethod(mainBuilder, namedComponent, renderer);
@@ -132,6 +136,7 @@ public String generateDoc(PsiElement element, PsiElement originalElement) {
       resolveTypeAndMakeHeader(mainBuilder, namedComponent);
       return mainBuilder.toString();
     }
+    appendDeprecatedInfo(namedComponent, mainBuilder);
     switch (type) {
       case CLASS, ABSTRACT, INTERFACE, TYPEDEF, ENUM -> processType(definitionBuilder, namedComponent, renderer);
       case METHOD, FUNCTION -> processMethod(definitionBuilder, namedComponent, renderer);
@@ -148,6 +153,40 @@ public String generateDoc(PsiElement element, PsiElement originalElement) {
     return mainBuilder.toString();
   }
 
+    private void appendDeprecatedInfo(HaxeNamedComponent namedComponent, HtmlBuilder mainBuilder) {
+      HaxeMetadataList compileTimeMeta = namedComponent.getCompileTimeMeta(HaxeMeta.DEPRECATED);
+      if(compileTimeMeta!= null) {
+        HaxeMeta first = compileTimeMeta.getFirst();
+        Color color = DefaultLanguageHighlighterColors.METADATA.getDefaultAttributes().getForegroundColor();
+        HtmlChunk.Element chunk = HtmlChunk.div().italic().bold()
+                .attr("color", "#" + colorToHex(color))
+                .addText("Deprecated");
+
+        mainBuilder.append(chunk);
+
+        HaxeMetadataContent content = first.getContent();
+        if (content != null && content.getText() != null) {
+          String contentText = content.getText();
+          if ((contentText.startsWith("\"") || contentText.startsWith("'"))
+                  && (contentText.endsWith("\"") || contentText.endsWith("'"))) {
+           String  message = contentText.substring(1, contentText.length() - 1); // drop string quotes
+
+            mainBuilder.br();
+            HtmlChunk.Element messageChunk = HtmlChunk.div()
+                    .attr("color", "#" + colorToHex(color))
+                    .addText(message)
+                    .bold()
+                    .italic();
+            mainBuilder.append(messageChunk);
+          }
+        }
+
+
+
+        mainBuilder.append(HtmlChunk.hr());
+      }
+    }
+
   private void createModuleDocs(HtmlBuilder mainBuilder, HaxeModule module) {
     if( module.getModel() instanceof  HaxeModuleModel model) {
       String qname = model.getPackageName();

src/main/java/com/intellij/plugins/haxe/ide/inspections/HaxeDeprecatedInspection.java

@@ -72,21 +72,6 @@ public ProblemDescriptor[] checkFile(@NotNull PsiFile file, @NotNull final Inspe
     if (!(file instanceof HaxeFile)) return null;
     final List<ProblemDescriptor> result = new ArrayList<ProblemDescriptor>();
     new HaxeAnnotatingVisitor() {
-      @Override
-      protected void handleDeprecatedFunctionDeclaration(@NotNull HaxeMethodDeclaration function) {
-        PsiIdentifier nameIdentifier = function.getNameIdentifier();
-
-        if (nameIdentifier != null) {
-          result.add(manager.createProblemDescriptor(
-            nameIdentifier,
-            TextRange.from(0, nameIdentifier.getTextLength()),
-            getDisplayName(),
-            ProblemHighlightType.LIKE_DEPRECATED,
-            isOnTheFly
-          ));
-        }
-      }
-
       @Override
       protected void handleDeprecatedCallExpression(HaxeReferenceExpression referenceExpression) {
         PsiIdentifier identifier = referenceExpression.getIdentifier();
@@ -98,19 +83,6 @@ protected void handleDeprecatedCallExpression(HaxeReferenceExpression referenceE
           isOnTheFly
         ));
       }
-
-      @Override
-      protected void handleDeprecatedFieldDeclaration(HaxeFieldDeclaration varDeclaration) {
-        PsiIdentifier nameIdentifier = varDeclaration.getNameIdentifier();
-
-        result.add(manager.createProblemDescriptor(
-          nameIdentifier,
-          TextRange.from(0, nameIdentifier.getTextLength()),
-          getDisplayName(),
-          ProblemHighlightType.LIKE_DEPRECATED,
-          isOnTheFly
-        ));
-      }
     }.visitFile(file);
     return ArrayUtil.toObjectArray(result, ProblemDescriptor.class);
   }

src/main/java/com/intellij/plugins/haxe/lang/psi/HaxeClass.java

@@ -164,18 +164,6 @@ static HaxeClass createUnknownClass(ASTNode node) {
   HaxeNamedComponent findArrayAccessGetter(@Nullable HaxeGenericResolver resolver);
   HaxeNamedComponent findArrayAccessSetter(@Nullable HaxeGenericResolver resolver);
 
-  default boolean hasMeta(HaxeMetadataTypeName meta) {
-    return HaxeMetadataUtils.hasMeta(this, meta);
-  }
-
-  default boolean hasCompileTimeMeta(HaxeMetadataTypeName meta) {
-    return HaxeMetadataUtils.hasMeta(this, HaxeMetadataCompileTimeMeta.class, meta);
-  }
-
-  default HaxeMetadataList getCompileTimeMeta(HaxeMetadataTypeName meta) {
-    return HaxeMetadataUtils.getMetadataList(this, HaxeMetadataCompileTimeMeta.class, meta);
-  }
-
   PsiPackage getPackage();
 
   HaxeModule getModule();

src/main/java/com/intellij/plugins/haxe/lang/psi/HaxeNamedComponent.java

@@ -18,7 +18,10 @@
 package com.intellij.plugins.haxe.lang.psi;
 
 import com.intellij.plugins.haxe.HaxeComponentType;
-import com.intellij.plugins.haxe.lang.lexer.HaxeTokenTypes;
+import com.intellij.plugins.haxe.metadata.HaxeMetadataList;
+import com.intellij.plugins.haxe.metadata.psi.HaxeMetadataCompileTimeMeta;
+import com.intellij.plugins.haxe.metadata.psi.impl.HaxeMetadataTypeName;
+import com.intellij.plugins.haxe.metadata.util.HaxeMetadataUtils;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.tree.IElementType;
 import org.jetbrains.annotations.Nullable;
@@ -50,4 +53,16 @@ public interface HaxeNamedComponent extends HaxePsiCompositeElement {
   // Added the slowdowns from HaxeComponentType.typeOf()
   // se method description for explanation description
   HaxeComponentType getComponentType();
+
+  default boolean hasMeta(HaxeMetadataTypeName meta) {
+    return HaxeMetadataUtils.hasMeta(this, meta);
+  }
+
+  default boolean hasCompileTimeMeta(HaxeMetadataTypeName meta) {
+    return HaxeMetadataUtils.hasMeta(this, HaxeMetadataCompileTimeMeta.class, meta);
+  }
+
+  default HaxeMetadataList getCompileTimeMeta(HaxeMetadataTypeName meta) {
+    return HaxeMetadataUtils.getMetadataList(this, HaxeMetadataCompileTimeMeta.class, meta);
+  }
 }