[clang-query] Add check to prevent setting srcloc when no introspection is available.

[njames93]

Summary

Checks if introspection support is available set output kind parser.
If it isn't present the auto complete will not suggest srcloc and an error query will be reported if a user tries to access it.

[njames93]

Cleanup.

[njames93]

Fix up tests(probably, see what premerge says)

[steveire]

LGTM!

clang-tools-extra/unittests/clang-query/QueryParserTest.cpp

249

nit: I think HasIntrospection ? 4 : 3 would be clearer.

[njames93]

Nit.

clang-tools-extra/clang-query/Query.h

 // Implements the exclusive 'set output dump|diag|print' options.
 struct SetExclusiveOutputQuery : Query {
   SetExclusiveOutputQuery(bool QuerySession::*Var)
       : Query(QK_SetOutputKind), Var(Var) {}
   bool run(llvm::raw_ostream &OS, QuerySession &QS) const override {
     QS.DiagOutput = false;
     QS.DetailedASTOutput = false;
     QS.PrintOutput = false;
+    QS.SrcLocOutput = false;
     QS.*Var = true;
     return true;
   }
 
   static bool classof(const Query *Q) { return Q->Kind == QK_SetOutputKind; }
 
   bool QuerySession::*Var;
 };

clang-tools-extra/clang-query/QueryParser.cpp

 //===---- QueryParser.cpp - clang-query command parser --------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #include "QueryParser.h"
 #include "Query.h"
 #include "QuerySession.h"
 #include "clang/ASTMatchers/Dynamic/Parser.h"
 #include "clang/Basic/CharInfo.h"
