CppEditor: Remove using directive at global scope always in all files

Previously only using directives in the global scope that followed the
quickfixed using directive were removed

Change-Id: I330acfe3236a6845fd1667f9fa699ab6c8fb560d
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
This commit is contained in:
Leander Schulten
2020-11-15 23:52:56 +01:00
parent d3ab7a89f9
commit 92667c779c
2 changed files with 137 additions and 23 deletions

View File

@@ -6663,6 +6663,26 @@ void CppEditorPlugin::test_quickfix_removeUsingNamespace_data()
"}\n" "}\n"
"foo foos;\n"; "foo foos;\n";
// like header1 but without "using namespace std;\n"
QByteArray expected1 = "namespace std{\n"
" template<typename T>\n"
" class vector{};\n"
" namespace chrono{\n"
" using seconds = int;\n"
" }\n"
"}\n"
"namespace test{\n"
" class vector{\n"
" std::vector<int> ints;\n"
" };\n"
"}\n";
// like header2 but without "using namespace std;\n" and with std::vector
QByteArray expected2 = "#include \"header1.h\"\n"
"using foo = test::vector;\n"
"using namespace test;\n"
"std::vector<int> others;\n";
QByteArray expected3 = "#include \"header2.h\"\n" QByteArray expected3 = "#include \"header2.h\"\n"
"using namespace std::chrono;\n" "using namespace std::chrono;\n"
"namespace test{\n" "namespace test{\n"
@@ -6683,22 +6703,18 @@ void CppEditorPlugin::test_quickfix_removeUsingNamespace_data()
QTest::newRow("remove only in one file local") QTest::newRow("remove only in one file local")
<< header1 << header2 << h3 << header1 << header2 << expected3 << 0; << header1 << header2 << h3 << header1 << header2 << expected3 << 0;
QTest::newRow("remove only in one file globally") QTest::newRow("remove only in one file globally")
<< header1 << header2 << h3 << header1 << header2 << expected3 << 1; << header1 << header2 << h3 << expected1 << expected2 << expected3 << 1;
QByteArray h2 = "#include \"header1.h\"\n" QByteArray h2 = "#include \"header1.h\"\n"
"using foo = test::vector;\n" "using foo = test::vector;\n"
"using namespace s@td;\n" "using namespace s@td;\n"
"using namespace test;\n" "using namespace test;\n"
"vector<int> others;\n"; "vector<int> others;\n";
QByteArray expected2 = "#include \"header1.h\"\n"
"using foo = test::vector;\n"
"using namespace test;\n"
"std::vector<int> others;\n";
QTest::newRow("remove across two files only this") QTest::newRow("remove across two files only this")
<< header1 << h2 << header3 << header1 << expected2 << header3 << 0; << header1 << h2 << header3 << header1 << expected2 << header3 << 0;
QTest::newRow("remove across two files globally1") QTest::newRow("remove across two files globally1")
<< header1 << h2 << header3 << header1 << expected2 << expected3 << 1; << header1 << h2 << header3 << expected1 << expected2 << expected3 << 1;
QByteArray h1 = "namespace std{\n" QByteArray h1 = "namespace std{\n"
" template<typename T>\n" " template<typename T>\n"
@@ -6713,18 +6729,6 @@ void CppEditorPlugin::test_quickfix_removeUsingNamespace_data()
" std::vector<int> ints;\n" " std::vector<int> ints;\n"
" };\n" " };\n"
"}\n"; "}\n";
QByteArray expected1 = "namespace std{\n"
" template<typename T>\n"
" class vector{};\n"
" namespace chrono{\n"
" using seconds = int;\n"
" }\n"
"}\n"
"namespace test{\n"
" class vector{\n"
" std::vector<int> ints;\n"
" };\n"
"}\n";
QTest::newRow("remove across tree files only this") QTest::newRow("remove across tree files only this")
<< h1 << header2 << header3 << expected1 << header2 << header3 << 0; << h1 << header2 << header3 << expected1 << header2 << header3 << 0;
@@ -6779,6 +6783,15 @@ void CppEditorPlugin::test_quickfix_removeUsingNamespace_data()
QTest::newRow("existing namespace") QTest::newRow("existing namespace")
<< header1 << h2 << header3 << header1 << expected2 << header3 << 1; << header1 << h2 << header3 << header1 << expected2 << header3 << 1;
// test: remove using directive at global scope in every file
h1 = "using namespace tes@t;";
h2 = "using namespace test;";
h3 = "using namespace test;";
expected1 = expected2 = expected3 = "";
QTest::newRow("global scope remove in every file")
<< h1 << h2 << h3 << expected1 << expected2 << expected3 << 1;
} }
void CppEditorPlugin::test_quickfix_removeUsingNamespace() void CppEditorPlugin::test_quickfix_removeUsingNamespace()

