Author: malaperle Date: Tue Apr 10 10:34:46 2018 New Revision: 329725 URL: http://llvm.org/viewvc/llvm-project?rev=329725&view=rev Log: [clangd] Use operator<< to prevent printers issues in Gtest
Summary: 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, objects that were previously printed with a custom Printer now get printed through the operator<< which is declared alongside the class. This rule of the thumb should make it less error-prone. Reviewers: simark, ilya-biryukov, sammccall Reviewed By: simark, ilya-biryukov, sammccall Subscribers: bkramer, hokein, sammccall, klimek, ilya-biryukov, jkorous-apple, ioeric, MaskRay, cfe-commits Differential Revision: https://reviews.llvm.org/D44764 Modified: clang-tools-extra/trunk/clangd/Protocol.cpp clang-tools-extra/trunk/clangd/Protocol.h clang-tools-extra/trunk/unittests/clangd/CodeCompleteTests.cpp clang-tools-extra/trunk/unittests/clangd/JSONExprTests.cpp clang-tools-extra/trunk/unittests/clangd/XRefsTests.cpp Modified: clang-tools-extra/trunk/clangd/Protocol.cpp URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clangd/Protocol.cpp?rev=329725&r1=329724&r2=329725&view=diff ============================================================================== --- clang-tools-extra/trunk/clangd/Protocol.cpp (original) +++ clang-tools-extra/trunk/clangd/Protocol.cpp Tue Apr 10 10:34:46 2018 @@ -446,6 +446,11 @@ json::Expr toJSON(const CompletionItem & return std::move(Result); } +llvm::raw_ostream &operator<<(llvm::raw_ostream &O, const CompletionItem &I) { + O << I.label << " - " << toJSON(I); + return O; +} + bool operator<(const CompletionItem &L, const CompletionItem &R) { return (L.sortText.empty() ? L.label : L.sortText) < (R.sortText.empty() ? R.label : R.sortText); @@ -477,6 +482,12 @@ json::Expr toJSON(const SignatureInforma return std::move(Result); } +llvm::raw_ostream &operator<<(llvm::raw_ostream &O, + const SignatureInformation &I) { + O << I.label << " - " << toJSON(I); + return O; +} + json::Expr toJSON(const SignatureHelp &SH) { assert(SH.activeSignature >= 0 && "Unexpected negative value for number of active signatures."); @@ -502,6 +513,16 @@ json::Expr toJSON(const DocumentHighligh }; } +llvm::raw_ostream &operator<<(llvm::raw_ostream &O, + const DocumentHighlight &V) { + O << V.range; + if (V.kind == DocumentHighlightKind::Read) + O << "(r)"; + if (V.kind == DocumentHighlightKind::Write) + O << "(w)"; + return O; +} + bool fromJSON(const json::Expr &Params, DidChangeConfigurationParams &CCP) { json::ObjectMapper O(Params); return O && O.map("settings", CCP.settings); Modified: clang-tools-extra/trunk/clangd/Protocol.h URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clangd/Protocol.h?rev=329725&r1=329724&r2=329725&view=diff ============================================================================== --- clang-tools-extra/trunk/clangd/Protocol.h (original) +++ clang-tools-extra/trunk/clangd/Protocol.h Tue Apr 10 10:34:46 2018 @@ -670,6 +670,7 @@ struct CompletionItem { // between a completion and a completion resolve request. }; json::Expr toJSON(const CompletionItem &); +llvm::raw_ostream &operator<<(llvm::raw_ostream &, const CompletionItem &); bool operator<(const CompletionItem &, const CompletionItem &); @@ -708,6 +709,8 @@ struct SignatureInformation { std::vector<ParameterInformation> parameters; }; json::Expr toJSON(const SignatureInformation &); +llvm::raw_ostream &operator<<(llvm::raw_ostream &, + const SignatureInformation &); /// Represents the signature of a callable. struct SignatureHelp { @@ -761,6 +764,7 @@ struct DocumentHighlight { } }; json::Expr toJSON(const DocumentHighlight &DH); +llvm::raw_ostream &operator<<(llvm::raw_ostream &, const DocumentHighlight &); } // namespace clangd } // namespace clang Modified: clang-tools-extra/trunk/unittests/clangd/CodeCompleteTests.cpp URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/unittests/clangd/CodeCompleteTests.cpp?rev=329725&r1=329724&r2=329725&view=diff ============================================================================== --- clang-tools-extra/trunk/unittests/clangd/CodeCompleteTests.cpp (original) +++ clang-tools-extra/trunk/unittests/clangd/CodeCompleteTests.cpp Tue Apr 10 10:34:46 2018 @@ -22,33 +22,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; Modified: clang-tools-extra/trunk/unittests/clangd/JSONExprTests.cpp URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/unittests/clangd/JSONExprTests.cpp?rev=329725&r1=329724&r2=329725&view=diff ============================================================================== --- clang-tools-extra/trunk/unittests/clangd/JSONExprTests.cpp (original) +++ clang-tools-extra/trunk/unittests/clangd/JSONExprTests.cpp Tue Apr 10 10:34:46 2018 @@ -15,9 +15,7 @@ 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(); } Modified: clang-tools-extra/trunk/unittests/clangd/XRefsTests.cpp URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/unittests/clangd/XRefsTests.cpp?rev=329725&r1=329724&r2=329725&view=diff ============================================================================== --- clang-tools-extra/trunk/unittests/clangd/XRefsTests.cpp (original) +++ clang-tools-extra/trunk/unittests/clangd/XRefsTests.cpp Tue Apr 10 10:34:46 2018 @@ -24,15 +24,6 @@ namespace clang { 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; _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
