ClassView: Initial implementation

Merge-request: 2167
Reviewed-by: Kai Koehne <kai.koehne@nokia.com>

src/plugins/classview/classviewnavigationwidget.cpp

@@ -0,0 +1,254 @@
+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2010 Denis Mingulov.
+**
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** Commercial Usage
+**
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Nokia.
+**
+** 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at http://qt.nokia.com/contact.
+**
+**************************************************************************/
+
+#include "classviewnavigationwidget.h"
+#include "ui_classviewnavigationwidget.h"
+#include "classviewtreeitemmodel.h"
+#include "classviewmanager.h"
+#include "classviewsymbollocation.h"
+#include "classviewsymbolinformation.h"
+#include "classviewutils.h"
+#include "classviewconstants.h"
+
+#include <utils/qtcassert.h>
+
+#include <QtCore/QDebug>
+#include <QtCore/QPointer>
+
+enum { debug = false };
+
+namespace ClassView {
+namespace Internal {
+
+///////////////////////////////// NavigationWidgetPrivate //////////////////////////////////
+
+/*!
+   \struct NavigationWidgetPrivate
+   \brief Internal data structures / methods for NavigationWidget
+ */
+
+struct NavigationWidgetPrivate
+{
+    NavigationWidgetPrivate() : ui(0) {}
+
+    //! Ui generated by Designer
+    Ui::NavigationWidget *ui;
+
+    //! current tree model
+    QPointer<TreeItemModel> treeModel;
+
+    //! full projects mode
+    QPointer<QToolButton> fullProjectsModeButton;
+};
+
+///////////////////////////////// NavigationWidget //////////////////////////////////
+
+
+NavigationWidget::NavigationWidget(QWidget *parent) :
+    QWidget(parent),
+    d_ptr(new NavigationWidgetPrivate())
+{
+    d_ptr->ui = new Ui::NavigationWidget;
+    d_ptr->ui->setupUi(this);
+    d_ptr->ui->treeView->setIndentation(d_ptr->ui->treeView->indentation() * 9/10);
+
+    // tree model
+    d_ptr->treeModel = new TreeItemModel(this);
+    d_ptr->ui->treeView->setModel(d_ptr->treeModel);
+
+    // connect signal/slots
+    // selected item
+    connect(d_ptr->ui->treeView, SIGNAL(activated(QModelIndex)), SLOT(onItemActivated(QModelIndex)));
+
+    // connections to the manager
+    Manager *manager = Manager::instance();
+
+    connect(this, SIGNAL(visibilityChanged(bool)),
+            manager, SLOT(onWidgetVisibilityIsChanged(bool)));
+
+    connect(this, SIGNAL(requestGotoLocation(QString,int,int)),
+            manager, SLOT(gotoLocation(QString,int,int)));
+
+    connect(this, SIGNAL(requestGotoLocations(QList<QVariant>)),
+            manager, SLOT(gotoLocations(QList<QVariant>)));
+
+    connect(manager, SIGNAL(treeDataUpdate(QSharedPointer<QStandardItem>)),
+            this, SLOT(onDataUpdate(QSharedPointer<QStandardItem>)));
+
+    connect(this, SIGNAL(requestTreeDataUpdate()),
+            manager, SLOT(onRequestTreeDataUpdate()));
+}
+
+NavigationWidget::~NavigationWidget()
+{
+    delete d_ptr->fullProjectsModeButton;
+    delete d_ptr->ui;
+}
+
+void NavigationWidget::hideEvent(QHideEvent *event)
+{
+    emit visibilityChanged(false);
+    QWidget::hideEvent(event);
+}
+
+void NavigationWidget::showEvent(QShowEvent *event)
+{
+    emit visibilityChanged(true);
+
+    // request to update to the current state - to be sure
+    emit requestTreeDataUpdate();
+
+    QWidget::showEvent(event);
+}
+
+QList<QToolButton *> NavigationWidget::createToolButtons()
+{
+    QList<QToolButton *> list;
+
+    // full projects mode
+    if (!d_ptr->fullProjectsModeButton) {
+        // create a button
+        d_ptr->fullProjectsModeButton = new QToolButton();
+        d_ptr->fullProjectsModeButton->setIcon(
+                QIcon(QLatin1String(":/classview/images/hierarchicalmode.png")));
+        d_ptr->fullProjectsModeButton->setCheckable(true);
+        d_ptr->fullProjectsModeButton->setToolTip(tr("Show subprojects"));
+
+        // by default - not a flat mode
+        setFlatMode(false);
+
+        // connections
+        connect(d_ptr->fullProjectsModeButton, SIGNAL(toggled(bool)),
+                this, SLOT(onFullProjectsModeToggled(bool)));
+    }
+
+    list << d_ptr->fullProjectsModeButton;
+
+    return list;
+}
+
+bool NavigationWidget::flatMode() const
+{
+    QTC_ASSERT(d_ptr->fullProjectsModeButton, return false);
+
+    // button is 'full projects mode' - so it has to be inverted
+    return !d_ptr->fullProjectsModeButton->isChecked();
+}
+
+void NavigationWidget::setFlatMode(bool flatMode)
+{
+    QTC_ASSERT(d_ptr->fullProjectsModeButton, return);
+
+    // button is 'full projects mode' - so it has to be inverted
+    d_ptr->fullProjectsModeButton->setChecked(!flatMode);
+}
+
+void NavigationWidget::onFullProjectsModeToggled(bool state)
+{
+    // button is 'full projects mode' - so it has to be inverted
+    Manager::instance()->setFlatMode(!state);
+}
+
+void NavigationWidget::onItemActivated(const QModelIndex &index)
+{
+    if (!index.isValid())
+        return;
+
+    QList<QVariant> list = d_ptr->treeModel->data(index, Constants::SymbolLocationsRole).toList();
+
+    emit requestGotoLocations(list);
+}
+
+void NavigationWidget::onDataUpdate(QSharedPointer<QStandardItem> result)
+{
+    if (result.isNull())
+        return;
+
+    // if this is 1st call
+    bool expandRootItems = false;
+    if (d_ptr->treeModel->invisibleRootItem()->rowCount() == 0)
+        expandRootItems = true;
+
+    QTime timer;
+    if (debug)
+        timer.start();
+    // update is received. root item must be updated - and received information
+    // might be just a root - if a lazy data population is enabled.
+    // so expanded items must be parsed and 'fetched'
+
+    fetchExpandedItems(result.data(), d_ptr->treeModel->invisibleRootItem());
+
+    d_ptr->treeModel->moveRootToTarget(result.data());
+
+    // expand top level projects
+    QModelIndex sessionIndex;
+
+    for (int i = 0; i < d_ptr->treeModel->rowCount(sessionIndex); ++i)
+        d_ptr->ui->treeView->expand(d_ptr->treeModel->index(i, 0, sessionIndex));
+
+    if (debug)
+        qDebug() << "Class View:" << QDateTime::currentDateTime().toString()
+            << "TreeView is updated in" << timer.elapsed() << "msecs";
+}
+
+void NavigationWidget::fetchExpandedItems(QStandardItem *item, const QStandardItem *target) const
+{
+    if (!item || !target)
+        return;
+
+    const QModelIndex &parent = d_ptr->treeModel->indexFromItem(target);
+    if (d_ptr->ui->treeView->isExpanded(parent))
+        Manager::instance()->fetchMore(item, true);
+
+    int itemIndex = 0;
+    int targetIndex = 0;
+    int itemRows = item->rowCount();
+    int targetRows = target->rowCount();
+
+    while (itemIndex < itemRows && targetIndex < targetRows) {
+        QStandardItem *itemChild = item->child(itemIndex);
+        const QStandardItem *targetChild = target->child(targetIndex);
+
+        const SymbolInformation &itemInf = Utils::symbolInformationFromItem(itemChild);
+        const SymbolInformation &targetInf = Utils::symbolInformationFromItem(targetChild);
+
+        if (itemInf < targetInf) {
+            ++itemIndex;
+        } else if (itemInf == targetInf) {
+            fetchExpandedItems(itemChild, targetChild);
+            ++itemIndex;
+            ++targetIndex;
+        } else {
+            ++targetIndex;
+        }
+    }
+}
+
+} // namespace Internal
+} // namespace ClassView