From d4397b99e2fcb189002d04410d7c3bf85ab4bba3 Mon Sep 17 00:00:00 2001 From: Manuel Klimek Date: Fri, 4 Jan 2013 23:34:14 +0000 Subject: [PATCH] Various fixes to clang-format's macro handling. Some of this is still pretty rough (note the load of FIXMEs), but it is strictly an improvement and fixes various bugs that were related to macro processing but are also imporant in non-macro use cases. Specific fixes: - correctly puts espaced newlines at the end of the line - fixes counting of white space before a token when escaped newlines are present - fixes parsing of "trailing" tokens when eof() is hit - puts macro parsing orthogonal to parsing other structure - general support for parsing of macro definitions Due to the fix to format trailing tokens, this change also includes a bunch of fixes to the c-index tests. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@171556 91177308-0d34-0410-b5e6-96231b3b80d8 --- lib/Format/Format.cpp | 59 ++++++--- lib/Format/UnwrappedLineParser.cpp | 113 +++++++++++++++--- lib/Format/UnwrappedLineParser.h | 6 +- test/Index/comment-c-decls.c | 2 +- test/Index/comment-objc-decls.m | 8 +- test/Index/comment-to-html-xml-conversion.cpp | 10 +- test/Index/format-comment-cdecls.c | 2 +- test/Index/overriding-ftemplate-comments.cpp | 16 +-- unittests/Format/FormatTest.cpp | 87 ++++++++++---- 9 files changed, 232 insertions(+), 71 deletions(-) diff --git a/lib/Format/Format.cpp b/lib/Format/Format.cpp index 7f40e35e1d..effe0bc248 100644 --- a/lib/Format/Format.cpp +++ b/lib/Format/Format.cpp @@ -91,16 +91,22 @@ class UnwrappedLineFormatter { public: UnwrappedLineFormatter(const FormatStyle &Style, SourceManager &SourceMgr, const UnwrappedLine &Line, + unsigned PreviousEndOfLineColumn, const std::vector &Annotations, tooling::Replacements &Replaces, bool StructuralError) : Style(Style), SourceMgr(SourceMgr), Line(Line), + PreviousEndOfLineColumn(PreviousEndOfLineColumn), Annotations(Annotations), Replaces(Replaces), StructuralError(StructuralError) { Parameters.PenaltyIndentLevel = 15; Parameters.PenaltyLevelDecrease = 10; } - void format() { + /// \brief Formats an \c UnwrappedLine. + /// + /// \returns The column after the last token in the last line of the + /// \c UnwrappedLine. + unsigned format() { // Format first token and initialize indent. unsigned Indent = formatFirstToken(); @@ -146,6 +152,7 @@ public: addTokenToState(Break < NoBreak, false, State); } } + return State.Column; } private: @@ -487,14 +494,14 @@ private: if (!Line.InPPDirective || Token.HasUnescapedNewline) replaceWhitespace(Token, Newlines, Indent); else - // FIXME: Figure out how to get the previous end-of-line column. - replacePPWhitespace(Token, Newlines, Indent, 0); + replacePPWhitespace(Token, Newlines, Indent, PreviousEndOfLineColumn); return Indent; } FormatStyle Style; SourceManager &SourceMgr; const UnwrappedLine &Line; + const unsigned PreviousEndOfLineColumn; const std::vector &Annotations; tooling::Replacements &Replaces; bool StructuralError; @@ -1024,11 +1031,11 @@ public: FormatTok = FormatToken(); Lex.LexFromRawLexer(FormatTok.Tok); + StringRef Text = tokenText(FormatTok.Tok); FormatTok.WhiteSpaceStart = FormatTok.Tok.getLocation(); // Consume and record whitespace until we find a significant token. while (FormatTok.Tok.is(tok::unknown)) { - StringRef Text = tokenText(FormatTok.Tok); FormatTok.NewlinesBefore += Text.count('\n'); FormatTok.HasUnescapedNewline = Text.count("\\\n") != FormatTok.NewlinesBefore; @@ -1037,10 +1044,22 @@ public: if (FormatTok.Tok.is(tok::eof)) return FormatTok; Lex.LexFromRawLexer(FormatTok.Tok); + Text = tokenText(FormatTok.Tok); + } + // In case the token starts with escaped newlines, we want to + // take them into account as whitespace - this pattern is quite frequent + // in macro definitions. + // FIXME: What do we want to do with other escaped spaces, and escaped + // spaces or newlines in the middle of tokens? + // FIXME: Add a more explicit test. + unsigned i = 0; + while (i + 1 < Text.size() && Text[i] == '\\' && Text[i+1] == '\n') { + FormatTok.WhiteSpaceLength += 2; + i += 2; } if (FormatTok.Tok.is(tok::raw_identifier)) { - IdentifierInfo &Info = IdentTable.get(tokenText(FormatTok.Tok)); + IdentifierInfo &Info = IdentTable.get(Text); FormatTok.Tok.setIdentifierInfo(&Info); FormatTok.Tok.setKind(Info.getTokenID()); } @@ -1082,10 +1101,12 @@ public: LexerBasedFormatTokenSource Tokens(Lex, SourceMgr); UnwrappedLineParser Parser(Style, Tokens, *this); StructuralError = Parser.parse(); + unsigned PreviousEndOfLineColumn = 0; for (std::vector::iterator I = UnwrappedLines.begin(), E = UnwrappedLines.end(); I != E; ++I) - formatUnwrappedLine(*I); + PreviousEndOfLineColumn = + formatUnwrappedLine(*I, PreviousEndOfLineColumn); return Replaces; } @@ -1094,9 +1115,10 @@ private: UnwrappedLines.push_back(TheLine); } - void formatUnwrappedLine(const UnwrappedLine &TheLine) { - if (TheLine.Tokens.size() == 0) - return; + unsigned formatUnwrappedLine(const UnwrappedLine &TheLine, + unsigned PreviousEndOfLineColumn) { + if (TheLine.Tokens.empty()) + return 0; // FIXME: Find out how this can ever happen. CharSourceRange LineRange = CharSourceRange::getTokenRange(TheLine.Tokens.front().Tok.getLocation(), @@ -1111,13 +1133,20 @@ private: TokenAnnotator Annotator(TheLine, Style, SourceMgr); if (!Annotator.annotate()) - return; - UnwrappedLineFormatter Formatter(Style, SourceMgr, TheLine, - Annotator.getAnnotations(), Replaces, - StructuralError); - Formatter.format(); - return; + break; + UnwrappedLineFormatter Formatter( + Style, SourceMgr, TheLine, PreviousEndOfLineColumn, + Annotator.getAnnotations(), Replaces, StructuralError); + return Formatter.format(); } + // If we did not reformat this unwrapped line, the column at the end of the + // last token is unchanged - thus, we can calculate the end of the last + // token, and return the result. + const FormatToken &Token = TheLine.Tokens.back(); + return SourceMgr.getSpellingColumnNumber(Token.Tok.getLocation()) + + Lex.MeasureTokenLength(Token.Tok.getLocation(), SourceMgr, + Lex.getLangOpts()) - + 1; } FormatStyle Style; diff --git a/lib/Format/UnwrappedLineParser.cpp b/lib/Format/UnwrappedLineParser.cpp index 614125b943..04d1b36582 100644 --- a/lib/Format/UnwrappedLineParser.cpp +++ b/lib/Format/UnwrappedLineParser.cpp @@ -22,24 +22,77 @@ namespace clang { namespace format { +class ScopedMacroState : public FormatTokenSource { +public: + ScopedMacroState(UnwrappedLine &Line, FormatTokenSource *&TokenSource, + FormatToken &ResetToken) + : Line(Line), TokenSource(TokenSource), ResetToken(ResetToken), + PreviousTokenSource(TokenSource) { + TokenSource = this; + // FIXME: Back up all other state (errors, line indent, etc) and reset after + // parsing the macro. + Line.InPPDirective = true; + } + + ~ScopedMacroState() { + TokenSource = PreviousTokenSource; + ResetToken = Token; + Line.InPPDirective = false; + Line.Level = 0; // FIXME: Test + this is obviously incorrect + } + + virtual FormatToken getNextToken() { + // FIXME: Write test that breaks due to a missing + // if (eof()) return createEOF(); + Token = PreviousTokenSource->getNextToken(); + if (eof()) + return createEOF(); + return Token; + } + +private: + bool eof() { + return Token.NewlinesBefore > 0 && Token.HasUnescapedNewline; + } + + FormatToken createEOF() { + FormatToken FormatTok; + FormatTok.Tok.startToken(); + FormatTok.Tok.setKind(tok::eof); + return FormatTok; + } + + UnwrappedLine &Line; + FormatTokenSource *&TokenSource; + FormatToken &ResetToken; + + FormatTokenSource *PreviousTokenSource; + + FormatToken Token; +}; + UnwrappedLineParser::UnwrappedLineParser(const FormatStyle &Style, FormatTokenSource &Tokens, UnwrappedLineConsumer &Callback) - : Style(Style), Tokens(Tokens), Callback(Callback) { + : Style(Style), Tokens(&Tokens), Callback(Callback) { } bool UnwrappedLineParser::parse() { - FormatTok = Tokens.getNextToken(); - return parseLevel(); + readToken(); + return parseFile(); +} + +bool UnwrappedLineParser::parseFile() { + bool Error = parseLevel(); + // Make sure to format the remaining tokens. + addUnwrappedLine(); + return Error; } bool UnwrappedLineParser::parseLevel() { bool Error = false; do { switch (FormatTok.Tok.getKind()) { - case tok::hash: - parsePPDirective(); - break; case tok::comment: nextToken(); addUnwrappedLine(); @@ -81,24 +134,45 @@ bool UnwrappedLineParser::parseBlock(unsigned AddLevels) { void UnwrappedLineParser::parsePPDirective() { assert(FormatTok.Tok.is(tok::hash) && "'#' expected"); + ScopedMacroState MacroState(Line, Tokens, FormatTok); nextToken(); - Line.InPPDirective = true; if (FormatTok.Tok.getIdentifierInfo() == NULL) { addUnwrappedLine(); - Line.InPPDirective = false; return; } + switch (FormatTok.Tok.getIdentifierInfo()->getPPKeywordID()) { + case tok::pp_define: + parsePPDefine(); + break; + default: + parsePPUnknown(); + break; + } +} + +void UnwrappedLineParser::parsePPDefine() { + nextToken(); + + if (FormatTok.Tok.getKind() != tok::identifier) { + parsePPUnknown(); + return; + } + nextToken(); + if (FormatTok.Tok.getKind() == tok::l_paren) { + parseParens(); + } + addUnwrappedLine(); + Line.Level = 1; + parseFile(); +} + +void UnwrappedLineParser::parsePPUnknown() { do { - if (FormatTok.NewlinesBefore > 0 && - FormatTok.HasUnescapedNewline) { - break; - } nextToken(); } while (!eof()); addUnwrappedLine(); - Line.InPPDirective = false; } void UnwrappedLineParser::parseComments() { @@ -390,7 +464,18 @@ void UnwrappedLineParser::nextToken() { if (eof()) return; Line.Tokens.push_back(FormatTok); - FormatTok = Tokens.getNextToken(); + readToken(); +} + +void UnwrappedLineParser::readToken() { + FormatTok = Tokens->getNextToken(); + while (FormatTok.Tok.is(tok::hash)) { + // FIXME: This is incorrect - the correct way is to create a + // data structure that will construct the parts around the preprocessor + // directive as a structured \c UnwrappedLine. + addUnwrappedLine(); + parsePPDirective(); + } } } // end namespace format diff --git a/lib/Format/UnwrappedLineParser.h b/lib/Format/UnwrappedLineParser.h index 9ed796d45b..69ac768325 100644 --- a/lib/Format/UnwrappedLineParser.h +++ b/lib/Format/UnwrappedLineParser.h @@ -101,9 +101,12 @@ public: bool parse(); private: + bool parseFile(); bool parseLevel(); bool parseBlock(unsigned AddLevels = 1); void parsePPDirective(); + void parsePPDefine(); + void parsePPUnknown(); void parseComments(); void parseStatement(); void parseParens(); @@ -119,12 +122,13 @@ private: void addUnwrappedLine(); bool eof() const; void nextToken(); + void readToken(); UnwrappedLine Line; FormatToken FormatTok; const FormatStyle &Style; - FormatTokenSource &Tokens; + FormatTokenSource *Tokens; UnwrappedLineConsumer &Callback; }; diff --git a/test/Index/comment-c-decls.c b/test/Index/comment-c-decls.c index 1cf41233dd..be45ee205f 100644 --- a/test/Index/comment-c-decls.c +++ b/test/Index/comment-c-decls.c @@ -95,7 +95,7 @@ enum e { *\brief block declaration */ int (^Block) (int i, int j); -// CHECK: int (^Block)(int, int) +// CHECK: int ( ^ Block) (int, int) /** *\brief block declaration diff --git a/test/Index/comment-objc-decls.m b/test/Index/comment-objc-decls.m index 6682ea320f..88e04714c4 100644 --- a/test/Index/comment-objc-decls.m +++ b/test/Index/comment-objc-decls.m @@ -30,7 +30,7 @@ */ + ClassMethodMyProto; @end -// CHECK: @protocol MyProto\n@end +// CHECK: @protocol MyProto @end // CHECK: - (unsigned int)MethodMyProto:(id)anObject inRange:(unsigned int)range; // CHECK: @optional\n @property(readwrite, copy, atomic) id PropertyMyProto; // CHECK: + (id)ClassMethodMyProto; @@ -108,7 +108,7 @@ */ @property (copy) id PropertyMyClassCategory; @end -// CHECK: @interface MyClass(Category)\n@end +// CHECK: @interface MyClass(Category) @end // CHECK: - (void)MethodMyClassCategory; // CHECK: @property(readwrite, copy, atomic) id PropertyMyClassCategory; // CHECK: - (id)PropertyMyClassCategory; @@ -162,7 +162,7 @@ */ - (void) setPropertyMyClassCategory : (id) arg {} @end -// CHECK: @implementation MyClass(Category)\n@end +// CHECK: @implementation MyClass(Category) @end // CHECK: - (void)MethodMyClassCategory; // CHECK: - (id)PropertyMyClassCategory; // CHECK: - (void)setPropertyMyClassCategory:(id)arg; @@ -172,4 +172,4 @@ */ @implementation NSObject @end -// CHECK: @implementation NSObject@end +// CHECK: @implementation NSObject @end diff --git a/test/Index/comment-to-html-xml-conversion.cpp b/test/Index/comment-to-html-xml-conversion.cpp index 0af0dd746d..1ab49d6fc0 100644 --- a/test/Index/comment-to-html-xml-conversion.cpp +++ b/test/Index/comment-to-html-xml-conversion.cpp @@ -304,7 +304,7 @@ void comment_to_html_conversion_18(T aaa); template void comment_to_html_conversion_19(T1 aaa, T2 bbb); -// CHECK: comment-to-html-xml-conversion.cpp:[[@LINE-2]]:6: FunctionTemplate=comment_to_html_conversion_19:{{.*}} FullCommentAsHTML=[
T1
Aaa
T2
Bbb
] FullCommentAsXML=[comment_to_html_conversion_19c:@FT@>2#T#Tcomment_to_html_conversion_19#t0.0#t0.1#template <typename T1, typename T2> void comment_to_html_conversion_19(T1 aaa, T2 bbb)T10 AaaT21 Bbb ] +// CHECK: comment-to-html-xml-conversion.cpp:[[@LINE-2]]:6: FunctionTemplate=comment_to_html_conversion_19:{{.*}} FullCommentAsHTML=[
T1
Aaa
T2
Bbb
] FullCommentAsXML=[comment_to_html_conversion_19c:@FT@>2#T#Tcomment_to_html_conversion_19#t0.0#t0.1#template <typename T1, typename T2>\nvoid comment_to_html_conversion_19(T1 aaa, T2 bbb)T10 AaaT21 Bbb ] // CHECK-NEXT: CommentAST=[ // CHECK-NEXT: (CXComment_FullComment // CHECK-NEXT: (CXComment_Paragraph IsWhitespace @@ -324,7 +324,7 @@ void comment_to_html_conversion_19(T1 aaa, T2 bbb); template void comment_to_html_conversion_20(T1 aaa, T2 bbb); -// CHECK: comment-to-html-xml-conversion.cpp:[[@LINE-2]]:6: FunctionTemplate=comment_to_html_conversion_20:{{.*}} FullCommentAsHTML=[
T1
Aaa
T2
Bbb
V
Ccc
U
Zzz
] FullCommentAsXML=[comment_to_html_conversion_20c:@FT@>3#T#T#NIcomment_to_html_conversion_20#t0.0#t0.1#template <typename T1, typename T2, int V> void comment_to_html_conversion_20(T1 aaa, T2 bbb)T10 AaaT21 Bbb V2 Ccc U Zzz ] +// CHECK: comment-to-html-xml-conversion.cpp:[[@LINE-2]]:6: FunctionTemplate=comment_to_html_conversion_20:{{.*}} FullCommentAsHTML=[
T1
Aaa
T2
Bbb
V
Ccc
U
Zzz
] FullCommentAsXML=[comment_to_html_conversion_20c:@FT@>3#T#T#NIcomment_to_html_conversion_20#t0.0#t0.1#template <typename T1, typename T2, int V>\nvoid comment_to_html_conversion_20(T1 aaa, T2 bbb)T10 AaaT21 Bbb V2 Ccc U Zzz ] // CHECK-NEXT: CommentAST=[ // CHECK-NEXT: (CXComment_FullComment // CHECK-NEXT: (CXComment_Paragraph IsWhitespace @@ -352,7 +352,7 @@ void comment_to_html_conversion_20(T1 aaa, T2 bbb); template class TT, class C> class TTT> void comment_to_html_conversion_21(); -// CHECK: comment-to-html-xml-conversion.cpp:[[@LINE-2]]:6: FunctionTemplate=comment_to_html_conversion_21:{{.*}} FullCommentAsHTML=[
TTT
Ddd
C
Ccc
T
Aaa
TT
Bbb
] FullCommentAsXML=[comment_to_html_conversion_21c:@FT@>1#t>2#t>1#T#Tcomment_to_html_conversion_21#template <template <template <typename T> class TT, class C> class TTT> void comment_to_html_conversion_21()TTT0 Ddd C Ccc T Aaa TT Bbb] +// CHECK: comment-to-html-xml-conversion.cpp:[[@LINE-2]]:6: FunctionTemplate=comment_to_html_conversion_21:{{.*}} FullCommentAsHTML=[
TTT
Ddd
C
Ccc
T
Aaa
TT
Bbb
] FullCommentAsXML=[comment_to_html_conversion_21c:@FT@>1#t>2#t>1#T#Tcomment_to_html_conversion_21#template <template <template <typename T> class TT,\n class C > class TTT > void comment_to_html_conversion_21()TTT0 Ddd C Ccc T Aaa TT Bbb] // CHECK-NEXT: CommentAST=[ // CHECK-NEXT: (CXComment_FullComment // CHECK-NEXT: (CXComment_Paragraph IsWhitespace @@ -651,14 +651,14 @@ class comment_to_xml_conversion_01 { template using comment_to_xml_conversion_09 = comment_to_xml_conversion_08; -// CHECK: comment-to-html-xml-conversion.cpp:[[@LINE-2]]:3: UnexposedDecl=comment_to_xml_conversion_09:{{.*}} FullCommentAsXML=[comment_to_xml_conversion_09c:@C@comment_to_xml_conversion_01@comment_to_xml_conversion_09template <typename T> using comment_to_xml_conversion_09 = comment_to_xml_conversion_08<T, int> Aaa.] +// CHECK: comment-to-html-xml-conversion.cpp:[[@LINE-2]]:3: UnexposedDecl=comment_to_xml_conversion_09:{{.*}} FullCommentAsXML=[comment_to_xml_conversion_09c:@C@comment_to_xml_conversion_01@comment_to_xml_conversion_09template <typename T>\nusing comment_to_xml_conversion_09 = comment_to_xml_conversion_08<T, int> Aaa.] }; /// Aaa. template void comment_to_xml_conversion_10(T aaa, U bbb); -// CHECK: comment-to-html-xml-conversion.cpp:[[@LINE-2]]:6: FunctionTemplate=comment_to_xml_conversion_10:{{.*}} FullCommentAsXML=[comment_to_xml_conversion_10c:@FT@>2#T#Tcomment_to_xml_conversion_10#t0.0#t0.1#template <typename T = int, typename U = int> void comment_to_xml_conversion_10(int aaa, int bbb)template <typename T, typename U> void comment_to_xml_conversion_10(T aaa, U bbb) Aaa.] +// CHECK: comment-to-html-xml-conversion.cpp:[[@LINE-2]]:6: FunctionTemplate=comment_to_xml_conversion_10:{{.*}} FullCommentAsXML=[comment_to_xml_conversion_10c:@FT@>2#T#Tcomment_to_xml_conversion_10#t0.0#t0.1#template <typename T = int, typename U = int>\nvoid comment_to_xml_conversion_10(int aaa, int bbb) template <typename T,\n typename U>\nvoid comment_to_xml_conversion_10(T aaa, U bbb) Aaa.] /// Aaa. template<> diff --git a/test/Index/format-comment-cdecls.c b/test/Index/format-comment-cdecls.c index 10921a2811..b1539fe1cc 100644 --- a/test/Index/format-comment-cdecls.c +++ b/test/Index/format-comment-cdecls.c @@ -90,7 +90,7 @@ enum e { *\brief block declaration */ int (^Block) (int i, int j); -// CHECK: int (^Block)(int, int) +// CHECK: int ( ^ Block) (int, int) /** *\brief block declaration diff --git a/test/Index/overriding-ftemplate-comments.cpp b/test/Index/overriding-ftemplate-comments.cpp index 09cd4fe4c1..50d4e87da2 100644 --- a/test/Index/overriding-ftemplate-comments.cpp +++ b/test/Index/overriding-ftemplate-comments.cpp @@ -27,12 +27,12 @@ void comment_to_html_conversion_17(T PPP); template void comment_to_html_conversion_19(AAA aaa, BBB bbb); -// CHECK: FullCommentAsXML=[comment_to_html_conversion_19c:@FT@>2#T#Tcomment_to_html_conversion_19#t0.0#t0.1#template <typename AAA, typename BBB> void comment_to_html_conversion_19(AAA aaa, BBB bbb)AAA0 AaaBBB1 Bbb ] +// CHECK: FullCommentAsXML=[comment_to_html_conversion_19c:@FT@>2#T#Tcomment_to_html_conversion_19#t0.0#t0.1#template <typename AAA, typename BBB>\nvoid comment_to_html_conversion_19(AAA aaa, BBB bbb)AAA0 AaaBBB1 Bbb ] template void comment_to_html_conversion_19(PPP aaa, QQQ bbb); -// CHECK: FullCommentAsXML=[comment_to_html_conversion_19c:@FT@>2#T#Tcomment_to_html_conversion_19#t0.0#t0.1#template <typename PPP, typename QQQ> void comment_to_html_conversion_19(PPP aaa, QQQ bbb)PPP0 AaaQQQ1 Bbb ] +// CHECK: FullCommentAsXML=[comment_to_html_conversion_19c:@FT@>2#T#Tcomment_to_html_conversion_19#t0.0#t0.1#template <typename PPP, typename QQQ>\nvoid comment_to_html_conversion_19(PPP aaa, QQQ bbb)PPP0 AaaQQQ1 Bbb ] //===----------------------------------------------------------------------===// @@ -43,12 +43,12 @@ void comment_to_html_conversion_19(PPP aaa, QQQ bbb); template void comment_to_html_conversion_20(AAA aaa, BBB bbb); -// CHECK: FullCommentAsXML=[comment_to_html_conversion_20c:@FT@>3#T#T#NIcomment_to_html_conversion_20#t0.0#t0.1#template <typename AAA, typename BBB, int CCC> void comment_to_html_conversion_20(AAA aaa, BBB bbb)AAA0 AaaBBB1 Bbb CCC2 Ccc UUU Zzz ] +// CHECK: FullCommentAsXML=[comment_to_html_conversion_20c:@FT@>3#T#T#NIcomment_to_html_conversion_20#t0.0#t0.1#template <typename AAA, typename BBB, int CCC>\nvoid comment_to_html_conversion_20(AAA aaa, BBB bbb)AAA0 AaaBBB1 Bbb CCC2 Ccc UUU Zzz ] template void comment_to_html_conversion_20(PPP aaa, QQQ bbb); -// CHECK: FullCommentAsXML=[comment_to_html_conversion_20c:@FT@>3#T#T#NIcomment_to_html_conversion_20#t0.0#t0.1#template <typename PPP, typename QQQ, int RRR> void comment_to_html_conversion_20(PPP aaa, QQQ bbb)PPP0 AaaQQQ1 Bbb RRR2 Ccc UUU Zzz ] +// CHECK: FullCommentAsXML=[comment_to_html_conversion_20c:@FT@>3#T#T#NIcomment_to_html_conversion_20#t0.0#t0.1#template <typename PPP, typename QQQ, int RRR>\nvoid comment_to_html_conversion_20(PPP aaa, QQQ bbb)PPP0 AaaQQQ1 Bbb RRR2 Ccc UUU Zzz ] //===----------------------------------------------------------------------===// @@ -59,12 +59,12 @@ void comment_to_html_conversion_20(PPP aaa, QQQ bbb); template class DDD, class BBB> class AAA> void comment_to_html_conversion_21(); -// CHECK: FullCommentAsXML=[comment_to_html_conversion_21c:@FT@>1#t>2#t>1#T#Tcomment_to_html_conversion_21#template <template <template <typename CCC> class DDD, class BBB> class AAA> void comment_to_html_conversion_21()AAA0 Aaa BBB Bbb CCC Ccc DDD Ddd] +// CHECK: FullCommentAsXML=[comment_to_html_conversion_21c:@FT@>1#t>2#t>1#T#Tcomment_to_html_conversion_21#template <template <template <typename CCC> class DDD,\n class BBB > class AAA > void comment_to_html_conversion_21()AAA0 Aaa BBB Bbb CCC Ccc DDD Ddd] template class SSS, class QQQ> class PPP> void comment_to_html_conversion_21(); -// CHECK: FullCommentAsXML=[comment_to_html_conversion_21c:@FT@>1#t>2#t>1#T#Tcomment_to_html_conversion_21#template <template <template <typename RRR> class SSS, class QQQ> class PPP> void comment_to_html_conversion_21()PPP0 Aaa QQQ Bbb RRR Ccc SSS Ddd] +// CHECK: FullCommentAsXML=[comment_to_html_conversion_21c:@FT@>1#t>2#t>1#T#Tcomment_to_html_conversion_21#template <template <template <typename RRR> class SSS,\n class QQQ > class PPP > void comment_to_html_conversion_21()PPP0 Aaa QQQ Bbb RRR Ccc SSS Ddd] //===----------------------------------------------------------------------===// @@ -77,10 +77,10 @@ void comment_to_html_conversion_21(); template class BBB> class AAA> void comment_to_html_conversion_22(); -// CHECK: FullCommentAsXML=[comment_to_html_conversion_22c:@FT@>2#T#t>2#T#t>2#T#Tcomment_to_html_conversion_22#template <class C1, template <class C2, template <class C3, class C4> class BBB> class AAA> void comment_to_html_conversion_22()C10 Ccc 1 AAA1 Zzz C2 Ccc 2 C3 Ccc 3 C4 Ccc 4 BBB Bbb] +// CHECK: FullCommentAsXML=[comment_to_html_conversion_22c:@FT@>2#T#t>2#T#t>2#T#Tcomment_to_html_conversion_22#template <class C1,\n template <class C2, template <class C3, class C4>\n class BBB > class AAA > void comment_to_html_conversion_22()C10 Ccc 1 AAA1 Zzz C2 Ccc 2 C3 Ccc 3 C4 Ccc 4 BBB Bbb] template class QQQ> class PPP> void comment_to_html_conversion_22(); -// CHECK: FullCommentAsXML=[comment_to_html_conversion_22c:@FT@>2#T#t>2#T#t>2#T#Tcomment_to_html_conversion_22#template <class CCC1, template <class CCC2, template <class CCC3, class CCC4> class QQQ> class PPP> void comment_to_html_conversion_22()CCC10 Ccc 1 PPP1 Zzz CCC2 Ccc 2 CCC3 Ccc 3 CCC4 Ccc 4 QQQ Bbb] +// CHECK: FullCommentAsXML=[comment_to_html_conversion_22c:@FT@>2#T#t>2#T#t>2#T#Tcomment_to_html_conversion_22#template <class CCC1,\n template <class CCC2, template <class CCC3, class CCC4>\n class QQQ > class PPP > void comment_to_html_conversion_22()CCC10 Ccc 1 PPP1 Zzz CCC2 Ccc 2 CCC3 Ccc 3 CCC4 Ccc 4 QQQ Bbb] diff --git a/unittests/Format/FormatTest.cpp b/unittests/Format/FormatTest.cpp index c17bc0d76b..d5c7978e7b 100644 --- a/unittests/Format/FormatTest.cpp +++ b/unittests/Format/FormatTest.cpp @@ -50,8 +50,8 @@ protected: if (JustReplacedNewline) MessedUp[i - 1] = '\n'; InComment = true; - } else if (MessedUp[i] != ' ') { - JustReplacedNewline = false; + } else if (MessedUp[i] == '\\' && MessedUp[i + 1] == '\n') { + MessedUp[i] = ' '; } else if (MessedUp[i] == '\n') { if (InComment) { InComment = false; @@ -59,6 +59,8 @@ protected: JustReplacedNewline = true; MessedUp[i] = ' '; } + } else if (MessedUp[i] != ' ') { + JustReplacedNewline = false; } } return MessedUp; @@ -394,13 +396,17 @@ TEST_F(FormatTest, BreaksOnHashWhenDirectiveIsInvalid) { TEST_F(FormatTest, UnescapedEndOfLineEndsPPDirective) { EXPECT_EQ("#line 42 \"test\"\n", format("# \\\n line \\\n 42 \\\n \"test\"\n")); - EXPECT_EQ("#define A B\n", format("# \\\n define \\\n A \\\n B\n")); + EXPECT_EQ("#define A \\\n B\n", + format("# \\\n define \\\n A \\\n B\n", + getLLVMStyleWithColumns(12))); } TEST_F(FormatTest, EndOfFileEndsPPDirective) { EXPECT_EQ("#line 42 \"test\"", format("# \\\n line \\\n 42 \\\n \"test\"")); - EXPECT_EQ("#define A B", format("# \\\n define \\\n A \\\n B")); + EXPECT_EQ("#define A \\\n B", + format("# \\\n define \\\n A \\\n B", + getLLVMStyleWithColumns(12))); } TEST_F(FormatTest, IndentsPPDirectiveInReducedSpace) { @@ -413,24 +419,63 @@ TEST_F(FormatTest, IndentsPPDirectiveInReducedSpace) { } TEST_F(FormatTest, HandlePreprocessorDirectiveContext) { - verifyFormat( - "// some comment\n" - "\n" - "#include \"a.h\"\n" - "#define A(A,\\\n" - " B)\n" - "#include \"b.h\"\n" - "\n" - "// some comment\n", getLLVMStyleWithColumns(13)); + EXPECT_EQ("// some comment\n" + "#include \"a.h\"\n" + "#define A(A,\\\n" + " B)\n" + "#include \"b.h\"\n" + "// some comment\n", + format(" // some comment\n" + " #include \"a.h\"\n" + "#define A(A,\\\n" + " B)\n" + " #include \"b.h\"\n" + " // some comment\n", getLLVMStyleWithColumns(13))); +} + +TEST_F(FormatTest, LayoutSingleHash) { + EXPECT_EQ("#\na;", format("#\na;")); +} + +TEST_F(FormatTest, LayoutCodeInMacroDefinitions) { + EXPECT_EQ("#define A \\\n" + " c; \\\n" + " e;\n" + "f;", format("#define A c; e;\n" + "f;", getLLVMStyleWithColumns(14))); } +TEST_F(FormatTest, LayoutRemainingTokens) { + EXPECT_EQ("{\n}", format("{}")); +} + +TEST_F(FormatTest, LayoutSingleUnwrappedLineInMacro) { + EXPECT_EQ("#define A \\\n b;", + format("#define A b;", 10, 2, getLLVMStyleWithColumns(11))); +} + +TEST_F(FormatTest, MacroDefinitionInsideStatement) { + EXPECT_EQ("int x,\n#define A\ny;", format("int x,\n#define A\ny;")); +} + +// FIXME: write test for unbalanced braces in macros... +// FIXME: test { { #include "a.h" } } +// FIXME: test # in the middle of a statement without \n before it + TEST_F(FormatTest, MixingPreprocessorDirectivesAndNormalCode) { - verifyFormat("#define ALooooooooooooooooooooooooooooooooooooooongMacro(" - " \\\n" - " aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)\n" - "\n" - "AlooooooooooooooooooooooooooooooooooooooongCaaaaaaaaaal(\n" - " aLooooooooooooooooooooooonPaaaaaaaaaaaaaaaaaaaaarmmmm);\n"); + EXPECT_EQ( + "#define ALooooooooooooooooooooooooooooooooooooooongMacro(" + " \\\n" + " aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)\n" + "\n" + "AlooooooooooooooooooooooooooooooooooooooongCaaaaaaaaaal(\n" + " aLooooooooooooooooooooooonPaaaaaaaaaaaaaaaaaaaaarmmmm);\n", + format(" #define ALooooooooooooooooooooooooooooooooooooooongMacro(" + "\\\n" + "aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)\n" + " \n" + " AlooooooooooooooooooooooooooooooooooooooongCaaaaaaaaaal(\n" + " aLooooooooooooooooooooooonPaaaaaaaaaaaaaaaaaaaaarmmmm);\n")); } //===----------------------------------------------------------------------===// @@ -863,9 +908,7 @@ TEST_F(FormatTest, IncorrectCodeDoNoWhile) { TEST_F(FormatTest, DoesNotTouchUnwrappedLinesWithErrors) { verifyFormat("namespace {\n" - "class Foo {\n" - " Foo ( };\n" - "} // comment"); + "class Foo { Foo ( }; } // comment"); } TEST_F(FormatTest, IncorrectCodeErrorDetection) { -- 2.40.0