//===-- clang-doc/YAMLGeneratorTest.cpp //------------------------------------===// // // 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 "ClangDocTest.h" #include "Generators.h" #include "Representation.h" #include "gtest/gtest.h" namespace clang { namespace doc { std::unique_ptr getYAMLGenerator() { auto G = doc::findGeneratorByName("yaml"); if (!G) return nullptr; return std::move(G.get()); } TEST(YAMLGeneratorTest, emitNamespaceYAML) { NamespaceInfo I; I.Name = "Namespace"; I.Path = "path/to/A"; I.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace); I.ChildNamespaces.emplace_back(EmptySID, "ChildNamespace", InfoType::IT_namespace, "path/to/A/Namespace"); I.ChildRecords.emplace_back(EmptySID, "ChildStruct", InfoType::IT_record, "path/to/A/Namespace"); I.ChildFunctions.emplace_back(); I.ChildFunctions.back().Name = "OneFunction"; I.ChildFunctions.back().Access = AccessSpecifier::AS_none; I.ChildEnums.emplace_back(); I.ChildEnums.back().Name = "OneEnum"; auto G = getYAMLGenerator(); assert(G); std::string Buffer; llvm::raw_string_ostream Actual(Buffer); auto Err = G->generateDocForInfo(&I, Actual, ClangDocContext()); assert(!Err); std::string Expected = R"raw(--- USR: '0000000000000000000000000000000000000000' Name: 'Namespace' Path: 'path/to/A' Namespace: - Type: Namespace Name: 'A' ChildNamespaces: - Type: Namespace Name: 'ChildNamespace' Path: 'path/to/A/Namespace' ChildRecords: - Type: Record Name: 'ChildStruct' Path: 'path/to/A/Namespace' ChildFunctions: - USR: '0000000000000000000000000000000000000000' Name: 'OneFunction' ReturnType: {} ChildEnums: - USR: '0000000000000000000000000000000000000000' Name: 'OneEnum' ... )raw"; EXPECT_EQ(Expected, Actual.str()); } TEST(YAMLGeneratorTest, emitRecordYAML) { RecordInfo I; I.Name = "r"; I.Path = "path/to/A"; I.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace); I.DefLoc = Location(10, llvm::SmallString<16>{"test.cpp"}); I.Loc.emplace_back(12, llvm::SmallString<16>{"test.cpp"}); I.Members.emplace_back("int", "path/to/int", "X", AccessSpecifier::AS_private); I.TagType = TagTypeKind::TTK_Class; I.Bases.emplace_back(EmptySID, "F", "path/to/F", true, AccessSpecifier::AS_public, true); I.Bases.back().ChildFunctions.emplace_back(); I.Bases.back().ChildFunctions.back().Name = "InheritedFunctionOne"; I.Bases.back().Members.emplace_back("int", "path/to/int", "N", AccessSpecifier::AS_private); // F is in the global namespace I.Parents.emplace_back(EmptySID, "F", InfoType::IT_record, ""); I.VirtualParents.emplace_back(EmptySID, "G", InfoType::IT_record, "path/to/G"); I.ChildRecords.emplace_back(EmptySID, "ChildStruct", InfoType::IT_record, "path/to/A/r"); I.ChildFunctions.emplace_back(); I.ChildFunctions.back().Name = "OneFunction"; I.ChildEnums.emplace_back(); I.ChildEnums.back().Name = "OneEnum"; auto G = getYAMLGenerator(); assert(G); std::string Buffer; llvm::raw_string_ostream Actual(Buffer); auto Err = G->generateDocForInfo(&I, Actual, ClangDocContext()); assert(!Err); std::string Expected = R"raw(--- USR: '0000000000000000000000000000000000000000' Name: 'r' Path: 'path/to/A' Namespace: - Type: Namespace Name: 'A' DefLocation: LineNumber: 10 Filename: 'test.cpp' Location: - LineNumber: 12 Filename: 'test.cpp' TagType: Class Members: - Type: Name: 'int' Path: 'path/to/int' Name: 'X' Access: Private Bases: - USR: '0000000000000000000000000000000000000000' Name: 'F' Path: 'path/to/F' Members: - Type: Name: 'int' Path: 'path/to/int' Name: 'N' Access: Private ChildFunctions: - USR: '0000000000000000000000000000000000000000' Name: 'InheritedFunctionOne' ReturnType: {} Access: Public IsVirtual: true Access: Public IsParent: true Parents: - Type: Record Name: 'F' IsInGlobalNamespace: true VirtualParents: - Type: Record Name: 'G' Path: 'path/to/G' ChildRecords: - Type: Record Name: 'ChildStruct' Path: 'path/to/A/r' ChildFunctions: - USR: '0000000000000000000000000000000000000000' Name: 'OneFunction' ReturnType: {} Access: Public ChildEnums: - USR: '0000000000000000000000000000000000000000' Name: 'OneEnum' ... )raw"; EXPECT_EQ(Expected, Actual.str()); } TEST(YAMLGeneratorTest, emitFunctionYAML) { FunctionInfo I; I.Name = "f"; I.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace); I.DefLoc = Location(10, llvm::SmallString<16>{"test.cpp"}); I.Loc.emplace_back(12, llvm::SmallString<16>{"test.cpp"}); I.Access = AccessSpecifier::AS_none; I.ReturnType = TypeInfo(EmptySID, "void", InfoType::IT_default, "path/to/void"); I.Params.emplace_back("int", "path/to/int", "P"); I.IsMethod = true; I.Parent = Reference(EmptySID, "Parent", InfoType::IT_record); auto G = getYAMLGenerator(); assert(G); std::string Buffer; llvm::raw_string_ostream Actual(Buffer); auto Err = G->generateDocForInfo(&I, Actual, ClangDocContext()); assert(!Err); std::string Expected = R"raw(--- USR: '0000000000000000000000000000000000000000' Name: 'f' Namespace: - Type: Namespace Name: 'A' DefLocation: LineNumber: 10 Filename: 'test.cpp' Location: - LineNumber: 12 Filename: 'test.cpp' IsMethod: true Parent: Type: Record Name: 'Parent' Params: - Type: Name: 'int' Path: 'path/to/int' Name: 'P' ReturnType: Type: Name: 'void' Path: 'path/to/void' ... )raw"; EXPECT_EQ(Expected, Actual.str()); } TEST(YAMLGeneratorTest, emitEnumYAML) { EnumInfo I; I.Name = "e"; I.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace); I.DefLoc = Location(10, llvm::SmallString<16>{"test.cpp"}); I.Loc.emplace_back(12, llvm::SmallString<16>{"test.cpp"}); I.Members.emplace_back("X"); I.Scoped = true; auto G = getYAMLGenerator(); assert(G); std::string Buffer; llvm::raw_string_ostream Actual(Buffer); auto Err = G->generateDocForInfo(&I, Actual, ClangDocContext()); assert(!Err); std::string Expected = R"raw(--- USR: '0000000000000000000000000000000000000000' Name: 'e' Namespace: - Type: Namespace Name: 'A' DefLocation: LineNumber: 10 Filename: 'test.cpp' Location: - LineNumber: 12 Filename: 'test.cpp' Scoped: true Members: - 'X' ... )raw"; EXPECT_EQ(Expected, Actual.str()); } TEST(YAMLGeneratorTest, emitCommentYAML) { FunctionInfo I; I.Name = "f"; I.DefLoc = Location(10, llvm::SmallString<16>{"test.cpp"}); I.ReturnType = TypeInfo(EmptySID, "void", InfoType::IT_default); I.Params.emplace_back("int", "I"); I.Params.emplace_back("int", "J"); I.Access = AccessSpecifier::AS_none; CommentInfo Top; Top.Kind = "FullComment"; Top.Children.emplace_back(std::make_unique()); CommentInfo *BlankLine = Top.Children.back().get(); BlankLine->Kind = "ParagraphComment"; BlankLine->Children.emplace_back(std::make_unique()); BlankLine->Children.back()->Kind = "TextComment"; Top.Children.emplace_back(std::make_unique()); CommentInfo *Brief = Top.Children.back().get(); Brief->Kind = "ParagraphComment"; Brief->Children.emplace_back(std::make_unique()); Brief->Children.back()->Kind = "TextComment"; Brief->Children.back()->Name = "ParagraphComment"; Brief->Children.back()->Text = " Brief description."; Top.Children.emplace_back(std::make_unique()); CommentInfo *Extended = Top.Children.back().get(); Extended->Kind = "ParagraphComment"; Extended->Children.emplace_back(std::make_unique()); Extended->Children.back()->Kind = "TextComment"; Extended->Children.back()->Text = " Extended description that"; Extended->Children.emplace_back(std::make_unique()); Extended->Children.back()->Kind = "TextComment"; Extended->Children.back()->Text = " continues onto the next line."; Top.Children.emplace_back(std::make_unique()); CommentInfo *HTML = Top.Children.back().get(); HTML->Kind = "ParagraphComment"; HTML->Children.emplace_back(std::make_unique()); HTML->Children.back()->Kind = "TextComment"; HTML->Children.emplace_back(std::make_unique()); HTML->Children.back()->Kind = "HTMLStartTagComment"; HTML->Children.back()->Name = "ul"; HTML->Children.back()->AttrKeys.emplace_back("class"); HTML->Children.back()->AttrValues.emplace_back("test"); HTML->Children.emplace_back(std::make_unique()); HTML->Children.back()->Kind = "HTMLStartTagComment"; HTML->Children.back()->Name = "li"; HTML->Children.emplace_back(std::make_unique()); HTML->Children.back()->Kind = "TextComment"; HTML->Children.back()->Text = " Testing."; HTML->Children.emplace_back(std::make_unique()); HTML->Children.back()->Kind = "HTMLEndTagComment"; HTML->Children.back()->Name = "ul"; HTML->Children.back()->SelfClosing = true; Top.Children.emplace_back(std::make_unique()); CommentInfo *Verbatim = Top.Children.back().get(); Verbatim->Kind = "VerbatimBlockComment"; Verbatim->Name = "verbatim"; Verbatim->CloseName = "endverbatim"; Verbatim->Children.emplace_back(std::make_unique()); Verbatim->Children.back()->Kind = "VerbatimBlockLineComment"; Verbatim->Children.back()->Text = " The description continues."; Top.Children.emplace_back(std::make_unique()); CommentInfo *ParamOut = Top.Children.back().get(); ParamOut->Kind = "ParamCommandComment"; ParamOut->Direction = "[out]"; ParamOut->ParamName = "I"; ParamOut->Explicit = true; ParamOut->Children.emplace_back(std::make_unique()); ParamOut->Children.back()->Kind = "ParagraphComment"; ParamOut->Children.back()->Children.emplace_back( std::make_unique()); ParamOut->Children.back()->Children.back()->Kind = "TextComment"; ParamOut->Children.back()->Children.emplace_back( std::make_unique()); ParamOut->Children.back()->Children.back()->Kind = "TextComment"; ParamOut->Children.back()->Children.back()->Text = " is a parameter."; Top.Children.emplace_back(std::make_unique()); CommentInfo *ParamIn = Top.Children.back().get(); ParamIn->Kind = "ParamCommandComment"; ParamIn->Direction = "[in]"; ParamIn->ParamName = "J"; ParamIn->Children.emplace_back(std::make_unique()); ParamIn->Children.back()->Kind = "ParagraphComment"; ParamIn->Children.back()->Children.emplace_back( std::make_unique()); ParamIn->Children.back()->Children.back()->Kind = "TextComment"; ParamIn->Children.back()->Children.back()->Text = " is a parameter."; ParamIn->Children.back()->Children.emplace_back( std::make_unique()); ParamIn->Children.back()->Children.back()->Kind = "TextComment"; Top.Children.emplace_back(std::make_unique()); CommentInfo *Return = Top.Children.back().get(); Return->Kind = "BlockCommandComment"; Return->Name = "return"; Return->Explicit = true; Return->Children.emplace_back(std::make_unique()); Return->Children.back()->Kind = "ParagraphComment"; Return->Children.back()->Children.emplace_back( std::make_unique()); Return->Children.back()->Children.back()->Kind = "TextComment"; Return->Children.back()->Children.back()->Text = "void"; I.Description.emplace_back(std::move(Top)); auto G = getYAMLGenerator(); assert(G); std::string Buffer; llvm::raw_string_ostream Actual(Buffer); auto Err = G->generateDocForInfo(&I, Actual, ClangDocContext()); assert(!Err); std::string Expected = R"raw(--- USR: '0000000000000000000000000000000000000000' Name: 'f' Description: - Kind: 'FullComment' Children: - Kind: 'ParagraphComment' Children: - Kind: 'TextComment' - Kind: 'ParagraphComment' Children: - Kind: 'TextComment' Text: ' Brief description.' Name: 'ParagraphComment' - Kind: 'ParagraphComment' Children: - Kind: 'TextComment' Text: ' Extended description that' - Kind: 'TextComment' Text: ' continues onto the next line.' - Kind: 'ParagraphComment' Children: - Kind: 'TextComment' - Kind: 'HTMLStartTagComment' Name: 'ul' AttrKeys: - 'class' AttrValues: - 'test' - Kind: 'HTMLStartTagComment' Name: 'li' - Kind: 'TextComment' Text: ' Testing.' - Kind: 'HTMLEndTagComment' Name: 'ul' SelfClosing: true - Kind: 'VerbatimBlockComment' Name: 'verbatim' CloseName: 'endverbatim' Children: - Kind: 'VerbatimBlockLineComment' Text: ' The description continues.' - Kind: 'ParamCommandComment' Direction: '[out]' ParamName: 'I' Explicit: true Children: - Kind: 'ParagraphComment' Children: - Kind: 'TextComment' - Kind: 'TextComment' Text: ' is a parameter.' - Kind: 'ParamCommandComment' Direction: '[in]' ParamName: 'J' Children: - Kind: 'ParagraphComment' Children: - Kind: 'TextComment' Text: ' is a parameter.' - Kind: 'TextComment' - Kind: 'BlockCommandComment' Name: 'return' Explicit: true Children: - Kind: 'ParagraphComment' Children: - Kind: 'TextComment' Text: 'void' DefLocation: LineNumber: 10 Filename: 'test.cpp' Params: - Type: Name: 'int' Name: 'I' - Type: Name: 'int' Name: 'J' ReturnType: Type: Name: 'void' ... )raw"; EXPECT_EQ(Expected, Actual.str()); } } // namespace doc } // namespace clang