To-do plugin added.

Change-Id: Ideaf91b2f9ce3d9252ca40b7224a2ab4238341f1
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
Reviewed-by: Eike Ziller <eike.ziller@nokia.com>

src/plugins/todo/todoitemsprovider.cpp

@@ -0,0 +1,188 @@
+/**************************************************************************
+**
+** 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 "todoitemsprovider.h"
+#include "constants.h"
+#include "cpptodoitemsscanner.h"
+#include "qmljstodoitemsscanner.h"
+
+#include <projectexplorer/projectexplorer.h>
+#include <coreplugin/editormanager/editormanager.h>
+#include <projectexplorer/session.h>
+
+#include <QTimer>
+
+namespace Todo {
+namespace Internal {
+
+TodoItemsProvider::TodoItemsProvider(Settings settings, QObject *parent) :
+    QObject(parent),
+    m_settings(settings)
+{
+    setupItemsModel();
+    setupStartupProjectBinding();
+    setupCurrentEditorBinding();
+    setupUpdateListTimer();
+    createScanners();
+}
+
+TodoItemsModel *TodoItemsProvider::todoItemsModel()
+{
+    return m_itemsModel;
+}
+
+void TodoItemsProvider::settingsChanged(const Settings &newSettings)
+{
+    if (newSettings.keywords != m_settings.keywords)
+        foreach (TodoItemsScanner *scanner, m_scanners)
+            scanner->setKeywordList(newSettings.keywords);
+
+    m_settings = newSettings;
+
+    updateList();
+}
+
+void TodoItemsProvider::updateList()
+{
+    m_itemsList.clear();
+
+    // Show only items of the current file if any
+    if (m_settings.scanningScope == ScanningScopeCurrentFile) {
+        if (m_currentEditor)
+            m_itemsList = m_itemsHash.value(m_currentEditor->document()->fileName());
+    }
+
+    // Show only items of the startup project if any
+    else {
+        if (m_startupProject)
+            setItemsListWithinStartupProject();
+    }
+
+    m_itemsModel->todoItemsListUpdated();
+}
+
+void TodoItemsProvider::createScanners()
+{
+    qRegisterMetaType<QList<TodoItem> >("QList<TodoItem>");
+
+    if (CPlusPlus::CppModelManagerInterface::instance())
+        m_scanners << new CppTodoItemsScanner(m_settings.keywords, this);
+
+    if (QmlJS::ModelManagerInterface::instance())
+        m_scanners << new QmlJsTodoItemsScanner(m_settings.keywords, this);
+
+    foreach (TodoItemsScanner *scanner, m_scanners)
+        connect(scanner, SIGNAL(itemsFetched(QString,QList<TodoItem>)), this,
+            SLOT(itemsFetched(QString,QList<TodoItem>)), Qt::QueuedConnection);
+}
+
+void TodoItemsProvider::setItemsListWithinStartupProject()
+{
+    QHashIterator<QString, QList<TodoItem> > it(m_itemsHash);
+    QStringList fileNames = m_startupProject->files(ProjectExplorer::Project::ExcludeGeneratedFiles);
+    while (it.hasNext()) {
+        it.next();
+        if (fileNames.contains(it.key()))
+            m_itemsList << it.value();
+    }
+}
+
+void TodoItemsProvider::itemsFetched(const QString &fileName, const QList<TodoItem> &items)
+{
+    // Replace old items with new ones
+    m_itemsHash.insert(fileName, items);
+
+    m_shouldUpdateList = true;
+}
+
+void TodoItemsProvider::startupProjectChanged(ProjectExplorer::Project *project)
+{
+    m_startupProject = project;
+    updateList();
+}
+
+void TodoItemsProvider::projectsFilesChanged()
+{
+    updateList();
+}
+
+void TodoItemsProvider::currentEditorChanged(Core::IEditor *editor)
+{
+    m_currentEditor = editor;
+    if (m_settings.scanningScope == ScanningScopeCurrentFile)
+        updateList();
+}
+
+void TodoItemsProvider::updateListTimeoutElapsed()
+{
+    if (m_shouldUpdateList) {
+        m_shouldUpdateList = false;
+        updateList();
+    }
+}
+
+void TodoItemsProvider::setupStartupProjectBinding()
+{
+    ProjectExplorer::ProjectExplorerPlugin *projectExplorerPlugin = ProjectExplorer::ProjectExplorerPlugin::instance();
+
+    m_startupProject = projectExplorerPlugin->startupProject();
+    connect(projectExplorerPlugin->session(), SIGNAL(startupProjectChanged(ProjectExplorer::Project*)),
+        SLOT(startupProjectChanged(ProjectExplorer::Project*)));
+    connect(projectExplorerPlugin, SIGNAL(fileListChanged()), SLOT(projectsFilesChanged()));
+}
+
+void TodoItemsProvider::setupCurrentEditorBinding()
+{
+    Core::EditorManager *editorManager = Core::EditorManager::instance();
+
+    m_currentEditor = editorManager->currentEditor();
+    connect(editorManager, SIGNAL(currentEditorChanged(Core::IEditor*)),
+        SLOT(currentEditorChanged(Core::IEditor*)));
+}
+
+void TodoItemsProvider::setupUpdateListTimer()
+{
+    m_shouldUpdateList = false;
+    QTimer *timer = new QTimer(this);
+    connect(timer, SIGNAL(timeout()), SLOT(updateListTimeoutElapsed()));
+    timer->start(Constants::OUTPUT_PANE_UPDATE_INTERVAL);
+}
+
+void TodoItemsProvider::setupItemsModel()
+{
+    m_itemsModel = new TodoItemsModel(this);
+    m_itemsModel->setTodoItemsList(&m_itemsList);
+}
+
+}
+}