cpppreprocessor.cpp 13.2 KB
Newer Older
1
2
#include "cpppreprocessor.h"

Nikolai Kosjar's avatar
Nikolai Kosjar committed
3
4
#include "cppmodelmanager.h"

5
#include <utils/hostosinfo.h>
6
#include <utils/textfileformat.h>
7
8
9

#include <QCoreApplication>

10
11
12
13
14
15
16
17
18
19
20
21
/*!
 * \class CppTools::Internal::CppPreprocessor
 * \brief The CppPreprocessor class updates set of indexed C++ files.
 *
 * Indexed file is truncated version of fully parsed document: copy of source
 * code and full AST will be dropped when indexing is done. Working copy ensures
 * that documents with most recent copy placed in memory will be parsed correctly.
 *
 * \sa CPlusPlus::Document
 * \sa CppTools::CppModelManagerInterface::WorkingCopy
 */

22
23
24
25
using namespace CPlusPlus;
using namespace CppTools;
using namespace CppTools::Internal;

Nikolai Kosjar's avatar
Nikolai Kosjar committed
26
27
CppPreprocessor::CppPreprocessor(QPointer<CppModelManager> modelManager,
                                 bool dumpFileNameWhileParsing)
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
    : m_snapshot(modelManager->snapshot()),
      m_modelManager(modelManager),
      m_dumpFileNameWhileParsing(dumpFileNameWhileParsing),
      m_preprocess(this, &m_env),
      m_revision(0)
{
    m_preprocess.setKeepComments(true);
}

CppPreprocessor::~CppPreprocessor()
{ }

void CppPreprocessor::setRevision(unsigned revision)
{ m_revision = revision; }

void CppPreprocessor::setWorkingCopy(const CppModelManagerInterface::WorkingCopy &workingCopy)
{ m_workingCopy = workingCopy; }

void CppPreprocessor::setIncludePaths(const QStringList &includePaths)
{
    m_includePaths.clear();

    for (int i = 0; i < includePaths.size(); ++i) {
        const QString &path = includePaths.at(i);

        if (Utils::HostOsInfo::isMacHost()) {
            if (i + 1 < includePaths.size() && path.endsWith(QLatin1String(".framework/Headers"))) {
                const QFileInfo pathInfo(path);
                const QFileInfo frameworkFileInfo(pathInfo.path());
                const QString frameworkName = frameworkFileInfo.baseName();

                const QFileInfo nextIncludePath = includePaths.at(i + 1);
                if (nextIncludePath.fileName() == frameworkName) {
                    // We got a QtXXX.framework/Headers followed by $QTDIR/include/QtXXX.
                    // In this case we prefer to include files from $QTDIR/include/QtXXX.
                    continue;
                }
            }
        }
        m_includePaths.append(cleanPath(path));
    }
}

void CppPreprocessor::setFrameworkPaths(const QStringList &frameworkPaths)
{
    m_frameworkPaths.clear();
Nikolai Kosjar's avatar
Nikolai Kosjar committed
74
    foreach (const QString &frameworkPath, frameworkPaths)
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
        addFrameworkPath(frameworkPath);
}

// Add the given framework path, and expand private frameworks.
//
// Example:
//  <framework-path>/ApplicationServices.framework
// has private frameworks in:
//  <framework-path>/ApplicationServices.framework/Frameworks
// if the "Frameworks" folder exists inside the top level framework.
void CppPreprocessor::addFrameworkPath(const QString &frameworkPath)
{
    // The algorithm below is a bit too eager, but that's because we're not getting
    // in the frameworks we're linking against. If we would have that, then we could
    // add only those private frameworks.
Nikolai Kosjar's avatar
Nikolai Kosjar committed
90
    const QString cleanFrameworkPath = cleanPath(frameworkPath);
91
92
93
94
95
96
97
98
    if (!m_frameworkPaths.contains(cleanFrameworkPath))
        m_frameworkPaths.append(cleanFrameworkPath);

    const QDir frameworkDir(cleanFrameworkPath);
    const QStringList filter = QStringList() << QLatin1String("*.framework");
    foreach (const QFileInfo &framework, frameworkDir.entryInfoList(filter)) {
        if (!framework.isDir())
            continue;
Nikolai Kosjar's avatar
Nikolai Kosjar committed
99
100
        const QFileInfo privateFrameworks(framework.absoluteFilePath(),
                                          QLatin1String("Frameworks"));
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
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
        if (privateFrameworks.exists() && privateFrameworks.isDir())
            addFrameworkPath(privateFrameworks.absoluteFilePath());
    }
}

