annotate clang-tools-extra/clang-include-fixer/IncludeFixerContext.cpp @ 160:dbfec6499728

...
author anatofuz
date Wed, 18 Mar 2020 19:11:03 +0900
parents 1d019706d866
children c4bab56944e8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 //===-- IncludeFixerContext.cpp - Include fixer context ---------*- C++ -*-===//
anatofuz
parents:
diff changeset
2 //
anatofuz
parents:
diff changeset
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
anatofuz
parents:
diff changeset
4 // See https://llvm.org/LICENSE.txt for license information.
anatofuz
parents:
diff changeset
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
anatofuz
parents:
diff changeset
6 //
anatofuz
parents:
diff changeset
7 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
8
anatofuz
parents:
diff changeset
9 #include "IncludeFixerContext.h"
anatofuz
parents:
diff changeset
10 #include <algorithm>
anatofuz
parents:
diff changeset
11
anatofuz
parents:
diff changeset
12 namespace clang {
anatofuz
parents:
diff changeset
13 namespace include_fixer {
anatofuz
parents:
diff changeset
14
anatofuz
parents:
diff changeset
15 namespace {
anatofuz
parents:
diff changeset
16
anatofuz
parents:
diff changeset
17 // Splits a multiply qualified names (e.g. a::b::c).
anatofuz
parents:
diff changeset
18 llvm::SmallVector<llvm::StringRef, 8>
anatofuz
parents:
diff changeset
19 SplitQualifiers(llvm::StringRef StringQualifiers) {
anatofuz
parents:
diff changeset
20 llvm::SmallVector<llvm::StringRef, 8> Qualifiers;
anatofuz
parents:
diff changeset
21 StringQualifiers.split(Qualifiers, "::");
anatofuz
parents:
diff changeset
22 return Qualifiers;
anatofuz
parents:
diff changeset
23 }
anatofuz
parents:
diff changeset
24
anatofuz
parents:
diff changeset
25 std::string createQualifiedNameForReplacement(
anatofuz
parents:
diff changeset
26 llvm::StringRef RawSymbolName,
anatofuz
parents:
diff changeset
27 llvm::StringRef SymbolScopedQualifiersName,
anatofuz
parents:
diff changeset
28 const find_all_symbols::SymbolInfo &MatchedSymbol) {
anatofuz
parents:
diff changeset
29 // No need to add missing qualifiers if SymbolIdentifier has a global scope
anatofuz
parents:
diff changeset
30 // operator "::".
anatofuz
parents:
diff changeset
31 if (RawSymbolName.startswith("::"))
anatofuz
parents:
diff changeset
32 return std::string(RawSymbolName);
anatofuz
parents:
diff changeset
33
anatofuz
parents:
diff changeset
34 std::string QualifiedName = MatchedSymbol.getQualifiedName();
anatofuz
parents:
diff changeset
35
anatofuz
parents:
diff changeset
36 // For nested classes, the qualified name constructed from database misses
anatofuz
parents:
diff changeset
37 // some stripped qualifiers, because when we search a symbol in database,
anatofuz
parents:
diff changeset
38 // we strip qualifiers from the end until we find a result. So append the
anatofuz
parents:
diff changeset
39 // missing stripped qualifiers here.
anatofuz
parents:
diff changeset
40 //
anatofuz
parents:
diff changeset
41 // Get stripped qualifiers.
anatofuz
parents:
diff changeset
42 auto SymbolQualifiers = SplitQualifiers(RawSymbolName);
anatofuz
parents:
diff changeset
43 std::string StrippedQualifiers;
anatofuz
parents:
diff changeset
44 while (!SymbolQualifiers.empty() &&
anatofuz
parents:
diff changeset
45 !llvm::StringRef(QualifiedName).endswith(SymbolQualifiers.back())) {
anatofuz
parents:
diff changeset
46 StrippedQualifiers =
anatofuz
parents:
diff changeset
47 "::" + SymbolQualifiers.back().str() + StrippedQualifiers;
anatofuz
parents:
diff changeset
48 SymbolQualifiers.pop_back();
anatofuz
parents:
diff changeset
49 }
anatofuz
parents:
diff changeset
50 // Append the missing stripped qualifiers.
anatofuz
parents:
diff changeset
51 std::string FullyQualifiedName = QualifiedName + StrippedQualifiers;
anatofuz
parents:
diff changeset
52
anatofuz
parents:
diff changeset
53 // Try to find and skip the common prefix qualifiers.
anatofuz
parents:
diff changeset
54 auto FullySymbolQualifiers = SplitQualifiers(FullyQualifiedName);
anatofuz
parents:
diff changeset
55 auto ScopedQualifiers = SplitQualifiers(SymbolScopedQualifiersName);
anatofuz
parents:
diff changeset
56 auto FullySymbolQualifiersIter = FullySymbolQualifiers.begin();
anatofuz
parents:
diff changeset
57 auto SymbolScopedQualifiersIter = ScopedQualifiers.begin();
anatofuz
parents:
diff changeset
58 while (FullySymbolQualifiersIter != FullySymbolQualifiers.end() &&
anatofuz
parents:
diff changeset
59 SymbolScopedQualifiersIter != ScopedQualifiers.end()) {
anatofuz
parents:
diff changeset
60 if (*FullySymbolQualifiersIter != *SymbolScopedQualifiersIter)
anatofuz
parents:
diff changeset
61 break;
anatofuz
parents:
diff changeset
62 ++FullySymbolQualifiersIter;
anatofuz
parents:
diff changeset
63 ++SymbolScopedQualifiersIter;
anatofuz
parents:
diff changeset
64 }
anatofuz
parents:
diff changeset
65 std::string Result;
anatofuz
parents:
diff changeset
66 for (; FullySymbolQualifiersIter != FullySymbolQualifiers.end();
anatofuz
parents:
diff changeset
67 ++FullySymbolQualifiersIter) {
anatofuz
parents:
diff changeset
68 if (!Result.empty())
anatofuz
parents:
diff changeset
69 Result += "::";
anatofuz
parents:
diff changeset
70 Result += *FullySymbolQualifiersIter;
anatofuz
parents:
diff changeset
71 }
anatofuz
parents:
diff changeset
72 return Result;
anatofuz
parents:
diff changeset
73 }
anatofuz
parents:
diff changeset
74
anatofuz
parents:
diff changeset
75 } // anonymous namespace
anatofuz
parents:
diff changeset
76
anatofuz
parents:
diff changeset
77 IncludeFixerContext::IncludeFixerContext(
anatofuz
parents:
diff changeset
78 StringRef FilePath, std::vector<QuerySymbolInfo> QuerySymbols,
anatofuz
parents:
diff changeset
79 std::vector<find_all_symbols::SymbolInfo> Symbols)
anatofuz
parents:
diff changeset
80 : FilePath(FilePath), QuerySymbolInfos(std::move(QuerySymbols)),
anatofuz
parents:
diff changeset
81 MatchedSymbols(std::move(Symbols)) {
anatofuz
parents:
diff changeset
82 // Remove replicated QuerySymbolInfos with the same range.
anatofuz
parents:
diff changeset
83 //
anatofuz
parents:
diff changeset
84 // QuerySymbolInfos may contain replicated elements. Because CorrectTypo
anatofuz
parents:
diff changeset
85 // callback doesn't always work as we expected. In somecases, it will be
anatofuz
parents:
diff changeset
86 // triggered at the same position or unidentified symbol multiple times.
anatofuz
parents:
diff changeset
87 std::sort(QuerySymbolInfos.begin(), QuerySymbolInfos.end(),
anatofuz
parents:
diff changeset
88 [&](const QuerySymbolInfo &A, const QuerySymbolInfo &B) {
anatofuz
parents:
diff changeset
89 return std::make_pair(A.Range.getOffset(), A.Range.getLength()) <
anatofuz
parents:
diff changeset
90 std::make_pair(B.Range.getOffset(), B.Range.getLength());
anatofuz
parents:
diff changeset
91 });
anatofuz
parents:
diff changeset
92 QuerySymbolInfos.erase(
anatofuz
parents:
diff changeset
93 std::unique(QuerySymbolInfos.begin(), QuerySymbolInfos.end(),
anatofuz
parents:
diff changeset
94 [](const QuerySymbolInfo &A, const QuerySymbolInfo &B) {
anatofuz
parents:
diff changeset
95 return A.Range == B.Range;
anatofuz
parents:
diff changeset
96 }),
anatofuz
parents:
diff changeset
97 QuerySymbolInfos.end());
anatofuz
parents:
diff changeset
98 for (const auto &Symbol : MatchedSymbols) {
anatofuz
parents:
diff changeset
99 HeaderInfos.push_back(
anatofuz
parents:
diff changeset
100 {Symbol.getFilePath().str(),
anatofuz
parents:
diff changeset
101 createQualifiedNameForReplacement(
anatofuz
parents:
diff changeset
102 QuerySymbolInfos.front().RawIdentifier,
anatofuz
parents:
diff changeset
103 QuerySymbolInfos.front().ScopedQualifiers, Symbol)});
anatofuz
parents:
diff changeset
104 }
anatofuz
parents:
diff changeset
105 // Deduplicate header infos.
anatofuz
parents:
diff changeset
106 HeaderInfos.erase(std::unique(HeaderInfos.begin(), HeaderInfos.end(),
anatofuz
parents:
diff changeset
107 [](const HeaderInfo &A, const HeaderInfo &B) {
anatofuz
parents:
diff changeset
108 return A.Header == B.Header &&
anatofuz
parents:
diff changeset
109 A.QualifiedName == B.QualifiedName;
anatofuz
parents:
diff changeset
110 }),
anatofuz
parents:
diff changeset
111 HeaderInfos.end());
anatofuz
parents:
diff changeset
112 }
anatofuz
parents:
diff changeset
113
anatofuz
parents:
diff changeset
114 } // include_fixer
anatofuz
parents:
diff changeset
115 } // clang