+#include "clang/Tooling/NodeIntrospection.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/ADT/StringSwitch.h"
 #include <set>
 
 using namespace llvm;
 using namespace clang::ast_matchers::dynamic;
 
 namespace clang {
QueryRef QueryParser::parseSetBool(bool QuerySession::*Var) {
   if (Value == ~0u) {
     return new InvalidQuery("expected 'true' or 'false', got '" + ValStr + "'");
   }
   return new SetQuery<bool>(Var, Value);
 }
 
 template <typename QueryType> QueryRef QueryParser::parseSetOutputKind() {
   StringRef ValStr;
-  unsigned OutKind = LexOrCompleteWord<unsigned>(this, ValStr)
-                         .Case("diag", OK_Diag)
-                         .Case("print", OK_Print)
-                         .Case("detailed-ast", OK_DetailedAST)
-                         .Case("srcloc", OK_SrcLoc)
-                         .Case("dump", OK_DetailedAST)
-                         .Default(~0u);
+  bool HasIntrospection = tooling::NodeIntrospection::hasIntrospectionSupport();
+  unsigned OutKind =
+      LexOrCompleteWord<unsigned>(this, ValStr)
+          .Case("srcloc", OK_SrcLoc, /*IsCompletion=*/HasIntrospection)
   if (OutKind == ~0u) {
-    return new InvalidQuery(
-        "expected 'diag', 'print', 'detailed-ast' or 'dump', got '" + ValStr +
-        "'");
+    return new InvalidQuery("expected 'diag', 'print', 'detailed-ast'" +
+                            StringRef(HasIntrospection ? ", 'srcloc'" : "") +
+                            " or 'dump', got '" + ValStr + "'");
   }
 
   switch (OutKind) {
   case OK_DetailedAST:
     return new QueryType(&QuerySession::DetailedASTOutput);
   case OK_Diag:
     return new QueryType(&QuerySession::DiagOutput);
   case OK_Print:
     return new QueryType(&QuerySession::PrintOutput);
   case OK_SrcLoc:
+    if (HasIntrospection)
       return new QueryType(&QuerySession::SrcLocOutput);
+    return new InvalidQuery("'srcloc' output support is not available.");
   }
 
   llvm_unreachable("Invalid output kind");
 }
 
 QueryRef QueryParser::parseSetTraversalKind(TraversalKind QuerySession::*Var) {
   StringRef ValStr;
   unsigned Value =

clang-tools-extra/unittests/clang-query/QueryParserTest.cpp

 //===---- QueryParserTest.cpp - clang-query test --------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #include "QueryParser.h"
 #include "Query.h"
 #include "QuerySession.h"
+#include "clang/Tooling/NodeIntrospection.h"
 #include "llvm/LineEditor/LineEditor.h"
 #include "gtest/gtest.h"
 
 using namespace clang;
 using namespace clang::query;
 
 class QueryParserTest : public ::testing::Test {
 protected:
TEST_F(QueryParserTest, Quit) {
   ASSERT_TRUE(isa<QuitQuery>(Q));
 
   Q = parse("quit me");
   ASSERT_TRUE(isa<InvalidQuery>(Q));
   EXPECT_EQ("unexpected extra input: ' me'", cast<InvalidQuery>(Q)->ErrStr);
 }
 
 TEST_F(QueryParserTest, Set) {
+
+  bool HasIntrospection = tooling::NodeIntrospection::hasIntrospectionSupport();
   QueryRef Q = parse("set");
   ASSERT_TRUE(isa<InvalidQuery>(Q));
   EXPECT_EQ("expected variable name", cast<InvalidQuery>(Q)->ErrStr);
 
   Q = parse("set foo bar");
   ASSERT_TRUE(isa<InvalidQuery>(Q));
   EXPECT_EQ("unknown variable: 'foo'", cast<InvalidQuery>(Q)->ErrStr);
 
   Q = parse("set output");
   ASSERT_TRUE(isa<InvalidQuery>(Q));
+  if (HasIntrospection)
+    EXPECT_EQ(
+        "expected 'diag', 'print', 'detailed-ast', 'srcloc' or 'dump', got ''",
+        cast<InvalidQuery>(Q)->ErrStr);
+  else
     EXPECT_EQ("expected 'diag', 'print', 'detailed-ast' or 'dump', got ''",
               cast<InvalidQuery>(Q)->ErrStr);
 
   Q = parse("set bind-root true foo");
   ASSERT_TRUE(isa<InvalidQuery>(Q));
   EXPECT_EQ("unexpected extra input: ' foo'", cast<InvalidQuery>(Q)->ErrStr);
 
   Q = parse("set output foo");
   ASSERT_TRUE(isa<InvalidQuery>(Q));
+  if (HasIntrospection)
+    EXPECT_EQ("expected 'diag', 'print', 'detailed-ast', 'srcloc' or 'dump', "
+              "got 'foo'",
+              cast<InvalidQuery>(Q)->ErrStr);
+  else
     EXPECT_EQ("expected 'diag', 'print', 'detailed-ast' or 'dump', got 'foo'",
               cast<InvalidQuery>(Q)->ErrStr);
 
   Q = parse("set output dump");
   ASSERT_TRUE(isa<SetExclusiveOutputQuery >(Q));
   EXPECT_EQ(&QuerySession::DetailedASTOutput, cast<SetExclusiveOutputQuery>(Q)->Var);
 
   Q = parse("set output detailed-ast");
   ASSERT_TRUE(isa<SetExclusiveOutputQuery>(Q));
   EXPECT_EQ(&QuerySession::DetailedASTOutput, cast<SetExclusiveOutputQuery>(Q)->Var);
TEST_F(QueryParserTest, Complete) {
   EXPECT_EQ("raversal ", Comps[0].TypedText);
   EXPECT_EQ("traversal", Comps[0].DisplayText);
 
   Comps = QueryParser::complete("enable ", 7, QS);
   ASSERT_EQ(1u, Comps.size());
   EXPECT_EQ("output ", Comps[0].TypedText);
   EXPECT_EQ("output", Comps[0].DisplayText);
 
+  bool HasIntrospection = tooling::NodeIntrospection::hasIntrospectionSupport();
+
   Comps = QueryParser::complete("enable output ", 14, QS);
-  ASSERT_EQ(5u, Comps.size());
+  ASSERT_EQ(HasIntrospection ? 5u : 4u, Comps.size());
 
   EXPECT_EQ("diag ", Comps[0].TypedText);
   EXPECT_EQ("diag", Comps[0].DisplayText);
   EXPECT_EQ("print ", Comps[1].TypedText);
   EXPECT_EQ("print", Comps[1].DisplayText);
   EXPECT_EQ("detailed-ast ", Comps[2].TypedText);
   EXPECT_EQ("detailed-ast", Comps[2].DisplayText);
+  if (HasIntrospection) {
     EXPECT_EQ("srcloc ", Comps[3].TypedText);
     EXPECT_EQ("srcloc", Comps[3].DisplayText);
-  EXPECT_EQ("dump ", Comps[4].TypedText);
-  EXPECT_EQ("dump", Comps[4].DisplayText);
+  }
+  EXPECT_EQ("dump ", Comps[HasIntrospection ? 4 : 3].TypedText);
+  EXPECT_EQ("dump", Comps[HasIntrospection ? 4 : 3].DisplayText);
 
   Comps = QueryParser::complete("set traversal ", 14, QS);
   ASSERT_EQ(2u, Comps.size());
 
   EXPECT_EQ("AsIs ", Comps[0].TypedText);
   EXPECT_EQ("AsIs", Comps[0].DisplayText);
   EXPECT_EQ("IgnoreUnlessSpelledInSource ", Comps[1].TypedText);
   EXPECT_EQ("IgnoreUnlessSpelledInSource", Comps[1].DisplayText);