void CppPreprocessor::setTodo(const QStringList &files)
{ m_todo = QSet<QString>::fromList(files); }

namespace {
class Process: public std::unary_function<Document::Ptr, void>
{
    QPointer<CppModelManager> _modelManager;
    Document::Ptr _doc;
    Document::CheckMode _mode;

public:
    Process(QPointer<CppModelManager> modelManager,
            Document::Ptr doc,
            const CppModelManager::WorkingCopy &workingCopy)
        : _modelManager(modelManager),
          _doc(doc),
          _mode(Document::FastCheck)
    {
        if (workingCopy.contains(_doc->fileName()))
            _mode = Document::FullCheck;
    }

    void operator()()
    {
        _doc->check(_mode);

        if (_modelManager)
            _modelManager->emitDocumentUpdated(_doc);

        _doc->releaseSourceAndAST();
    }
};
} // end of anonymous namespace

void CppPreprocessor::run(const QString &fileName)
{
    sourceNeeded(0, fileName, IncludeGlobal);
}

void CppPreprocessor::removeFromCache(const QString &fileName)
{
    m_snapshot.remove(fileName);
}

void CppPreprocessor::resetEnvironment()
{
    m_env.reset();
    m_processed.clear();
154
    m_included.clear();
155
156
157
}

void CppPreprocessor::getFileContents(const QString &absoluteFilePath,
158
                                      QByteArray *contents,
159
160
161
162
163
164
                                      unsigned *revision) const
{
    if (absoluteFilePath.isEmpty())
        return;

    if (m_workingCopy.contains(absoluteFilePath)) {
165
        const QPair<QByteArray, unsigned> entry = m_workingCopy.get(absoluteFilePath);
166
167
168
169
170
171
172
        if (contents)
            *contents = entry.first;
        if (revision)
            *revision = entry.second;
        return;
    }

173
174
175
176
177
    QString errStr;
    if (contents)
        Utils::TextFileFormat::readFileUTF8(absoluteFilePath, contents, &errStr);
    if (revision)
        *revision = 0;
178
179
180
181
182
183
184
}

bool CppPreprocessor::checkFile(const QString &absoluteFilePath) const
{
    if (absoluteFilePath.isEmpty() || m_included.contains(absoluteFilePath))
        return true;

Nikolai Kosjar's avatar
Nikolai Kosjar committed
185
    const QFileInfo fileInfo(absoluteFilePath);
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
    return fileInfo.isFile() && fileInfo.isReadable();
}

/// Resolve the given file name to its absolute path w.r.t. the include type.
QString CppPreprocessor::resolveFile(const QString &fileName, IncludeType type)
{
    if (type == IncludeGlobal) {
        QHash<QString, QString>::ConstIterator it = m_fileNameCache.find(fileName);
        if (it != m_fileNameCache.end())
            return it.value();
        const QString fn = resolveFile_helper(fileName, type);
        m_fileNameCache.insert(fileName, fn);
        return fn;
    }

    // IncludeLocal, IncludeNext
    return resolveFile_helper(fileName, type);
}

QString CppPreprocessor::cleanPath(const QString &path)
{
    QString result = QDir::cleanPath(path);
    const QChar slash(QLatin1Char('/'));
    if (!result.endsWith(slash))
        result.append(slash);
    return result;
}