View File

@@ -57,6 +57,7 @@
#include <projectexplorer/projectnodes.h> #include <projectexplorer/projectnodes.h>
#include <projectexplorer/projecttree.h> #include <projectexplorer/projecttree.h>
#include <projectexplorer/session.h>
#include <utils/algorithm.h> #include <utils/algorithm.h>
#include <utils/basetreeview.h> #include <utils/basetreeview.h>
@@ -7405,6 +7406,7 @@ void removeLine(const CppRefactoringFile *file, AST *ast, ChangeSet &changeSet)
class RemoveNamespaceVisitor : public ASTVisitor class RemoveNamespaceVisitor : public ASTVisitor
{ {
public: public:
constexpr static int SearchGlobalUsingDirectivePos = std::numeric_limits<int>::max();
RemoveNamespaceVisitor(const CppRefactoringFile *file, RemoveNamespaceVisitor(const CppRefactoringFile *file,
const Snapshot &snapshot, const Snapshot &snapshot,
const Name *namespace_, const Name *namespace_,
@@ -7443,8 +7445,16 @@ private:
bool preVisit(AST *ast) override bool preVisit(AST *ast) override
{ {
if (!m_start) { if (!m_start) {
if (ast->asTranslationUnit())
return true;
if (UsingDirectiveAST *usingDirective = ast->asUsingDirective()) { if (UsingDirectiveAST *usingDirective = ast->asUsingDirective()) {
if (nameEqual(usingDirective->name->name, m_namespace)) { if (nameEqual(usingDirective->name->name, m_namespace)) {
if (m_symbolPos == SearchGlobalUsingDirectivePos) {
// we have found a global using directive, so lets start
m_start = true;
removeLine(m_file, ast, m_changeSet);
return false;
}
// ignore the using namespace that should be removed // ignore the using namespace that should be removed
if (m_file->endOf(ast) != m_symbolPos) { if (m_file->endOf(ast) != m_symbolPos) {
if (m_removeAllAtGlobalScope) if (m_removeAllAtGlobalScope)
@@ -7630,6 +7640,17 @@ private:
class RemoveUsingNamespaceOperation : public CppQuickFixOperation class RemoveUsingNamespaceOperation : public CppQuickFixOperation
{ {
struct Node
{
Document::Ptr document;
bool processed = false;
bool hasGlobalUsingDirective = false;
std::vector<std::reference_wrapper<Node>> includes;
Node() = default;
Node(const Node &) = delete;
Node(Node &&) = delete;
};
public: public:
RemoveUsingNamespaceOperation(const CppQuickFixInterface &interface, RemoveUsingNamespaceOperation(const CppQuickFixInterface &interface,
UsingDirectiveAST *usingDirective, UsingDirectiveAST *usingDirective,
@@ -7654,12 +7675,90 @@ public:
} }
private: private:
std::map<Utils::FilePath, Node> buildIncludeGraph(CppRefactoringChanges &refactoring)
{
using namespace ProjectExplorer;
using namespace Utils;
const Snapshot &s = refactoring.snapshot();
std::map<Utils::FilePath, Node> includeGraph;
auto handleFile = [&](const FilePath &filePath, Document::Ptr doc, auto shouldHandle) {
Node &node = includeGraph[filePath];
node.document = doc;
for (const Document::Include &include : doc->resolvedIncludes()) {
const auto filePath = FilePath::fromString(include.resolvedFileName());
if (shouldHandle(filePath)) {
Node &includedNode = includeGraph[filePath];
node.includes.push_back(includedNode);
}
}
};
if (const Project *project = SessionManager::projectForFile(filePath())) {
const FilePaths files = project->files(ProjectExplorer::Project::SourceFiles);
QSet<FilePath> projectFiles(files.begin(), files.end());
for (const auto &file : files) {
const Document::Ptr doc = s.document(file);
if (!doc)
continue;
handleFile(file, doc, [&](const FilePath &file) {
return projectFiles.contains(file);
});
}
} else {
for (auto i = s.begin(); i != s.end(); ++i) {
if (ProjectFile::classify(i.key().toString()) != ProjectFile::Unsupported) {
handleFile(i.key(), i.value(), [](const FilePath &file) {
return ProjectFile::classify(file.toString()) != ProjectFile::Unsupported;
});
}
}
}
return includeGraph;
}
void removeAllUsingsAtGlobalScope(CppRefactoringChanges &refactoring)
{
auto includeGraph = buildIncludeGraph(refactoring);
std::list<std::reference_wrapper<Node>> unprocessedNodes;
for (auto &[_, node] : includeGraph) {
Q_UNUSED(_)
unprocessedNodes.push_back(node);
}
while (!unprocessedNodes.empty()) {
for (auto i = unprocessedNodes.begin(); i != unprocessedNodes.end();) {
Node &node = *i;
if (Utils::allOf(node.includes, &Node::processed)) {
CppRefactoringFilePtr file = refactoring.file(node.document->fileName());
const bool parentHasUsing = Utils::anyOf(node.includes,
&Node::hasGlobalUsingDirective);
const int startPos = parentHasUsing
? 0
: RemoveNamespaceVisitor::SearchGlobalUsingDirectivePos;
const bool noGlobalUsing = refactorFile(file, refactoring.snapshot(), startPos);
node.hasGlobalUsingDirective = !noGlobalUsing || parentHasUsing;
node.processed = true;
i = unprocessedNodes.erase(i);
} else {
++i;
}
}
}
}
void perform() override void perform() override
{ {
CppRefactoringChanges refactoring(snapshot()); CppRefactoringChanges refactoring(snapshot());
CppRefactoringFilePtr currentFile = refactoring.file(filePath().toString()); CppRefactoringFilePtr currentFile = refactoring.file(filePath().toString());
if (refactorFile(currentFile, refactoring.snapshot(), currentFile->endOf(m_usingDirective), true)) if (m_removeAllAtGlobalScope) {
removeAllUsingsAtGlobalScope(refactoring);
} else if (refactorFile(currentFile,
refactoring.snapshot(),
currentFile->endOf(m_usingDirective),
true)) {
processIncludes(refactoring, filePath().toString()); processIncludes(refactoring, filePath().toString());
}
for (auto &file : m_changes) for (auto &file : m_changes)
file->apply(); file->apply();
@@ -7687,10 +7786,12 @@ private:
Utils::ChangeSet changes = visitor.getChanges(); Utils::ChangeSet changes = visitor.getChanges();
if (removeUsing) if (removeUsing)
removeLine(file.get(), m_usingDirective, changes); removeLine(file.get(), m_usingDirective, changes);
file->setChangeSet(changes); if (!changes.isEmpty()) {
// apply changes at the end, otherwise the symbol finder will fail to resolve symbols if file->setChangeSet(changes);
// the using namespace is missing // apply changes at the end, otherwise the symbol finder will fail to resolve symbols if
m_changes.insert(file); // the using namespace is missing
m_changes.insert(file);
}
return visitor.isGlobalUsingNamespace() && !visitor.foundGlobalUsingNamespace(); return visitor.isGlobalUsingNamespace() && !visitor.foundGlobalUsingNamespace();
} }