From 78137914306f0b549d887d0066b882edff527b8a Mon Sep 17 00:00:00 2001 From: Dmitri Gribenko Date: Thu, 27 Mar 2014 15:40:39 +0000 Subject: [PATCH] Comment parsing: when comment ranges are deserialized from multiple modules, correctly order comments in SourceManager::isBeforeInTranslationUnit() order Unfortunately, this is not as simple as it was implemented previously, and actually requires doing a merge sort. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@204936 91177308-0d34-0410-b5e6-96231b3b80d8 --- include/clang/AST/RawCommentList.h | 4 +- lib/AST/ASTContext.cpp | 7 ++++ lib/AST/RawCommentList.cpp | 12 ++++++ lib/Serialization/ASTReader.cpp | 7 ++-- .../Headers/DocCommentsA.h | 8 ++++ .../Headers/DocCommentsB.h | 7 ++++ .../Headers/DocCommentsC.h | 2 + test/Index/annotate-comments-objc.m | 39 +++++++++++++------ 8 files changed, 68 insertions(+), 18 deletions(-) create mode 100644 test/Index/Inputs/Frameworks/DocCommentsA.framework/Headers/DocCommentsA.h create mode 100644 test/Index/Inputs/Frameworks/DocCommentsB.framework/Headers/DocCommentsB.h create mode 100644 test/Index/Inputs/Frameworks/DocCommentsC.framework/Headers/DocCommentsC.h diff --git a/include/clang/AST/RawCommentList.h b/include/clang/AST/RawCommentList.h index a4fcc108eb..8ba85c43f6 100644 --- a/include/clang/AST/RawCommentList.h +++ b/include/clang/AST/RawCommentList.h @@ -193,9 +193,7 @@ private: SourceManager &SourceMgr; std::vector Comments; - void addCommentsToFront(const std::vector &C) { - Comments.insert(Comments.begin(), C.begin(), C.end()); - } + void addDeserializedComments(ArrayRef DeserializedComments); friend class ASTReader; }; diff --git a/lib/AST/ASTContext.cpp b/lib/AST/ASTContext.cpp index c02150a6bc..1e55521b87 100644 --- a/lib/AST/ASTContext.cpp +++ b/lib/AST/ASTContext.cpp @@ -63,6 +63,13 @@ enum FloatingRank { RawComment *ASTContext::getRawCommentForDeclNoCache(const Decl *D) const { if (!CommentsLoaded && ExternalSource) { ExternalSource->ReadComments(); + +#ifndef NDEBUG + ArrayRef RawComments = Comments.getComments(); + assert(std::is_sorted(RawComments.begin(), RawComments.end(), + BeforeThanCompare(SourceMgr))); +#endif + CommentsLoaded = true; } diff --git a/lib/AST/RawCommentList.cpp b/lib/AST/RawCommentList.cpp index 586c076542..24b129a5c5 100644 --- a/lib/AST/RawCommentList.cpp +++ b/lib/AST/RawCommentList.cpp @@ -251,3 +251,15 @@ void RawCommentList::addComment(const RawComment &RC, Comments.push_back(new (Allocator) RawComment(RC)); } } + +void RawCommentList::addDeserializedComments(ArrayRef DeserializedComments) { + std::vector MergedComments; + MergedComments.reserve(Comments.size() + DeserializedComments.size()); + + std::merge(Comments.begin(), Comments.end(), + DeserializedComments.begin(), DeserializedComments.end(), + std::back_inserter(MergedComments), + BeforeThanCompare(SourceMgr)); + std::swap(Comments, MergedComments); +} + diff --git a/lib/Serialization/ASTReader.cpp b/lib/Serialization/ASTReader.cpp index fc8c030833..311a403f44 100644 --- a/lib/Serialization/ASTReader.cpp +++ b/lib/Serialization/ASTReader.cpp @@ -7688,6 +7688,7 @@ void ASTReader::ReadComments() { I = CommentsCursors.begin(), E = CommentsCursors.end(); I != E; ++I) { + Comments.clear(); BitstreamCursor &Cursor = I->first; serialization::ModuleFile &F = *I->second; SavedStreamPosition SavedPosition(Cursor); @@ -7696,7 +7697,7 @@ void ASTReader::ReadComments() { while (true) { llvm::BitstreamEntry Entry = Cursor.advanceSkippingSubblocks(BitstreamCursor::AF_DontPopBlockAtEnd); - + switch (Entry.Kind) { case llvm::BitstreamEntry::SubBlock: // Handled for us already. case llvm::BitstreamEntry::Error: @@ -7726,9 +7727,9 @@ void ASTReader::ReadComments() { } } } - NextCursor:; + NextCursor: + Context.Comments.addDeserializedComments(Comments); } - Context.Comments.addCommentsToFront(Comments); } void ASTReader::finishPendingActions() { diff --git a/test/Index/Inputs/Frameworks/DocCommentsA.framework/Headers/DocCommentsA.h b/test/Index/Inputs/Frameworks/DocCommentsA.framework/Headers/DocCommentsA.h new file mode 100644 index 0000000000..d548f8196d --- /dev/null +++ b/test/Index/Inputs/Frameworks/DocCommentsA.framework/Headers/DocCommentsA.h @@ -0,0 +1,8 @@ +/// Comment for 'functionFromDocCommentsA1'. +void functionFromDocCommentsA1(void); + +#import + +/// Comment for 'functionFromDocCommentsA2'. +void functionFromDocCommentsA2(void); + diff --git a/test/Index/Inputs/Frameworks/DocCommentsB.framework/Headers/DocCommentsB.h b/test/Index/Inputs/Frameworks/DocCommentsB.framework/Headers/DocCommentsB.h new file mode 100644 index 0000000000..af279e3ce5 --- /dev/null +++ b/test/Index/Inputs/Frameworks/DocCommentsB.framework/Headers/DocCommentsB.h @@ -0,0 +1,7 @@ +/// Comment for 'functionFromDocCommentsB1'. +void functionFromDocCommentsB1(void); + +#import + +/// Comment for 'functionFromDocCommentsB2'. +void functionFromDocCommentsB2(void); diff --git a/test/Index/Inputs/Frameworks/DocCommentsC.framework/Headers/DocCommentsC.h b/test/Index/Inputs/Frameworks/DocCommentsC.framework/Headers/DocCommentsC.h new file mode 100644 index 0000000000..db696a385e --- /dev/null +++ b/test/Index/Inputs/Frameworks/DocCommentsC.framework/Headers/DocCommentsC.h @@ -0,0 +1,2 @@ +/// Comment for 'functionFromDocCommentsC'. +void functionFromDocCommentsC(void); diff --git a/test/Index/annotate-comments-objc.m b/test/Index/annotate-comments-objc.m index e778d6c65e..600b6f907c 100644 --- a/test/Index/annotate-comments-objc.m +++ b/test/Index/annotate-comments-objc.m @@ -3,6 +3,12 @@ #ifndef HEADER #define HEADER +/// Comment for 'functionBeforeImports'. +void functionBeforeImports(void); + +#import +#import + @class NSString; //===--- @@ -33,13 +39,15 @@ // RUN: mkdir %t // Check that we serialize comment source locations properly. -// RUN: %clang_cc1 -emit-pch -o %t/out.pch %s -// RUN: %clang_cc1 -include-pch %t/out.pch -fsyntax-only %s +// RUN: %clang_cc1 -emit-pch -o %t/out.pch -F %S/Inputs/Frameworks %s +// RUN: %clang_cc1 -include-pch %t/out.pch -F %S/Inputs/Frameworks -fsyntax-only %s -// RUN: c-index-test -test-load-source all -comments-xml-schema=%S/../../bindings/xml/comment-xml-schema.rng %s > %t/out.c-index-direct -// RUN: c-index-test -test-load-tu %t/out.pch all > %t/out.c-index-pch +// RUN: c-index-test -test-load-source all -comments-xml-schema=%S/../../bindings/xml/comment-xml-schema.rng %s -F %S/Inputs/Frameworks > %t/out.c-index-direct +// RUN: c-index-test -test-load-source all -comments-xml-schema=%S/../../bindings/xml/comment-xml-schema.rng %s -F %S/Inputs/Frameworks -fmodules > %t/out.c-index-modules +// RUN: c-index-test -test-load-tu %t/out.pch all -F %S/Inputs/Frameworks > %t/out.c-index-pch // RUN: FileCheck %s -check-prefix=WRONG < %t/out.c-index-direct +// RUN: FileCheck %s -check-prefix=WRONG < %t/out.c-index-modules // RUN: FileCheck %s -check-prefix=WRONG < %t/out.c-index-pch // Declarations without Doxygen comments should not pick up some Doxygen comments. @@ -60,6 +68,7 @@ // WRONG-NOT: CommentXMLInvalid // RUN: FileCheck %s < %t/out.c-index-direct +// RUN: FileCheck %s < %t/out.c-index-modules // RUN: FileCheck %s < %t/out.c-index-pch // These CHECK lines are not located near the code on purpose. This test @@ -67,12 +76,18 @@ // Adding a non-documentation comment with CHECK line between every two // documentation comments will only test a single code path. // -// CHECK: annotate-comments-objc.m:17:50: ObjCPropertyDecl=property1_isdoxy1:{{.*}} property1_isdoxy1 IS_DOXYGEN_SINGLE -// CHECK: annotate-comments-objc.m:18:50: ObjCPropertyDecl=property1_isdoxy2:{{.*}} property1_isdoxy2 IS_DOXYGEN_SINGLE -// CHECK: annotate-comments-objc.m:19:50: ObjCPropertyDecl=property1_isdoxy3:{{.*}} property1_isdoxy3 IS_DOXYGEN_SINGLE -// CHECK: annotate-comments-objc.m:20:50: ObjCPropertyDecl=property1_isdoxy4:{{.*}} property1_isdoxy4 IS_DOXYGEN_SINGLE -// CHECK: annotate-comments-objc.m:23:9: ObjCInstanceMethodDecl=method1_isdoxy1:{{.*}} method1_isdoxy1 IS_DOXYGEN_SINGLE -// CHECK: annotate-comments-objc.m:24:9: ObjCInstanceMethodDecl=method1_isdoxy2:{{.*}} method1_isdoxy2 IS_DOXYGEN_SINGLE -// CHECK: annotate-comments-objc.m:25:9: ObjCInstanceMethodDecl=method1_isdoxy3:{{.*}} method1_isdoxy3 IS_DOXYGEN_SINGLE -// CHECK: annotate-comments-objc.m:26:9: ObjCInstanceMethodDecl=method1_isdoxy4:{{.*}} method1_isdoxy4 IS_DOXYGEN_SINGLE +// CHECK-DAG: annotate-comments-objc.m:7:6: FunctionDecl=functionBeforeImports:{{.*}} BriefComment=[Comment for 'functionBeforeImports'.] +// CHECK-DAG: DocCommentsA.h:2:6: FunctionDecl=functionFromDocCommentsA1:{{.*}} BriefComment=[Comment for 'functionFromDocCommentsA1'.] +// CHECK-DAG: DocCommentsA.h:7:6: FunctionDecl=functionFromDocCommentsA2:{{.*}} BriefComment=[Comment for 'functionFromDocCommentsA2'.] +// CHECK-DAG: DocCommentsB.h:2:6: FunctionDecl=functionFromDocCommentsB1:{{.*}} BriefComment=[Comment for 'functionFromDocCommentsB1'.] +// CHECK-DAG: DocCommentsB.h:7:6: FunctionDecl=functionFromDocCommentsB2:{{.*}} BriefComment=[Comment for 'functionFromDocCommentsB2'.] +// CHECK-DAG: DocCommentsC.h:2:6: FunctionDecl=functionFromDocCommentsC:{{.*}} BriefComment=[Comment for 'functionFromDocCommentsC'.] +// CHECK: annotate-comments-objc.m:23:50: ObjCPropertyDecl=property1_isdoxy1:{{.*}} property1_isdoxy1 IS_DOXYGEN_SINGLE +// CHECK: annotate-comments-objc.m:24:50: ObjCPropertyDecl=property1_isdoxy2:{{.*}} property1_isdoxy2 IS_DOXYGEN_SINGLE +// CHECK: annotate-comments-objc.m:25:50: ObjCPropertyDecl=property1_isdoxy3:{{.*}} property1_isdoxy3 IS_DOXYGEN_SINGLE +// CHECK: annotate-comments-objc.m:26:50: ObjCPropertyDecl=property1_isdoxy4:{{.*}} property1_isdoxy4 IS_DOXYGEN_SINGLE +// CHECK: annotate-comments-objc.m:29:9: ObjCInstanceMethodDecl=method1_isdoxy1:{{.*}} method1_isdoxy1 IS_DOXYGEN_SINGLE +// CHECK: annotate-comments-objc.m:30:9: ObjCInstanceMethodDecl=method1_isdoxy2:{{.*}} method1_isdoxy2 IS_DOXYGEN_SINGLE +// CHECK: annotate-comments-objc.m:31:9: ObjCInstanceMethodDecl=method1_isdoxy3:{{.*}} method1_isdoxy3 IS_DOXYGEN_SINGLE +// CHECK: annotate-comments-objc.m:32:9: ObjCInstanceMethodDecl=method1_isdoxy4:{{.*}} method1_isdoxy4 IS_DOXYGEN_SINGLE -- 2.40.0