QString CppPreprocessor::resolveFile_helper(const QString &fileName, IncludeType type)
{
Nikolai Kosjar's avatar
Nikolai Kosjar committed
216
    const QFileInfo fileInfo(fileName);
217
218
219
220
    if (fileName == Preprocessor::configurationFileName || fileInfo.isAbsolute())
        return fileName;

    if (type == IncludeLocal && m_currentDoc) {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
221
222
        const QFileInfo currentFileInfo(m_currentDoc->fileName());
        const QString path = cleanPath(currentFileInfo.absolutePath()) + fileName;
223
224
        if (checkFile(path))
            return path;
225
226
        // Fall through! "16.2 Source file inclusion" from the standard states to continue
        // searching as if this would be a global include.
227
228
229
    }

    foreach (const QString &includePath, m_includePaths) {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
230
        const QString path = includePath + fileName;
231
        if (m_workingCopy.contains(path) || checkFile(path))
232
233
234
            return path;
    }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
235
    const int index = fileName.indexOf(QLatin1Char('/'));
236
    if (index != -1) {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
237
238
239
        const QString frameworkName = fileName.left(index);
        const QString name = frameworkName + QLatin1String(".framework/Headers/")
            + fileName.mid(index + 1);
240
241

        foreach (const QString &frameworkPath, m_frameworkPaths) {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
242
            const QString path = frameworkPath + name;
243
244
245
246
247
248
249
250
251
252
            if (checkFile(path))
                return path;
        }
    }

    return QString();
}

void CppPreprocessor::macroAdded(const Macro &macro)
{
253
    if (!m_currentDoc)
254
255
256
257
258
        return;

    m_currentDoc->appendMacro(macro);
}

Nikolai Kosjar's avatar
Nikolai Kosjar committed
259
260
static inline const Macro revision(const CppModelManagerInterface::WorkingCopy &s,
                                   const Macro &macro)
261
262
263
264
265
266
267
268
{
    Macro newMacro(macro);
    newMacro.setFileRevision(s.get(macro.fileName()).second);
    return newMacro;
}

void CppPreprocessor::passedMacroDefinitionCheck(unsigned offset, unsigned line, const Macro &macro)
{
269
    if (!m_currentDoc)
270
271
272
273
274
275
276
277
        return;

    m_currentDoc->addMacroUse(revision(m_workingCopy, macro), offset, macro.name().length(), line,
                              QVector<MacroArgumentReference>());
}

void CppPreprocessor::failedMacroDefinitionCheck(unsigned offset, const ByteArrayRef &name)
{
278
    if (!m_currentDoc)
279
280
281
282
283
284
285
        return;

    m_currentDoc->addUndefinedMacroUse(QByteArray(name.start(), name.size()), offset);
}

void CppPreprocessor::notifyMacroReference(unsigned offset, unsigned line, const Macro &macro)
{
286
    if (!m_currentDoc)
287
288
289
290
291
292
293
294
295
296
        return;

    m_currentDoc->addMacroUse(revision(m_workingCopy, macro), offset, macro.name().length(), line,
                              QVector<MacroArgumentReference>());
}

void CppPreprocessor::startExpandingMacro(unsigned offset, unsigned line,
                                          const Macro &macro,
                                          const QVector<MacroArgumentReference> &actuals)
{
297
    if (!m_currentDoc)
298
299
        return;

Nikolai Kosjar's avatar
Nikolai Kosjar committed
300
301
    m_currentDoc->addMacroUse(revision(m_workingCopy, macro), offset, macro.name().length(), line,
                              actuals);
302
303
304
305
}

void CppPreprocessor::stopExpandingMacro(unsigned, const Macro &)
{
306
    if (!m_currentDoc)
307
308
309
310
311
312
313
314
315
316
317
318
319
        return;
}

void CppPreprocessor::markAsIncludeGuard(const QByteArray &macroName)
{
    if (!m_currentDoc)
        return;

    m_currentDoc->setIncludeGuardMacroName(macroName);
}

