diff options
author | Dmitry Savchenko <dmitry.a.sav@gmail.com> | 2011-10-25 23:14:27 +0300 |
---|---|---|
committer | Eike Ziller <eike.ziller@nokia.com> | 2012-02-24 08:00:29 +0100 |
commit | 5623e520d8348ee7d0b3c979ab35597b034e38f5 (patch) | |
tree | adbfa911e63ac50b335a5e1a69354e571b453538 /src/plugins/todo/cpptodoitemsscanner.cpp | |
parent | edb3094fa33a20d2f83e517fffdfa3889c18bc07 (diff) |
To-do plugin added.
Change-Id: Ideaf91b2f9ce3d9252ca40b7224a2ab4238341f1
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
Reviewed-by: Eike Ziller <eike.ziller@nokia.com>
Diffstat (limited to 'src/plugins/todo/cpptodoitemsscanner.cpp')
-rw-r--r-- | src/plugins/todo/cpptodoitemsscanner.cpp | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/src/plugins/todo/cpptodoitemsscanner.cpp b/src/plugins/todo/cpptodoitemsscanner.cpp new file mode 100644 index 0000000000..04aefdbe19 --- /dev/null +++ b/src/plugins/todo/cpptodoitemsscanner.cpp @@ -0,0 +1,113 @@ +/************************************************************************** +** +** This file is part of Qt Creator +** +** Copyright (c) 2012 Dmitry Savchenko. +** Copyright (c) 2010 Vasiliy Sorokin. +** +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** +** GNU Lesser General Public License Usage +** +** 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, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** Other Usage +** +** Alternatively, this file may be used in accordance with the terms and +** conditions contained in a signed written agreement between you and Nokia. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +**************************************************************************/ + +#include "cpptodoitemsscanner.h" + +#include <projectexplorer/project.h> +#include <TranslationUnit.h> + +namespace Todo { +namespace Internal { + +CppTodoItemsScanner::CppTodoItemsScanner(const KeywordList &keywordList, QObject *parent) : + TodoItemsScanner(keywordList, parent) +{ + CPlusPlus::CppModelManagerInterface *modelManager = CPlusPlus::CppModelManagerInterface::instance(); + + connect(modelManager, SIGNAL(documentUpdated(CPlusPlus::Document::Ptr)), this, + SLOT(documentUpdated(CPlusPlus::Document::Ptr)), Qt::DirectConnection); +} + +bool CppTodoItemsScanner::shouldProcessFile(const QString &fileName) +{ + CPlusPlus::CppModelManagerInterface *modelManager = CPlusPlus::CppModelManagerInterface::instance(); + + foreach (const CPlusPlus::CppModelManagerInterface::ProjectInfo &info, modelManager->projectInfos()) + if (info.project().data()->files(ProjectExplorer::Project::ExcludeGeneratedFiles).contains(fileName)) + return true; + + return false; +} + +void CppTodoItemsScanner::keywordListChanged() +{ + // 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. + + CPlusPlus::CppModelManagerInterface *modelManager = CPlusPlus::CppModelManagerInterface::instance(); + + QStringList filesToBeUpdated; + foreach (const CPlusPlus::CppModelManagerInterface::ProjectInfo &info, modelManager->projectInfos()) + filesToBeUpdated << info.project().data()->files(ProjectExplorer::Project::ExcludeGeneratedFiles); + + modelManager->updateSourceFiles(filesToBeUpdated); +} + +void CppTodoItemsScanner::documentUpdated(CPlusPlus::Document::Ptr doc) +{ + if (shouldProcessFile(doc->fileName())) + 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); + QByteArray source = doc->utf8Source().mid(token.begin(), token.length()).trimmed(); + + 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 + // TODO: Do not create QStringList, just iterate through a string tracking line endings. + QStringList commentLines = QString::fromUtf8(source).split("\n", QString::SkipEmptyParts); + unsigned lineNumber = 0; + translationUnit->getPosition(token.begin(), &lineNumber); + for (int j = 0; j < commentLines.count(); ++j) { + const QString &commentLine = commentLines.at(j); + processCommentLine(doc->fileName(), commentLine, lineNumber + j, itemList); + } + } + emit itemsFetched(doc->fileName(), itemList); +} + +} +} |