From aa1c9755d4abbedc35a515be2fda73f2b814f025 Mon Sep 17 00:00:00 2001
From: Anna Kozlova <anna.kozlova@jetbrains.com>
Date: Wed, 30 Jan 2013 13:58:08 +0400
Subject: [PATCH] javafx: check that refs from .fxml are public or @FXML
 (IDEA-99996)

---
 plugins/javaFX/src/META-INF/plugin.xml        |  1 +
 .../javaFX/fxml/JavaFxCommonClassNames.java   |  2 +-
 .../refs/JavaFxEventHandlerReference.java     | 12 ++--
 .../javaFX/fxml/refs/JavaFxRefsAnnotator.java | 59 +++++++++++++++++++
 .../highlighting/PackageLocalController.fxml  |  8 +++
 .../highlighting/PackageLocalController.java  |  1 +
 .../javaFX/fxml/JavaFXHighlightingTest.java   |  5 ++
 7 files changed, 80 insertions(+), 8 deletions(-)
 create mode 100644 plugins/javaFX/src/org/jetbrains/plugins/javaFX/fxml/refs/JavaFxRefsAnnotator.java
 create mode 100644 plugins/javaFX/testData/highlighting/PackageLocalController.fxml
 create mode 100644 plugins/javaFX/testData/highlighting/PackageLocalController.java

diff --git a/plugins/javaFX/src/META-INF/plugin.xml b/plugins/javaFX/src/META-INF/plugin.xml
index f3506c41f7c1..200ab7ca86f0 100644
--- a/plugins/javaFX/src/META-INF/plugin.xml
+++ b/plugins/javaFX/src/META-INF/plugin.xml
@@ -17,5 +17,6 @@
     <codeInsight.unresolvedReferenceQuickFixProvider implementation="org.jetbrains.plugins.javaFX.fxml.refs.JavaFxEventHandlerReference$JavaFxUnresolvedReferenceHandlerQuickfixProvider"/>
     <codeInsight.unresolvedReferenceQuickFixProvider implementation="org.jetbrains.plugins.javaFX.fxml.refs.JavaFxTagNameReference$JavaFxUnresolvedTagRefsProvider"/>
     <multiHostInjector implementation="org.jetbrains.plugins.javaFX.fxml.ScriptLanguageInjector"/>
+    <annotator language="XML" implementationClass="org.jetbrains.plugins.javaFX.fxml.refs.JavaFxRefsAnnotator"/>
   </extensions>
 </idea-plugin>