void CppPreprocessor::mergeEnvironment(Document::Ptr doc)
{
320
    if (!doc)
321
322
323
324
325
326
327
328
329
        return;

    const QString fn = doc->fileName();

    if (m_processed.contains(fn))
        return;

    m_processed.insert(fn);

330
    foreach (const Document::Include &incl, doc->resolvedIncludes()) {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
331
        const QString includedFile = incl.resolvedFileName();
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360

        if (Document::Ptr includedDoc = m_snapshot.document(includedFile))
            mergeEnvironment(includedDoc);
        else
            run(includedFile);
    }

    m_env.addMacros(doc->definedMacros());
}

void CppPreprocessor::startSkippingBlocks(unsigned offset)
{
    if (m_currentDoc)
        m_currentDoc->startSkippingBlocks(offset);
}

void CppPreprocessor::stopSkippingBlocks(unsigned offset)
{
    if (m_currentDoc)
        m_currentDoc->stopSkippingBlocks(offset);
}

void CppPreprocessor::sourceNeeded(unsigned line, const QString &fileName, IncludeType type)
{
    if (fileName.isEmpty())
        return;

    QString absoluteFileName = resolveFile(fileName, type);
    absoluteFileName = QDir::cleanPath(absoluteFileName);
361
    if (m_currentDoc)
362
        m_currentDoc->addIncludeFile(Document::Include(fileName, absoluteFileName, line, type));
363
364
365
366
367
368
    if (m_included.contains(absoluteFileName))
        return; // we've already seen this file.
    if (absoluteFileName != modelManager()->configurationFileName())
        m_included.insert(absoluteFileName);

    unsigned editorRevision = 0;
369
    QByteArray contents;
370
371
    getFileContents(absoluteFileName, &contents, &editorRevision);
    if (m_currentDoc) {
372
        if (contents.isEmpty() && !QFileInfo(absoluteFileName).isAbsolute()) {
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
            QString msg = QCoreApplication::translate(
                    "CppPreprocessor", "%1: No such file or directory").arg(fileName);

            Document::DiagnosticMessage d(Document::DiagnosticMessage::Warning,
                                          m_currentDoc->fileName(),
                                          line, /*column = */ 0,
                                          msg);

            m_currentDoc->addDiagnosticMessage(d);
            return;
        }
    }

    if (m_dumpFileNameWhileParsing) {
        qDebug() << "Parsing file:" << absoluteFileName
Nikolai Kosjar's avatar
Nikolai Kosjar committed
388
389
                 << "contents:" << contents.size()
        ;
390
391
392
393
394
395
396
397
398
399
400
401
    }

    Document::Ptr doc = m_snapshot.document(absoluteFileName);
    if (doc) {
        mergeEnvironment(doc);
        return;
    }

    doc = Document::create(absoluteFileName);
    doc->setRevision(m_revision);
    doc->setEditorRevision(editorRevision);

Nikolai Kosjar's avatar
Nikolai Kosjar committed
402
    const QFileInfo info(absoluteFileName);
403
404
405
    if (info.exists())
        doc->setLastModified(info.lastModified());

Nikolai Kosjar's avatar
Nikolai Kosjar committed
406
    const Document::Ptr previousDoc = switchDocument(doc);
407
408

    const QByteArray preprocessedCode = m_preprocess.run(absoluteFileName, contents);
Nikolai Kosjar's avatar
Nikolai Kosjar committed
409
410
411
412
413
414
//    {
//        QByteArray b(preprocessedCode);
//        b.replace("\n", "<<<\n");
//        qDebug("Preprocessed code for \"%s\": [[%s]]", fileName.toUtf8().constData(),
//               b.constData());
//    }
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430

    doc->setUtf8Source(preprocessedCode);
    doc->keepSourceAndAST();
    doc->tokenize();

    m_snapshot.insert(doc);
    m_todo.remove(absoluteFileName);

    Process process(m_modelManager, doc, m_workingCopy);
    process();

    (void) switchDocument(previousDoc);
}

Document::Ptr CppPreprocessor::switchDocument(Document::Ptr doc)
{
Nikolai Kosjar's avatar
Nikolai Kosjar committed
431
    const Document::Ptr previousDoc = m_currentDoc;
432
433
434
    m_currentDoc = doc;
    return previousDoc;
}