cpptodoitemsscanner.cpp 4.5 KB
Newer Older
Dmitry Savchenko's avatar
Dmitry Savchenko committed
1 2
/**************************************************************************
**
Eike Ziller's avatar
Eike Ziller committed
3 4 5
** Copyright (C) 2015 Dmitry Savchenko
** Copyright (C) 2015 Vasiliy Sorokin
** Contact: http://www.qt.io/licensing
Dmitry Savchenko's avatar
Dmitry Savchenko committed
6
**
hjk's avatar
hjk committed
7
** This file is part of Qt Creator.
Dmitry Savchenko's avatar
Dmitry Savchenko committed
8
**
hjk's avatar
hjk committed
9 10 11 12
** 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
Eike Ziller's avatar
Eike Ziller committed
13 14
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Eike Ziller's avatar
Eike Ziller committed
15
** use the contact form at http://www.qt.io/contact-us.
Dmitry Savchenko's avatar
Dmitry Savchenko committed
16 17
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
18
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
19 20 21 22 23 24
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
hjk's avatar
hjk committed
25
**
Eike Ziller's avatar
Eike Ziller committed
26 27
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
Dmitry Savchenko's avatar
Dmitry Savchenko committed
28 29
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
30
****************************************************************************/
Dmitry Savchenko's avatar
Dmitry Savchenko committed
31 32 33 34

#include "cpptodoitemsscanner.h"

#include <projectexplorer/project.h>
35
#include <cplusplus/TranslationUnit.h>
Dmitry Savchenko's avatar
Dmitry Savchenko committed
36

Orgad Shaneh's avatar
Orgad Shaneh committed
37 38
#include <cctype>

Dmitry Savchenko's avatar
Dmitry Savchenko committed
39 40 41 42 43 44
namespace Todo {
namespace Internal {

CppTodoItemsScanner::CppTodoItemsScanner(const KeywordList &keywordList, QObject *parent) :
    TodoItemsScanner(keywordList, parent)
{
45
    CppTools::CppModelManager *modelManager = CppTools::CppModelManager::instance();
Dmitry Savchenko's avatar
Dmitry Savchenko committed
46

Montel Laurent's avatar
Montel Laurent committed
47 48
    connect(modelManager, &CppTools::CppModelManager::documentUpdated,
            this, &CppTodoItemsScanner::documentUpdated, Qt::DirectConnection);
49 50

    setParams(keywordList);
Dmitry Savchenko's avatar
Dmitry Savchenko committed
51 52
}

53
void CppTodoItemsScanner::scannerParamsChanged()
Dmitry Savchenko's avatar
Dmitry Savchenko committed
54 55 56 57
{
    // We need to rescan everything known to the code model
    // TODO: It would be nice to only tokenize the source files, not update the code model entirely.

58
    CppTools::CppModelManager *modelManager = CppTools::CppModelManager::instance();
Dmitry Savchenko's avatar
Dmitry Savchenko committed
59

60
    QSet<QString> filesToBeUpdated;
61
    foreach (const CppTools::ProjectInfo &info, modelManager->projectInfos())
62
        filesToBeUpdated.unite(info.project().data()->files(ProjectExplorer::Project::SourceFiles).toSet());
Dmitry Savchenko's avatar
Dmitry Savchenko committed
63 64 65 66 67 68

    modelManager->updateSourceFiles(filesToBeUpdated);
}

void CppTodoItemsScanner::documentUpdated(CPlusPlus::Document::Ptr doc)
{
69
    CppTools::CppModelManager *modelManager = CppTools::CppModelManager::instance();
70
    if (!modelManager->projectPart(doc->fileName()).isEmpty())
Dmitry Savchenko's avatar
Dmitry Savchenko committed
71 72 73 74 75 76 77 78 79 80 81 82
        processDocument(doc);
}

void CppTodoItemsScanner::processDocument(CPlusPlus::Document::Ptr doc)
{
    QList<TodoItem> itemList;
    CPlusPlus::TranslationUnit *translationUnit = doc->translationUnit();

    for (unsigned i = 0; i < translationUnit->commentCount(); ++i) {

        // Get comment source
        CPlusPlus::Token token = doc->translationUnit()->commentAt(i);
Nikolai Kosjar's avatar
Nikolai Kosjar committed
83
        QByteArray source = doc->utf8Source().mid(token.bytesBegin(), token.bytes()).trimmed();
Dmitry Savchenko's avatar
Dmitry Savchenko committed
84 85 86 87 88 89 90 91

        if ((token.kind() == CPlusPlus::T_COMMENT) || (token.kind() == CPlusPlus::T_DOXY_COMMENT)) {
            // Remove trailing "*/"
            source = source.left(source.length() - 2);
        }

        // Process every line of the comment
        unsigned lineNumber = 0;
92
        translationUnit->getPosition(token.utf16charsBegin(), &lineNumber);
93 94 95 96 97 98 99 100

        for (int from = 0, sz = source.size(); from < sz; ++lineNumber) {
            int to = source.indexOf('\n', from);
            if (to == -1)
                to = sz - 1;

            const char *start = source.constData() + from;
            const char *end = source.constData() + to;
101
            while (start != end && std::isspace((unsigned char)*start))
102
                ++start;
103
            while (start != end && std::isspace((unsigned char)*end))
104 105 106 107 108 109 110 111
                --end;
            const int length = end - start + 1;
            if (length > 0) {
                QString commentLine = QString::fromUtf8(start, length);
                processCommentLine(doc->fileName(), commentLine, lineNumber, itemList);
            }

            from = to + 1;
Dmitry Savchenko's avatar
Dmitry Savchenko committed
112 113 114 115 116 117 118
        }
    }
    emit itemsFetched(doc->fileName(), itemList);
}

}
}