diff --git a/plugins/javaFX/src/org/jetbrains/plugins/javaFX/fxml/JavaFxCommonClassNames.java b/plugins/javaFX/src/org/jetbrains/plugins/javaFX/fxml/JavaFxCommonClassNames.java
index 35b898ca1990..b400cbc0ae65 100644
--- a/plugins/javaFX/src/org/jetbrains/plugins/javaFX/fxml/JavaFxCommonClassNames.java
+++ b/plugins/javaFX/src/org/jetbrains/plugins/javaFX/fxml/JavaFxCommonClassNames.java
@@ -26,7 +26,7 @@ public class JavaFxCommonClassNames {
   @NonNls public static final String JAVAFX_ANCHOR_PANE = "javafx.scene.layout.AnchorPane";
   @NonNls public static final String JAVAFX_EVENT = "javafx.event.Event";
   @NonNls public static final String JAVAFX_BEANS_DEFAULT_PROPERTY = "javafx.beans.DefaultProperty";
-  @NonNls public static final String JAVAFX_FXML_FXML = "javafx.fxml.FXML";
+  @NonNls public static final String JAVAFX_FXML_ANNOTATION = "javafx.fxml.FXML";
   @NonNls public static final String JAVAFX_BEANS_PROPERTY_OBJECT_PROPERTY = "javafx.beans.property.ObjectProperty";
   @NonNls public static final String JAVAFX_EVENT_EVENT_HANDLER = "javafx.event.EventHandler";
   public static final String JAVAFX_SCENE_NODE = "javafx.scene.Node";
diff --git a/plugins/javaFX/src/org/jetbrains/plugins/javaFX/fxml/refs/JavaFxEventHandlerReference.java b/plugins/javaFX/src/org/jetbrains/plugins/javaFX/fxml/refs/JavaFxEventHandlerReference.java
index 0f8603bf1108..1cc90cbbc83f 100644
--- a/plugins/javaFX/src/org/jetbrains/plugins/javaFX/fxml/refs/JavaFxEventHandlerReference.java
+++ b/plugins/javaFX/src/org/jetbrains/plugins/javaFX/fxml/refs/JavaFxEventHandlerReference.java
@@ -73,13 +73,11 @@ public class JavaFxEventHandlerReference extends PsiReferenceBase<XmlAttributeVa
 
   public static boolean isHandlerMethod(PsiMethod psiMethod) {
     if (!psiMethod.hasModifierProperty(PsiModifier.STATIC) && PsiType.VOID.equals(psiMethod.getReturnType())) {
-      if (psiMethod.hasModifierProperty(PsiModifier.PUBLIC) || AnnotationUtil.isAnnotated(psiMethod, JavaFxCommonClassNames.JAVAFX_FXML_FXML, false)) {
-        final PsiParameter[] parameters = psiMethod.getParameterList().getParameters();
-        if (parameters.length == 1) {
-          final PsiType parameterType = parameters[0].getType();
-          if (InheritanceUtil.isInheritor(parameterType, JavaFxCommonClassNames.JAVAFX_EVENT)) {
-            return true;
-          }
+      final PsiParameter[] parameters = psiMethod.getParameterList().getParameters();
+      if (parameters.length == 1) {
+        final PsiType parameterType = parameters[0].getType();
+        if (InheritanceUtil.isInheritor(parameterType, JavaFxCommonClassNames.JAVAFX_EVENT)) {
+          return true;
         }
       }
     }
diff --git a/plugins/javaFX/src/org/jetbrains/plugins/javaFX/fxml/refs/JavaFxRefsAnnotator.java b/plugins/javaFX/src/org/jetbrains/plugins/javaFX/fxml/refs/JavaFxRefsAnnotator.java
new file mode 100644
index 000000000000..e1fc917f7738
--- /dev/null
+++ b/plugins/javaFX/src/org/jetbrains/plugins/javaFX/fxml/refs/JavaFxRefsAnnotator.java
@@ -0,0 +1,59 @@
+/*
+ * 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 org.jetbrains.plugins.javaFX.fxml.refs;
+
+import com.intellij.codeInsight.AnnotationUtil;
+import com.intellij.codeInsight.intention.AddAnnotationFix;
+import com.intellij.lang.annotation.Annotation;
+import com.intellij.lang.annotation.AnnotationHolder;
+import com.intellij.lang.annotation.Annotator;
+import com.intellij.psi.*;
+import com.intellij.psi.presentation.java.SymbolPresentationUtil;
+import com.intellij.psi.xml.XmlAttributeValue;
+import com.intellij.util.ArrayUtil;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.plugins.javaFX.fxml.JavaFxCommonClassNames;
+import org.jetbrains.plugins.javaFX.fxml.JavaFxFileTypeFactory;
+
+import java.util.Collections;
+
+/**
+ * User: anna
+ */
+public class JavaFxRefsAnnotator implements Annotator {
+  @Override
+  public void annotate(@NotNull PsiElement element, @NotNull AnnotationHolder holder) {
+    final PsiFile containingFile = element.getContainingFile();
+    if (!JavaFxFileTypeFactory.isFxml(containingFile)) return;
+    if (element instanceof XmlAttributeValue) {
+      final PsiReference[] references = element.getReferences();
+      for (PsiReference reference : references) {
+        final PsiElement resolve = reference.resolve();
+        if (resolve instanceof PsiMember) {
+          if (!((PsiMember)resolve).hasModifierProperty(PsiModifier.PUBLIC) &&
+              !AnnotationUtil.isAnnotated((PsiMember)resolve, Collections.singleton(JavaFxCommonClassNames.JAVAFX_FXML_ANNOTATION))) {
+            final String symbolPresentation = "'" + SymbolPresentationUtil.getSymbolPresentableText(resolve) + "'";
+            final Annotation annotation = holder.createErrorAnnotation(element, 
+                                                                       symbolPresentation + (resolve instanceof PsiClass ? " should be public" : " should be public or annotated with @FXML"));
+            if (!(resolve instanceof PsiClass)) {
+              annotation.registerUniversalFix(new AddAnnotationFix(JavaFxCommonClassNames.JAVAFX_FXML_ANNOTATION, (PsiMember)resolve, ArrayUtil.EMPTY_STRING_ARRAY), null, null);
+            }
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/plugins/javaFX/testData/highlighting/PackageLocalController.fxml b/plugins/javaFX/testData/highlighting/PackageLocalController.fxml
new file mode 100644
index 000000000000..ce7f1ce62bcb
--- /dev/null
+++ b/plugins/javaFX/testData/highlighting/PackageLocalController.fxml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<?import javafx.geometry.*?>
+<?import javafx.scene.layout.*?>
+<?import javafx.scene.control.*?>
+<?import javafx.scene.text.*?>
+<GridPane fx:controller=<error descr="'PackageLocalController' should be public">"PackageLocalController"</error> xmlns:fx="http://javafx.com/fxml">
+</GridPane>
\ No newline at end of file
diff --git a/plugins/javaFX/testData/highlighting/PackageLocalController.java b/plugins/javaFX/testData/highlighting/PackageLocalController.java
new file mode 100644
index 000000000000..4899276eb770
--- /dev/null
+++ b/plugins/javaFX/testData/highlighting/PackageLocalController.java
@@ -0,0 +1 @@
+class PackageLocalController{}
\ No newline at end of file
diff --git a/plugins/javaFX/testSrc/org/jetbrains/plugins/javaFX/fxml/JavaFXHighlightingTest.java b/plugins/javaFX/testSrc/org/jetbrains/plugins/javaFX/fxml/JavaFXHighlightingTest.java
index aa8d06b38c70..ae6393378523 100644
--- a/plugins/javaFX/testSrc/org/jetbrains/plugins/javaFX/fxml/JavaFXHighlightingTest.java
+++ b/plugins/javaFX/testSrc/org/jetbrains/plugins/javaFX/fxml/JavaFXHighlightingTest.java
@@ -62,6 +62,11 @@ public class JavaFXHighlightingTest extends DaemonAnalyzerTestCase {
   public void testControllerIdRef() throws Exception {
     doTestIdController();
   }
+
+  public void testPackageLocalController() throws Exception {
+    configureByFiles(null, getTestName(true) + ".fxml", getTestName(false) + ".java");
+    doDoTest(false, false);
+  }
   
   private void doTestIdController() throws Exception {
     final String controllerClassName = getTestName(false) + "Controller";