generator: detailed error on missing path-expr (#252)

Author: gregsh

src/org/intellij/grammar/generator/ParserGenerator.java

@@ -49,8 +49,7 @@
 import static org.intellij.grammar.generator.NameShortener.getRawClassName;
 import static org.intellij.grammar.generator.ParserGeneratorUtil.*;
 import static org.intellij.grammar.generator.RuleGraphHelper.Cardinality.*;
-import static org.intellij.grammar.generator.RuleGraphHelper.getSynonymTargetOrSelf;
-import static org.intellij.grammar.generator.RuleGraphHelper.hasPsiClass;
+import static org.intellij.grammar.generator.RuleGraphHelper.*;
 import static org.intellij.grammar.psi.BnfTypes.*;
 
 
@@ -2036,6 +2035,7 @@ private JBIterable<?> resolveUserPsiPathMethods(BnfRule startRule,
       String item = indexStart > -1 ? pathElement.substring(0, indexStart).trim() : pathElement.trim();
 
       if (item.isEmpty()) return item;
+      if (targetRule[0] == null) return null;
       RuleMethodsHelper.MethodInfo targetInfo = myRulesMethodsHelper.getMethodInfo(targetRule[0], item);
       targetRule[0] = targetInfo == null ? null : targetInfo.rule;
       return targetInfo;
@@ -2057,18 +2057,44 @@ private void generateUserPsiAccessors(BnfRule startRule, RuleMethodsHelper.Metho
       boolean last = i == splitPath.length - 1;
       int indexStart = pathElement.indexOf('[');
       int indexEnd = indexStart > 0 ? pathElement.lastIndexOf(']') : -1;
+      String base = (indexStart > -1 ? pathElement.substring(0, indexStart) : pathElement).trim();
       String index = indexEnd > -1 ? pathElement.substring(indexStart + 1, indexEnd).trim() : null;
-      if ("first".equals(index)) index = "0";
+
 
       RuleMethodsHelper.MethodInfo targetInfo = (RuleMethodsHelper.MethodInfo)m;
-      if (targetInfo == null ||
-          index != null && !targetInfo.cardinality.many() ||
-          i > 0 && StringUtil.isEmpty(targetInfo.name) && targetInfo.rule == null) {
+      String error;
+      if (indexStart > 0 && (indexEnd == -1 || StringUtil.isNotEmpty(pathElement.substring(indexEnd + 1)))) {
+        error = "'<name>[<index>]' expected, got '" + pathElement + "'";
+      }
+      else if (targetInfo == null) {
+        Collection<String> available = targetRule == null ? null : myRulesMethodsHelper.getMethodNames(targetRule);
+        if (targetRule == null) {
+          error = "'" + base + "' not found in '" + splitPath[i - 1] + "' (not a rule)";
+        }
+        else if (available == null || available.isEmpty()) {
+          error = "'" + base + "' not found in '" + targetRule.getName() + "' (available: nothing)";
+        }
+        else {
+          error = "'" + base + "' not found in '" + targetRule.getName() + "' (available: " + String.join(", ", available) + ")";
+        }
+      }
+      else if (index != null && !targetInfo.cardinality.many()) {
+        error = "'[" + index + "]' unexpected after '" + base + getCardinalityText(targetInfo.cardinality) + "'";
+      }
+      else if (!last && index == null && targetInfo.cardinality.many()) {
+        error = "'[<index>]' required after '" + base + getCardinalityText(targetInfo.cardinality) + "'";
+      }
+      else if (i > 0 && StringUtil.isEmpty(targetInfo.name)) {
+        error = "'" + base + "' accessor suppressed in '" + splitPath[i - 1] + "'";
+      }
+      else {
+        error = null;
+      }
+      if (error != null) {
         if (intf) { // warn only once
-          addWarning(startRule.getProject(), "incorrect item '" + pathElement + "' in '" + startRule.getName() + "' method " +
-                                             methodInfo.name + "=\"" + methodInfo.path + "\"");
+          addWarning(startRule.getProject(), "%s#%s(\"%s\"): %s", startRule.getName(), methodInfo.name, methodInfo.path, error);
         }
-        return; // missing rule, unknown or wrong cardinality
+        return;
       }
 
       boolean many = targetInfo.cardinality.many();
@@ -2105,6 +2131,8 @@ private void generateUserPsiAccessors(BnfRule startRule, RuleMethodsHelper.Metho
 
       // list item
       if (index != null) {
+        if ("first".equals(index)) index = "0";
+
         context += ".";
         boolean isLast = index.equals("last");
         if (isLast) index = context + "size() - 1";

src/org/intellij/grammar/generator/RuleMethodsHelper.java

@@ -69,15 +69,20 @@ public void buildMaps(Collection<BnfRule> sortedPsiRules) {
   }
 
   @NotNull
-  public Collection<MethodInfo> getFor(BnfRule rule) {
+  public Collection<MethodInfo> getFor(@NotNull BnfRule rule) {
     return myMethods.get(rule).second;
   }
 
   @Nullable
-  public MethodInfo getMethodInfo(BnfRule rule, String name) {
+  public MethodInfo getMethodInfo(@NotNull BnfRule rule, String name) {
     return myMethods.get(rule).first.get(name);
   }
 
+  @Nullable
+  public Collection<String> getMethodNames(@NotNull BnfRule rule) {
+    return myMethods.get(rule).first.keySet();
+  }
+
   protected void calcMethods(BnfRule rule, Map<String, String> tokensReversed) {
     List<MethodInfo> result = new ArrayList<>();
 

testData/generator/PsiAccessors.PSI.expected.java

@@ -87,6 +87,17 @@ public interface XBinary extends XComposite {
   @Nullable
   XValue getBadIndex();
 
+}
+// ---- XEmpty.java -----------------
+//header.txt
+package generated.psi;
+
+import java.util.List;
+import org.jetbrains.annotations.*;
+import com.intellij.psi.PsiElement;
+
+public interface XEmpty extends XComposite {
+
 }
 // ---- XExpression.java -----------------
 //header.txt
@@ -136,6 +147,21 @@ public interface XRenameList extends XComposite {
   @Nullable
   XSomeChild getLast();
 
+}
+// ---- XReportSomeBad.java -----------------
+//header.txt
+package generated.psi;
+
+import java.util.List;
+import org.jetbrains.annotations.*;
+import com.intellij.psi.PsiElement;
+import generated.psi.child.XSomeChild;
+
+public interface XReportSomeBad extends XComposite {
+
+  @NotNull
+  XReportSomeBad getReportSomeBad();
+
 }
 // ---- XSomeChild.java -----------------
 //header.txt
@@ -356,6 +382,26 @@ public XValue getBadIndex() {
     return p3.size() - 1 < wrong_turn ? null : p3.get(wrong_turn);
   }
 
+}
+// ---- XEmptyImpl.java -----------------
+//header.txt
+package generated.psi.impl;
+
+import java.util.List;
+import org.jetbrains.annotations.*;
+import com.intellij.lang.ASTNode;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.util.PsiTreeUtil;
+import static generated.GeneratedTypes.*;
+import com.intellij.extapi.psi.ASTWrapperPsiElement;
+import generated.psi.*;
+
+public class XEmptyImpl extends ASTWrapperPsiElement implements XEmpty {
+
+  public XEmptyImpl(@NotNull ASTNode node) {
+    super(node);
+  }
+
 }
 // ---- XExpressionImpl.java -----------------
 //header.txt
@@ -452,6 +498,33 @@ public XSomeChild getLast() {
     return p1.isEmpty()? null : p1.get(p1.size() - 1);
   }
 
+}
+// ---- XReportSomeBadImpl.java -----------------
+//header.txt
+package generated.psi.impl;
+
+import java.util.List;
+import org.jetbrains.annotations.*;
+import com.intellij.lang.ASTNode;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.util.PsiTreeUtil;
+import static generated.GeneratedTypes.*;
+import com.intellij.extapi.psi.ASTWrapperPsiElement;
+import generated.psi.*;
+import generated.psi.child.XSomeChild;
+
+public class XReportSomeBadImpl extends ASTWrapperPsiElement implements XReportSomeBad {
+
+  public XReportSomeBadImpl(@NotNull ASTNode node) {
+    super(node);
+  }
+
+  @Override
+  @NotNull
+  public XReportSomeBad getReportSomeBad() {
+    return findNotNullChildByClass(XReportSomeBad.class);
+  }
+
 }
 // ---- XSomeChildImpl.java -----------------
 //header.txt

testData/generator/PsiAccessors.bnf

@@ -41,6 +41,7 @@ operator ::= '+' | '-'
 
 expression ::= value '*' value
 value ::= id
+fake empty ::=
 
 fake token-defaults ::= UPCASEKWD1 lowcasekwd1 UPCASEKWD2 lowcasekwd2 nodef
 fake some-root ::= some-child value {
@@ -72,3 +73,18 @@ fake rename-list ::= some-child * {
     last="some-child[last]"
   ]
 }
+
+fake report_some_bad ::= report_some_bad empty some-child * {
+  methods=[
+    some-child=""
+    empty=""
+
+    bad0="some-child[0]zzz/"
+    bad1="some-child[0]/missing-child"
+    bad2="empty/missing-child"
+    bad3="some-child/MY_SOMETHING"
+    bad4="some-child[first]/MY_SOMETHING/BAD"
+    bad5="report_some_bad[0]/some-child"
+    bad6="report_some_bad/some-child"
+  ]
+}