diff --git a/clang/include/clang/Tooling/Inclusions/HeaderIncludes.h b/clang/include/clang/Tooling/Inclusions/HeaderIncludes.h --- a/clang/include/clang/Tooling/Inclusions/HeaderIncludes.h +++ b/clang/include/clang/Tooling/Inclusions/HeaderIncludes.h @@ -79,6 +79,9 @@ /// exactly the same spelling. tooling::Replacements remove(llvm::StringRef Header, bool IsAngled) const; + // Matches a whole #include directive. + static const llvm::Regex IncludeRegex; + private: struct Include { Include(StringRef Name, tooling::Range R) : Name(Name), R(R) {} @@ -124,11 +127,17 @@ // All possible priorities. std::set Priorities; - - // Matches a whole #include directive. - llvm::Regex IncludeRegex; }; +/// \returns the include name from the list of match groups. +/// \sa HeaderIncludes::IncludeRegex for the regular expression +llvm::StringRef getIncludeNameFromMatches( + const llvm::SmallVectorImpl &Matches); + +/// \returns the given include name and removes the following symbols from the +/// beginning and ending of the include name: " > < ; +llvm::StringRef trimInclude(llvm::StringRef IncludeName); + } // namespace tooling } // namespace clang diff --git a/clang/lib/Format/Format.cpp b/clang/lib/Format/Format.cpp --- a/clang/lib/Format/Format.cpp +++ b/clang/lib/Format/Format.cpp @@ -44,6 +44,7 @@ #include "llvm/Support/VirtualFileSystem.h" #include "llvm/Support/YAMLTraits.h" #include +#include #include #include #include @@ -2769,13 +2770,6 @@ } } -namespace { - -const char CppIncludeRegexPattern[] = - R"(^[\t\ ]*#[\t\ ]*(import|include)[^"<]*(["<][^">]*[">]))"; - -} // anonymous namespace - tooling::Replacements sortCppIncludes(const FormatStyle &Style, StringRef Code, ArrayRef Ranges, StringRef FileName, @@ -2785,7 +2779,6 @@ .StartsWith("\xEF\xBB\xBF", 3) // UTF-8 BOM .Default(0); unsigned SearchFrom = 0; - llvm::Regex IncludeRegex(CppIncludeRegexPattern); SmallVector Matches; SmallVector IncludesInBlock; @@ -2842,8 +2835,9 @@ bool MergeWithNextLine = Trimmed.endswith("\\"); if (!FormattingOff && !MergeWithNextLine) { - if (IncludeRegex.match(Line, &Matches)) { - StringRef IncludeName = Matches[2]; + if (tooling::HeaderIncludes::IncludeRegex.match(Line, &Matches)) { + StringRef IncludeName = tooling::getIncludeNameFromMatches(Matches); + if (Line.contains("/*") && !Line.contains("*/")) { // #include with a start of a block comment, but without the end. // Need to keep all the lines until the end of the comment together. @@ -3120,8 +3114,8 @@ inline bool isHeaderInsertion(const tooling::Replacement &Replace) { return Replace.getOffset() == UINT_MAX && Replace.getLength() == 0 && - llvm::Regex(CppIncludeRegexPattern) - .match(Replace.getReplacementText()); + tooling::HeaderIncludes::IncludeRegex.match( + Replace.getReplacementText()); } inline bool isHeaderDeletion(const tooling::Replacement &Replace) { @@ -3129,7 +3123,7 @@ } // FIXME: insert empty lines between newly created blocks. -tooling::Replacements +static tooling::Replacements fixCppIncludeInsertions(StringRef Code, const tooling::Replacements &Replaces, const FormatStyle &Style) { if (!Style.isCpp()) @@ -3161,7 +3155,7 @@ for (const auto &Header : HeadersToDelete) { tooling::Replacements Replaces = - Includes.remove(Header.trim("\"<>"), Header.startswith("<")); + Includes.remove(tooling::trimInclude(Header), Header.startswith("<")); for (const auto &R : Replaces) { auto Err = Result.add(R); if (Err) { @@ -3173,17 +3167,17 @@ } } - llvm::Regex IncludeRegex = llvm::Regex(CppIncludeRegexPattern); llvm::SmallVector Matches; for (const auto &R : HeaderInsertions) { auto IncludeDirective = R.getReplacementText(); - bool Matched = IncludeRegex.match(IncludeDirective, &Matches); + bool Matched = + tooling::HeaderIncludes::IncludeRegex.match(IncludeDirective, &Matches); assert(Matched && "Header insertion replacement must have replacement text " "'#include ...'"); (void)Matched; - auto IncludeName = Matches[2]; - auto Replace = - Includes.insert(IncludeName.trim("\"<>"), IncludeName.startswith("<")); + StringRef IncludeName = tooling::getIncludeNameFromMatches(Matches); + auto Replace = Includes.insert(tooling::trimInclude(IncludeName), + IncludeName.startswith("<")); if (Replace) { auto Err = Result.add(*Replace); if (Err) { diff --git a/clang/lib/Tooling/Inclusions/HeaderIncludes.cpp b/clang/lib/Tooling/Inclusions/HeaderIncludes.cpp --- a/clang/lib/Tooling/Inclusions/HeaderIncludes.cpp +++ b/clang/lib/Tooling/Inclusions/HeaderIncludes.cpp @@ -169,13 +169,6 @@ }); } -inline StringRef trimInclude(StringRef IncludeName) { - return IncludeName.trim("\"<>"); -} - -const char IncludeRegexPattern[] = - R"(^[\t\ ]*#[\t\ ]*(import|include)[^"<]*(["<][^">]*[">]))"; - // The filename of Path excluding extension. // Used to match implementation with headers, this differs from sys::path::stem: // - in names with multiple dots (foo.cu.cc) it terminates at the *first* @@ -266,6 +259,16 @@ return false; } +static const char IncludeRegexPattern[] = + R"(^[\t\ ]*#[\t\ ]*(import|include)[^"<]*(["<][^">]*[">]))"; +/// IncludeRegex ia regex that can match various styles of C++ includes. +/// For example: +/// \code +/// #include +/// #include "bar.h" +/// \endcode +const llvm::Regex HeaderIncludes::IncludeRegex(IncludeRegexPattern); + HeaderIncludes::HeaderIncludes(StringRef FileName, StringRef Code, const IncludeStyle &Style) : FileName(FileName), Code(Code), FirstIncludeOffset(-1), @@ -274,8 +277,7 @@ MaxInsertOffset(MinInsertOffset + getMaxHeaderInsertionOffset( FileName, Code.drop_front(MinInsertOffset), Style)), - Categories(Style, FileName), - IncludeRegex(llvm::Regex(IncludeRegexPattern)) { + Categories(Style, FileName) { // Add 0 for main header and INT_MAX for headers that are not in any // category. Priorities = {0, INT_MAX}; @@ -289,11 +291,12 @@ SmallVector Matches; for (auto Line : Lines) { NextLineOffset = std::min(Code.size(), Offset + Line.size() + 1); - if (IncludeRegex.match(Line, &Matches)) { + if (tooling::HeaderIncludes::IncludeRegex.match(Line, &Matches)) { + StringRef IncludeName = tooling::getIncludeNameFromMatches(Matches); // If this is the last line without trailing newline, we need to make // sure we don't delete across the file boundary. addExistingInclude( - Include(Matches[2], + Include(IncludeName, tooling::Range( Offset, std::min(Line.size() + 1, Code.size() - Offset))), NextLineOffset); @@ -403,5 +406,18 @@ return Result; } +llvm::StringRef getIncludeNameFromMatches( + const llvm::SmallVectorImpl &Matches) { + if (Matches.size() >= 3) { + return Matches[2]; + } + llvm_unreachable("Matches is too small"); + return llvm::StringRef(); +} + +llvm::StringRef trimInclude(llvm::StringRef IncludeName) { + return IncludeName.trim("\"<>;"); +} + } // namespace tooling } // namespace clang