cppsourceprocessor_test.cpp 6.89 KB
Newer Older
1 2
/****************************************************************************
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
** Contact: http://www.qt-project.org/legal
**
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#include "cpptoolsplugin.h"

#include "cppmodelmanager.h"
33 34
#include "cppsourceprocessertesthelper.h"
#include "cppsourceprocessor.h"
35 36
#include "cppsnapshotupdater.h"
#include "cpptoolseditorsupport.h"
37
#include "cpptoolstestcase.h"
38

39 40
#include <texteditor/basetexteditor.h>

41 42 43
#include <cplusplus/CppDocument.h>
#include <utils/fileutils.h>

44 45
#include <QFile>
#include <QFileInfo>
46 47 48 49
#include <QtTest>

using namespace CPlusPlus;
using namespace CppTools;
50
using namespace CppTools::Tests;
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
using namespace CppTools::Internal;

typedef Document::Include Include;

class SourcePreprocessor
{
public:
    SourcePreprocessor()
        : m_cmm(CppModelManager::instance())
    {
        cleanUp();
    }

    Document::Ptr run(const QByteArray &source)
    {
66
        const QString fileName = TestIncludePaths::testFilePath();
67

68 69 70
        FileWriterAndRemover scopedFile(fileName, source);
        if (!scopedFile.writtenSuccessfully())
            return Document::Ptr();
71

72 73 74
        CppSourceProcessor sourceProcessor((QPointer<CppModelManager>(m_cmm)));
        sourceProcessor.setIncludePaths(QStringList(TestIncludePaths::directoryOfTestFile()));
        sourceProcessor.run(fileName);
75

76
        Document::Ptr document = m_cmm->document(fileName);
77
        return document;
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
    }

    ~SourcePreprocessor()
    {
        cleanUp();
    }

private:
    void cleanUp()
    {
        m_cmm->GC();
        QVERIFY(m_cmm->snapshot().isEmpty());
    }

private:
    CppModelManager *m_cmm;
};

96
/// Check: Resolved and unresolved includes are properly tracked.
97
void CppToolsPlugin::test_cppsourceprocessor_includes_resolvedUnresolved()
98 99 100 101 102 103 104 105 106 107 108 109
{
    QByteArray source =
        "#include \"header.h\"\n"
        "#include \"notresolvable.h\"\n"
        "\n"
        ;

    SourcePreprocessor processor;
    Document::Ptr document = processor.run(source);
    QVERIFY(document);

    const QList<Document::Include> resolvedIncludes = document->resolvedIncludes();
110 111
    QCOMPARE(resolvedIncludes.size(), 1);
    QCOMPARE(resolvedIncludes.at(0).type(), Client::IncludeLocal);
112 113
    QCOMPARE(resolvedIncludes.at(0).unresolvedFileName(), QLatin1String("header.h"));
    const QString expectedResolvedFileName
114
            = TestIncludePaths::testFilePath(QLatin1String("header.h"));
115 116 117
    QCOMPARE(resolvedIncludes.at(0).resolvedFileName(), expectedResolvedFileName);

    const QList<Document::Include> unresolvedIncludes = document->unresolvedIncludes();
118 119
    QCOMPARE(unresolvedIncludes.size(), 1);
    QCOMPARE(unresolvedIncludes.at(0).type(), Client::IncludeLocal);
120 121 122
    QCOMPARE(unresolvedIncludes.at(0).unresolvedFileName(), QLatin1String("notresolvable.h"));
    QVERIFY(unresolvedIncludes.at(0).resolvedFileName().isEmpty());
}
123 124

/// Check: Avoid self-include entries due to cyclic includes.
125
void CppToolsPlugin::test_cppsourceprocessor_includes_cyclic()
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
{
    const QString fileName1 = TestIncludePaths::testFilePath(QLatin1String("cyclic1.h"));
    const QString fileName2 = TestIncludePaths::testFilePath(QLatin1String("cyclic2.h"));
    const QStringList sourceFiles = QStringList() << fileName1 << fileName2;

    // Create global snapshot (needed in SnapshotUpdater)
    TestCase testCase;
    testCase.parseFiles(sourceFiles);

    // Open editor
    TextEditor::BaseTextEditor *editor;
    QVERIFY(testCase.openBaseTextEditor(fileName1, &editor));
    testCase.closeEditorAtEndOfTestCase(editor);

    // Get editor snapshot
    CppEditorSupport *cppEditorSupport = CppModelManagerInterface::instance()
        ->cppEditorSupport(editor);
    QVERIFY(cppEditorSupport);
    QSharedPointer<SnapshotUpdater> snapshotUpdater = cppEditorSupport->snapshotUpdater();
    QVERIFY(snapshotUpdater);
    Snapshot snapshot = snapshotUpdater->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);
}
163 164

/// Check: All include errors are reported as diagnostic messages.
165
void CppToolsPlugin::test_cppsourceprocessor_includes_allDiagnostics()
166 167 168 169
{
    QByteArray source =
        "#include <NotResolvable1>\n"
        "#include <NotResolvable2>\n"
170
        "#include \"/some/nonexisting/file123.h\"\n"
171 172 173 174 175 176 177 178
        "\n"
        ;

    SourcePreprocessor processor;
    Document::Ptr document = processor.run(source);
    QVERIFY(document);

    QCOMPARE(document->resolvedIncludes().size(), 0);
179 180
    QCOMPARE(document->unresolvedIncludes().size(), 3);
    QCOMPARE(document->diagnosticMessages().size(), 3);
181
}
182

183
void CppToolsPlugin::test_cppsourceprocessor_macroUses()
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
{
    QByteArray source =
        "#define SOMEDEFINE 1\n"
        "#if SOMEDEFINE == 1\n"
        "    int someNumber;\n"
        "#endif\n"
        ;

    SourcePreprocessor processor;
    Document::Ptr document = processor.run(source);
    QVERIFY(document);
    const QList<Document::MacroUse> macroUses = document->macroUses();
    QCOMPARE(macroUses.size(), 1);
    const Document::MacroUse macroUse = macroUses.at(0);
    QCOMPARE(macroUse.bytesBegin(), 25U);
    QCOMPARE(macroUse.bytesEnd(), 35U);
    QCOMPARE(macroUse.utf16charsBegin(), 25U);
    QCOMPARE(macroUse.utf16charsEnd(), 35U);
    QCOMPARE(macroUse.beginLine(), 2U);
}