devkit inspection: empty toolbar id

Signed-off-by: Konstantin Bulenkov <kb@jetbrains.com>
2026-09-27 10:03:11 +07:00 · 2017-05-24 01:25:00 +03:00
parent 227a7fe765
commit 82da4076a1
5 changed files with 131 additions and 0 deletions
@@ -65,6 +65,9 @@
    <localInspection language="JAVA" shortName="InspectionUsingGrayColors" displayName="Using new Color(a,a,a)"
                     groupKey="inspections.group.name" enabledByDefault="true" level="WARNING"
                     implementationClass="org.jetbrains.idea.devkit.inspections.UseGrayInspection"/>
+    <localInspection language="JAVA" shortName="InspectionUniqueToolbarId" displayName="Specify toolbar id"
+                     groupKey="inspections.group.name" enabledByDefault="true" level="WARNING"
+                     implementationClass="org.jetbrains.idea.devkit.inspections.UniqueToolbarIdInspection"/>
    <localInspection language="JAVA" shortName="IntentionDescriptionNotFoundInspection" displayName="Intention Description Checker"
                     groupKey="inspections.group.name" enabledByDefault="true" level="WARNING"
                     implementationClass="org.jetbrains.idea.devkit.inspections.IntentionDescriptionNotFoundInspection"/>
@@ -0,0 +1,5 @@
+<html>
+<body>
+<p>Please specify unique toolbar id</p>
+</body>
+</html>
@@ -0,0 +1,66 @@
+/*
+ * Copyright 2000-2017 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.idea.devkit.inspections;
+
+import com.intellij.codeInspection.ProblemsHolder;
+import com.intellij.openapi.actionSystem.ActionManager;
+import com.intellij.openapi.util.Comparing;
+import com.intellij.openapi.util.text.StringUtil;
+import com.intellij.psi.*;
+import com.intellij.psi.util.PsiTypesUtil;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * @author Konstantin Bulenkov
+ */
+public class UniqueToolbarIdInspection extends DevKitInspectionBase {
+  @Override
+  protected PsiElementVisitor buildInternalVisitor(@NotNull ProblemsHolder holder, boolean isOnTheFly) {
+    return new JavaElementVisitor() {
+      @Override
+      public void visitMethodCallExpression(PsiMethodCallExpression expression) {
+        PsiMethod method = expression.resolveMethod();
+        if (method != null && "createActionToolbar".equals(method.getName())) {
+          PsiClass aClass = method.getContainingClass();
+          if (aClass != null && ActionManager.class.getName().equals(aClass.getQualifiedName())) {
+            PsiParameter[] parameters = method.getParameterList().getParameters();
+            if (parameters.length > 0 &&  parameters[0].getType() instanceof PsiClassType) {
+              PsiType type = parameters[0].getType();
+              //first check doesn't require resolve
+              if (Comparing.equal(((PsiClassType)type).getClassName(), CommonClassNames.JAVA_LANG_STRING_SHORT)
+                && CommonClassNames.JAVA_LANG_STRING.equals(type.getCanonicalText(false))) {
+                PsiExpression[] expressions = expression.getArgumentList().getExpressions();
+                if (expressions.length > 0) {
+                  String text = expressions[0].getText();
+                  if (text.equals("\"\"") || text.endsWith(".UNKNOWN")) {
+                    holder.registerProblem(expressions[0], "Specify unique toolbar id");
+                  }
+                }
+              }
+            }
+          }
+        }
+        super.visitMethodCallExpression(expression);
+      }
+    };
+  }
+
+  @NotNull
+  @Override
+  public String getShortName() {
+    return "InspectionUniqueToolbarId";
+  }
+}
@@ -0,0 +1,8 @@
+import com.intellij.openapi.actionSystem.*;
+public class UniqueToolbarIdTestDataClass {
+  public void foo() {
+    ActionManager.getInstance().createActionToolbar("asdasd", new ActionGroup(), false);
+    ActionManager.getInstance().createActionToolbar(<warning descr="Specify unique toolbar id">""</warning>, new ActionGroup(), false);
+    ActionManager.getInstance().createActionToolbar(<warning descr="Specify unique toolbar id">ActionPlaces.UNKNOWN</warning>, new ActionGroup(), false);
+  }
+}
@@ -0,0 +1,49 @@
+/*
+ * Copyright 2000-2017 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.idea.devkit.inspections;
+
+import com.intellij.openapi.application.PluginPathManager;
+import com.intellij.testFramework.TestDataPath;
+
+/**
+ * @author Konstantin Bulenkov
+ */
+@TestDataPath("$CONTENT_ROOT/testData/inspections/uniqueToolbarId")
+public class UniqueToolbarIdInspectionTest extends PluginModuleTestCase {
+
+  @Override
+  protected String getBasePath() {
+    return PluginPathManager.getPluginHomePathRelative("devkit") + "/testData/inspections/uniqueToolbarId";
+  }
+
+  @Override
+  protected void setUp() throws Exception {
+    super.setUp();
+    myFixture.enableInspections(UniqueToolbarIdInspection.class);
+    myFixture.addClass("package com.intellij.openapi.actionSystem; public class ActionToolbar {}");
+    myFixture.addClass("package com.intellij.openapi.actionSystem; public class ActionGroup {}");
+    myFixture.addClass("package com.intellij.openapi.actionSystem; public class ActionPlaces {public static final String UNKNOWN = \"\";}");
+    myFixture.addClass("package com.intellij.openapi.actionSystem; " +
+                       "public class ActionManager {" +
+                       "public static ActionManager getInstance() {return new ActionManager();}" +
+                       "public ActionToolbar createActionToolbar(@NonNls String place, @NotNull ActionGroup group, boolean horizontal) {return new ActionToolbar();}" +
+                       "}");
+  }
+
+  public void testUsingEmptyToolbarId() throws Exception {
+    myFixture.testHighlighting("UniqueToolbarIdTestDataClass.java");
+  }
+}