malaperle created this revision.
Herald added subscribers: cfe-commits, MaskRay, ioeric, jkorous-apple,
ilya-biryukov, klimek.
This mitigates a possible issue in tests that print objects on failure. It is
possible that there will be two different instantiations of the printer template
for a given type and some tests could end up calling the wrong (default) one.
For example, it was seen in CodeCompleteTests.cpp when printing CompletionItems
that it would use the wrong printer because the default is also instantiated in
ClangdTests.cpp.
With this change, all tests that need to use printers can include the new header
so that this issue does not occur.
Signed-off-by: Marc-Andre Laperle <marc-andre.lape...@ericsson.com>
Repository:
rCTE Clang Tools Extra
https://reviews.llvm.org/D44764
Files:
unittests/clangd/ClangdTests.cpp
unittests/clangd/ClangdUnitTests.cpp
unittests/clangd/CodeCompleteTests.cpp
unittests/clangd/CodeCompletionStringsTests.cpp
unittests/clangd/ContextTests.cpp
unittests/clangd/FileIndexTests.cpp
unittests/clangd/FuzzyMatchTests.cpp
unittests/clangd/HeadersTests.cpp
unittests/clangd/IndexTests.cpp
unittests/clangd/JSONExprTests.cpp
unittests/clangd/Matchers.h
unittests/clangd/Printers.h
unittests/clangd/SourceCodeTests.cpp
unittests/clangd/SymbolCollectorTests.cpp
unittests/clangd/TUSchedulerTests.cpp
unittests/clangd/TestFS.cpp
unittests/clangd/TraceTests.cpp
unittests/clangd/URITests.cpp
unittests/clangd/XRefsTests.cpp
Index: unittests/clangd/XRefsTests.cpp
===================================================================
--- unittests/clangd/XRefsTests.cpp
+++ unittests/clangd/XRefsTests.cpp
@@ -10,6 +10,7 @@
#include "ClangdUnit.h"
#include "Compiler.h"
#include "Matchers.h"
+#include "Printers.h"
#include "SyncAPI.h"
#include "TestFS.h"
#include "XRefs.h"
@@ -24,15 +25,6 @@
namespace clangd {
using namespace llvm;
-void PrintTo(const DocumentHighlight &V, std::ostream *O) {
- llvm::raw_os_ostream OS(*O);
- OS << V.range;
- if (V.kind == DocumentHighlightKind::Read)
- OS << "(r)";
- if (V.kind == DocumentHighlightKind::Write)
- OS << "(w)";
-}
-
namespace {
using testing::ElementsAre;
using testing::Field;
Index: unittests/clangd/URITests.cpp
===================================================================
--- unittests/clangd/URITests.cpp
+++ unittests/clangd/URITests.cpp
@@ -7,6 +7,7 @@
//
//===----------------------------------------------------------------------===//
+#include "Printers.h"
#include "TestFS.h"
#include "URI.h"
#include "gmock/gmock.h"
Index: unittests/clangd/TraceTests.cpp
===================================================================
--- unittests/clangd/TraceTests.cpp
+++ unittests/clangd/TraceTests.cpp
@@ -7,6 +7,7 @@
//
//===----------------------------------------------------------------------===//
+#include "Printers.h"
#include "Trace.h"
#include "llvm/ADT/DenseMap.h"
Index: unittests/clangd/TestFS.cpp
===================================================================
--- unittests/clangd/TestFS.cpp
+++ unittests/clangd/TestFS.cpp
@@ -7,6 +7,7 @@
//
//===----------------------------------------------------------------------===//
#include "TestFS.h"
+#include "Printers.h"
#include "llvm/Support/Errc.h"
#include "gtest/gtest.h"
Index: unittests/clangd/TUSchedulerTests.cpp
===================================================================
--- unittests/clangd/TUSchedulerTests.cpp
+++ unittests/clangd/TUSchedulerTests.cpp
@@ -8,6 +8,7 @@
//===----------------------------------------------------------------------===//
#include "Context.h"
+#include "Printers.h"
#include "TUScheduler.h"
#include "TestFS.h"
#include "gmock/gmock.h"
Index: unittests/clangd/SymbolCollectorTests.cpp
===================================================================
--- unittests/clangd/SymbolCollectorTests.cpp
+++ unittests/clangd/SymbolCollectorTests.cpp
@@ -8,6 +8,7 @@
//===----------------------------------------------------------------------===//
#include "Annotations.h"
+#include "Printers.h"
#include "TestFS.h"
#include "index/SymbolCollector.h"
#include "index/SymbolYAML.h"
Index: unittests/clangd/SourceCodeTests.cpp
===================================================================
--- unittests/clangd/SourceCodeTests.cpp
+++ unittests/clangd/SourceCodeTests.cpp
@@ -6,6 +6,7 @@
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
+#include "Printers.h"
#include "SourceCode.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/raw_os_ostream.h"
Index: unittests/clangd/Printers.h
===================================================================
--- /dev/null
+++ unittests/clangd/Printers.h
@@ -0,0 +1,77 @@
+//===-- Printers.h ----------------------------------------------*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// Custom GTest Printers. This should be included in any test that prints
+// objects on failure. Otherwise, it is possible that there will be two
+// different instantiations of the printer template for a given type and some
+// tests could end up calling the wrong (default) one.
+// See UniversalPrint::Print and UniversalPrinter::Print.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_TOOLS_EXTRA_UNITTESTS_CLANGD_PRINTERS_H
+#define LLVM_CLANG_TOOLS_EXTRA_UNITTESTS_CLANGD_PRINTERS_H
+
+#include "ClangdUnit.h"
+#include "Protocol.h"
+#include "llvm/Support/raw_os_ostream.h"
+
+namespace clang {
+namespace clangd {
+
+namespace json {
+inline void PrintTo(const Expr &E, std::ostream *OS) {
+ llvm::raw_os_ostream(*OS) << llvm::formatv("{0:2}", E);
+}
+} // namespace json
+
+inline void PrintTo(const DocumentHighlight &V, std::ostream *O) {
+ llvm::raw_os_ostream OS(*O);
+ OS << V.range;
+ if (V.kind == DocumentHighlightKind::Read)
+ OS << "(r)";
+ if (V.kind == DocumentHighlightKind::Write)
+ OS << "(w)";
+}
+
+inline void PrintTo(const CompletionItem &I, std::ostream *O) {
+ llvm::raw_os_ostream OS(*O);
+ OS << I.label << " - " << toJSON(I);
+}
+
+inline void PrintTo(const std::vector<CompletionItem> &V, std::ostream *O) {
+ *O << "{\n";
+ for (const auto &I : V) {
+ *O << "\t";
+ PrintTo(I, O);
+ *O << "\n";
+ }
+ *O << "}";
+}
+
+inline void PrintTo(const SignatureInformation &I, std::ostream *O) {
+ llvm::raw_os_ostream OS(*O);
+ OS << I.label << " - " << toJSON(I);
+}
+
+inline void PrintTo(const std::vector<SignatureInformation> &V,
+ std::ostream *O) {
+ *O << "{\n";
+ for (const auto &I : V) {
+ *O << "\t";
+ PrintTo(I, O);
+ *O << "\n";
+ }
+ *O << "}";
+}
+
+} // namespace clangd
+} // namespace clang
+
+#endif
Index: unittests/clangd/Matchers.h
===================================================================
--- unittests/clangd/Matchers.h
+++ unittests/clangd/Matchers.h
@@ -13,6 +13,7 @@
#ifndef LLVM_CLANG_TOOLS_EXTRA_UNITTESTS_CLANGD_MATCHERS_H
#define LLVM_CLANG_TOOLS_EXTRA_UNITTESTS_CLANGD_MATCHERS_H
+#include "Printers.h"
#include "Protocol.h"
#include "gmock/gmock.h"
Index: unittests/clangd/JSONExprTests.cpp
===================================================================
--- unittests/clangd/JSONExprTests.cpp
+++ unittests/clangd/JSONExprTests.cpp
@@ -8,16 +8,13 @@
//===----------------------------------------------------------------------===//
#include "JSONExpr.h"
-
+#include "Printers.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
namespace clang {
namespace clangd {
namespace json {
-void PrintTo(const Expr &E, std::ostream *OS) {
- llvm::raw_os_ostream(*OS) << llvm::formatv("{0:2}", E);
-}
namespace {
std::string s(const Expr &E) { return llvm::formatv("{0}", E).str(); }
Index: unittests/clangd/IndexTests.cpp
===================================================================
--- unittests/clangd/IndexTests.cpp
+++ unittests/clangd/IndexTests.cpp
@@ -7,6 +7,7 @@
//
//===----------------------------------------------------------------------===//
+#include "Printers.h"
#include "index/Index.h"
#include "index/MemIndex.h"
#include "index/Merge.h"
Index: unittests/clangd/HeadersTests.cpp
===================================================================
--- unittests/clangd/HeadersTests.cpp
+++ unittests/clangd/HeadersTests.cpp
@@ -8,6 +8,7 @@
//===----------------------------------------------------------------------===//
#include "Headers.h"
+#include "Printers.h"
#include "TestFS.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
Index: unittests/clangd/FuzzyMatchTests.cpp
===================================================================
--- unittests/clangd/FuzzyMatchTests.cpp
+++ unittests/clangd/FuzzyMatchTests.cpp
@@ -8,6 +8,7 @@
//===----------------------------------------------------------------------===//
#include "FuzzyMatch.h"
+#include "Printers.h"
#include "llvm/ADT/StringExtras.h"
#include "gmock/gmock.h"
Index: unittests/clangd/FileIndexTests.cpp
===================================================================
--- unittests/clangd/FileIndexTests.cpp
+++ unittests/clangd/FileIndexTests.cpp
@@ -7,6 +7,7 @@
//
//===----------------------------------------------------------------------===//
+#include "Printers.h"
#include "TestFS.h"
#include "index/FileIndex.h"
#include "clang/Frontend/CompilerInvocation.h"
Index: unittests/clangd/ContextTests.cpp
===================================================================
--- unittests/clangd/ContextTests.cpp
+++ unittests/clangd/ContextTests.cpp
@@ -8,6 +8,7 @@
//===----------------------------------------------------------------------===//
#include "Context.h"
+#include "Printers.h"
#include "gtest/gtest.h"
Index: unittests/clangd/CodeCompletionStringsTests.cpp
===================================================================
--- unittests/clangd/CodeCompletionStringsTests.cpp
+++ unittests/clangd/CodeCompletionStringsTests.cpp
@@ -8,6 +8,7 @@
//===----------------------------------------------------------------------===//
#include "CodeCompletionStrings.h"
+#include "Printers.h"
#include "clang/Sema/CodeCompleteConsumer.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
Index: unittests/clangd/CodeCompleteTests.cpp
===================================================================
--- unittests/clangd/CodeCompleteTests.cpp
+++ unittests/clangd/CodeCompleteTests.cpp
@@ -12,6 +12,7 @@
#include "CodeComplete.h"
#include "Compiler.h"
#include "Matchers.h"
+#include "Printers.h"
#include "Protocol.h"
#include "SourceCode.h"
#include "SyncAPI.h"
@@ -22,33 +23,6 @@
namespace clang {
namespace clangd {
-// Let GMock print completion items and signature help.
-void PrintTo(const CompletionItem &I, std::ostream *O) {
- llvm::raw_os_ostream OS(*O);
- OS << I.label << " - " << toJSON(I);
-}
-void PrintTo(const std::vector<CompletionItem> &V, std::ostream *O) {
- *O << "{\n";
- for (const auto &I : V) {
- *O << "\t";
- PrintTo(I, O);
- *O << "\n";
- }
- *O << "}";
-}
-void PrintTo(const SignatureInformation &I, std::ostream *O) {
- llvm::raw_os_ostream OS(*O);
- OS << I.label << " - " << toJSON(I);
-}
-void PrintTo(const std::vector<SignatureInformation> &V, std::ostream *O) {
- *O << "{\n";
- for (const auto &I : V) {
- *O << "\t";
- PrintTo(I, O);
- *O << "\n";
- }
- *O << "}";
-}
namespace {
using namespace llvm;
Index: unittests/clangd/ClangdUnitTests.cpp
===================================================================
--- unittests/clangd/ClangdUnitTests.cpp
+++ unittests/clangd/ClangdUnitTests.cpp
@@ -9,6 +9,7 @@
#include "Annotations.h"
#include "ClangdUnit.h"
+#include "Printers.h"
#include "TestFS.h"
#include "clang/Frontend/CompilerInvocation.h"
#include "clang/Frontend/PCHContainerOperations.h"
Index: unittests/clangd/ClangdTests.cpp
===================================================================
--- unittests/clangd/ClangdTests.cpp
+++ unittests/clangd/ClangdTests.cpp
@@ -11,6 +11,7 @@
#include "ClangdLSPServer.h"
#include "ClangdServer.h"
#include "Matchers.h"
+#include "Printers.h"
#include "SyncAPI.h"
#include "TestFS.h"
#include "URI.h"
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
