From 284817fae6514701902ccdb834c2faa46462f2e8 Mon Sep 17 00:00:00 2001 From: Christian Kandeler Date: Mon, 30 Aug 2021 10:58:08 +0200 Subject: Merge CppTools into CppEditor There was no proper separation of responsibilities between these plugins. In particular, CppTools had lots of editor-related functionality, so it's not clear why it was separated out in the first place. In fact, for a lot of code, it seemed quite arbitrary where it was put (just one example: switchHeaderSource() was in CppTools, wheras switchDeclarationDefinition() was in CppEditor). Merging the plugins will enable us to get rid of various convoluted pseudo-abstractions that were only introduced to keep up the artificial separation. Change-Id: Iafc3bce625b4794f6d4aa03df6cddc7f2d26716a Reviewed-by: Christian Stenger --- src/plugins/cpptools/cppsourceprocessor_test.cpp | 219 ----------------------- 1 file changed, 219 deletions(-) delete mode 100644 src/plugins/cpptools/cppsourceprocessor_test.cpp (limited to 'src/plugins/cpptools/cppsourceprocessor_test.cpp') diff --git a/src/plugins/cpptools/cppsourceprocessor_test.cpp b/src/plugins/cpptools/cppsourceprocessor_test.cpp deleted file mode 100644 index 35503af42a..0000000000 --- a/src/plugins/cpptools/cppsourceprocessor_test.cpp +++ /dev/null @@ -1,219 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of Qt Creator. -** -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -****************************************************************************/ - -#include "cppsourceprocessor_test.h" - -#include "baseeditordocumentprocessor.h" -#include "cppmodelmanager.h" -#include "cppsourceprocessertesthelper.h" -#include "cppsourceprocessor.h" -#include "cpptoolsbridge.h" -#include "cpptoolstestcase.h" -#include "editordocumenthandle.h" - -#include -#include - -#include -#include - -#include -#include -#include - -using namespace CPlusPlus; -using namespace CppTools; -using namespace CppTools::Tests; -using namespace CppTools::Internal; -using ProjectExplorer::HeaderPathType; - -using Include = Document::Include; - -class SourcePreprocessor -{ -public: - SourcePreprocessor() - : m_cmm(CppModelManager::instance()) - { - cleanUp(); - } - - Document::Ptr run(const QString &filePath) const - { - QScopedPointer sourceProcessor( - CppModelManager::createSourceProcessor()); - sourceProcessor->setHeaderPaths({ProjectExplorer::HeaderPath::makeUser( - TestIncludePaths::directoryOfTestFile())}); - sourceProcessor->run(filePath); - - Document::Ptr document = m_cmm->document(filePath); - return document; - } - - ~SourcePreprocessor() - { - cleanUp(); - } - -private: - void cleanUp() - { - m_cmm->GC(); - QVERIFY(m_cmm->snapshot().isEmpty()); - } - -private: - CppModelManager *m_cmm; -}; - -/// Check: Resolved and unresolved includes are properly tracked. -void SourceProcessorTest::testIncludesResolvedUnresolved() -{ - const QString testFilePath - = TestIncludePaths::testFilePath(QLatin1String("test_main_resolvedUnresolved.cpp")); - - SourcePreprocessor processor; - Document::Ptr document = processor.run(testFilePath); - QVERIFY(document); - - const QList resolvedIncludes = document->resolvedIncludes(); - QCOMPARE(resolvedIncludes.size(), 1); - QCOMPARE(resolvedIncludes.at(0).type(), Client::IncludeLocal); - QCOMPARE(resolvedIncludes.at(0).unresolvedFileName(), QLatin1String("header.h")); - const QString expectedResolvedFileName - = TestIncludePaths::testFilePath(QLatin1String("header.h")); - QCOMPARE(resolvedIncludes.at(0).resolvedFileName(), expectedResolvedFileName); - - const QList unresolvedIncludes = document->unresolvedIncludes(); - QCOMPARE(unresolvedIncludes.size(), 1); - QCOMPARE(unresolvedIncludes.at(0).type(), Client::IncludeLocal); - QCOMPARE(unresolvedIncludes.at(0).unresolvedFileName(), QLatin1String("notresolvable.h")); - QVERIFY(unresolvedIncludes.at(0).resolvedFileName().isEmpty()); -} - -/// Check: Avoid self-include entries due to cyclic includes. -void SourceProcessorTest::testIncludesCyclic() -{ - const QString fileName1 = TestIncludePaths::testFilePath(QLatin1String("cyclic1.h")); - const QString fileName2 = TestIncludePaths::testFilePath(QLatin1String("cyclic2.h")); - const QSet sourceFiles = QSet() << fileName1 << fileName2; - - // Create global snapshot (needed in BuiltinEditorDocumentParser) - TestCase testCase; - testCase.parseFiles(sourceFiles); - - // Open editor - TextEditor::BaseTextEditor *editor; - QVERIFY(testCase.openBaseTextEditor(fileName1, &editor)); - testCase.closeEditorAtEndOfTestCase(editor); - - // Check editor snapshot - const QString filePath = editor->document()->filePath().toString(); - auto *processor = CppToolsBridge::baseEditorDocumentProcessor(filePath); - QVERIFY(processor); - QVERIFY(TestCase::waitForProcessedEditorDocument(filePath)); - Snapshot snapshot = processor->snapshot(); - QCOMPARE(snapshot.size(), 3); // Configuration file included - - // Check includes - Document::Ptr doc1 = snapshot.document(fileName1); - QVERIFY(doc1); - Document::Ptr doc2 = snapshot.document(fileName2); - QVERIFY(doc2); - - QCOMPARE(doc1->unresolvedIncludes().size(), 0); - QCOMPARE(doc1->resolvedIncludes().size(), 1); - QCOMPARE(doc1->resolvedIncludes().first().resolvedFileName(), fileName2); - - QCOMPARE(doc2->unresolvedIncludes().size(), 0); - QCOMPARE(doc2->resolvedIncludes().size(), 1); - QCOMPARE(doc2->resolvedIncludes().first().resolvedFileName(), fileName1); -} - -/// Check: All include errors are reported as diagnostic messages. -void SourceProcessorTest::testIncludesAllDiagnostics() -{ - const QString testFilePath - = TestIncludePaths::testFilePath(QLatin1String("test_main_allDiagnostics.cpp")); - - SourcePreprocessor processor; - Document::Ptr document = processor.run(testFilePath); - QVERIFY(document); - - QCOMPARE(document->resolvedIncludes().size(), 0); - QCOMPARE(document->unresolvedIncludes().size(), 3); - QCOMPARE(document->diagnosticMessages().size(), 3); -} - -void SourceProcessorTest::testMacroUses() -{ - const QString testFilePath - = TestIncludePaths::testFilePath(QLatin1String("test_main_macroUses.cpp")); - - SourcePreprocessor processor; - Document::Ptr document = processor.run(testFilePath); - QVERIFY(document); - const QList macroUses = document->macroUses(); - QCOMPARE(macroUses.size(), 1); - const Document::MacroUse macroUse = macroUses.at(0); - QCOMPARE(macroUse.bytesBegin(), 25); - QCOMPARE(macroUse.bytesEnd(), 35); - QCOMPARE(macroUse.utf16charsBegin(), 25); - QCOMPARE(macroUse.utf16charsEnd(), 35); - QCOMPARE(macroUse.beginLine(), 2); -} - -static bool isMacroDefinedInDocument(const QByteArray ¯oName, const Document::Ptr &document) -{ - foreach (const Macro ¯o, document->definedMacros()) { - if (macro.name() == macroName) - return true; - } - - return false; -} - -static inline QString _(const QByteArray &ba) { return QString::fromLatin1(ba, ba.size()); } - -void SourceProcessorTest::testIncludeNext() -{ - const Core::Tests::TestDataDir data( - _(SRCDIR "/../../../tests/auto/cplusplus/preprocessor/data/include_next-data/")); - const QString mainFilePath = data.file(QLatin1String("main.cpp")); - const QString customHeaderPath = data.directory(QLatin1String("customIncludePath")); - const QString systemHeaderPath = data.directory(QLatin1String("systemIncludePath")); - - CppSourceProcessor::DocumentCallback documentCallback = [](const Document::Ptr &){}; - CppSourceProcessor sourceProcessor(Snapshot(), documentCallback); - sourceProcessor.setHeaderPaths(ProjectExplorer::toUserHeaderPaths( - QStringList{customHeaderPath, systemHeaderPath})); - - sourceProcessor.run(mainFilePath); - const Snapshot snapshot = sourceProcessor.snapshot(); - QVERIFY(!snapshot.isEmpty()); - const Document::Ptr mainDocument = snapshot.document(mainFilePath); - QVERIFY(mainDocument); - QVERIFY(isMacroDefinedInDocument("OK_FEATURE_X_ENABLED", mainDocument)); -} -- cgit v1.2.1