classviewmanager.cpp 11.2 KB
Newer Older
1 2
/**************************************************************************
**
3
** Copyright (c) 2013 Denis Mingulov
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** 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
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** 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.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
29 30

#include "classviewmanager.h"
31
#include "classviewsymbollocation.h"
32 33 34 35 36 37 38 39
#include "classviewnavigationwidgetfactory.h"
#include "classviewparser.h"
#include "classviewutils.h"

#include <utils/qtcassert.h>
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/session.h>
#include <texteditor/basetexteditor.h>
40
#include <cpptools/cppmodelmanagerinterface.h>
41 42 43 44 45 46 47
#include <cpptools/cpptoolsconstants.h>
#include <coreplugin/icore.h>
#include <coreplugin/progressmanager/progressmanager.h>
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/editormanager/ieditor.h>
#include <texteditor/itexteditor.h>

48 49 50
#include <QThread>
#include <QMutex>
#include <QMutexLocker>
51 52 53 54 55 56

namespace ClassView {
namespace Internal {

///////////////////////////////// ManagerPrivate //////////////////////////////////

57 58 59
// static variable initialization
static Manager *managerInstance = 0;

60 61
/*!
   \struct ManagerPrivate
hjk's avatar
hjk committed
62
   \internal
63 64 65
   \brief Private class data for \a Manager
   \sa Manager
 */
66
class ManagerPrivate
67
{
68
public:
hjk's avatar
hjk committed
69
    ManagerPrivate() : state(false), disableCodeParser(false) {}
70 71 72 73 74 75 76 77 78 79

    //! State mutex
    QMutex mutexState;

    //! code state/changes parser
    Parser parser;

    //! separate thread for the parser
    QThread parserThread;

hjk's avatar
hjk committed
80 81 82
    //! Internal manager state. \sa Manager::state
    bool state;

83 84 85 86 87 88 89 90
    //! there is some massive operation ongoing so temporary we should wait
    bool disableCodeParser;
};

///////////////////////////////// Manager //////////////////////////////////

Manager::Manager(QObject *parent)
    : QObject(parent),
91
    d(new ManagerPrivate())
92
{
93
    managerInstance = this;
94 95 96 97 98 99 100

    // register - to be able send between signal/slots
    qRegisterMetaType<QSharedPointer<QStandardItem> >("QSharedPointer<QStandardItem>");

    initialize();

    // start a separate thread for the parser
101 102
    d->parser.moveToThread(&d->parserThread);
    d->parserThread.start();
103 104 105 106 107 108 109

    // initial setup
    onProjectListChanged();
}

Manager::~Manager()
{
110 111 112 113
    d->parserThread.quit();
    d->parserThread.wait();
    delete d;
    managerInstance = 0;
114 115
}

116
Manager *Manager::instance()
117
{
118
    return managerInstance;
119 120 121 122
}

bool Manager::canFetchMore(QStandardItem *item) const
{
123
    return d->parser.canFetchMore(item);
124 125 126 127
}

void Manager::fetchMore(QStandardItem *item, bool skipRoot)
{
128
    d->parser.fetchMore(item, skipRoot);
129 130 131 132 133 134 135
}

void Manager::initialize()
{
    // use Qt::QueuedConnection everywhere

    // widget factory signals
136
    connect(NavigationWidgetFactory::instance(), SIGNAL(widgetIsCreated()),
137 138 139 140 141
            SLOT(onWidgetIsCreated()), Qt::QueuedConnection);

    // internal manager state is changed
    connect(this, SIGNAL(stateChanged(bool)), SLOT(onStateChanged(bool)), Qt::QueuedConnection);

Tobias Hunger's avatar
Tobias Hunger committed
142
    // connections to enable/disable navi widget factory
143 144 145 146 147 148 149 150
    ProjectExplorer::SessionManager *sessionManager =
        ProjectExplorer::ProjectExplorerPlugin::instance()->session();
    connect(sessionManager, SIGNAL(projectAdded(ProjectExplorer::Project*)),
            SLOT(onProjectListChanged()), Qt::QueuedConnection);
    connect(sessionManager, SIGNAL(projectRemoved(ProjectExplorer::Project*)),
            SLOT(onProjectListChanged()), Qt::QueuedConnection);

    // connect to the progress manager for signals about Parsing tasks
hjk's avatar
hjk committed
151
    connect(Core::ICore::progressManager(), SIGNAL(taskStarted(QString)),
152
            SLOT(onTaskStarted(QString)), Qt::QueuedConnection);
hjk's avatar
hjk committed
153
    connect(Core::ICore::progressManager(), SIGNAL(allTasksFinished(QString)),
154 155 156 157
            SLOT(onAllTasksFinished(QString)), Qt::QueuedConnection);

    // when we signals that really document is updated - sent it to the parser
    connect(this, SIGNAL(requestDocumentUpdated(CPlusPlus::Document::Ptr)),
158
            &d->parser, SLOT(parseDocument(CPlusPlus::Document::Ptr)), Qt::QueuedConnection);
159 160

    // translate data update from the parser to listeners
161
    connect(&d->parser, SIGNAL(treeDataUpdate(QSharedPointer<QStandardItem>)),
162 163 164 165
            this, SLOT(onTreeDataUpdate(QSharedPointer<QStandardItem>)), Qt::QueuedConnection);

    // requet current state - immediately after a notification
    connect(this, SIGNAL(requestTreeDataUpdate()),
166
            &d->parser, SLOT(requestCurrentState()), Qt::QueuedConnection);
167 168 169

    // full reset request to parser
    connect(this, SIGNAL(requestResetCurrentState()),
170
            &d->parser, SLOT(resetDataToCurrentState()), Qt::QueuedConnection);
171 172 173

    // clear cache request
    connect(this, SIGNAL(requestClearCache()),
174
            &d->parser, SLOT(clearCache()), Qt::QueuedConnection);
175 176 177

    // clear full cache request
    connect(this, SIGNAL(requestClearCacheAll()),
178
            &d->parser, SLOT(clearCacheAll()), Qt::QueuedConnection);
179 180 181

    // flat mode request
    connect(this, SIGNAL(requestSetFlatMode(bool)),
182
            &d->parser, SLOT(setFlatMode(bool)), Qt::QueuedConnection);
hjk's avatar
hjk committed
183 184

    // connect to the cpp model manager for signals about document updates
185 186
    CppTools::CppModelManagerInterface *codeModelManager
        = CppTools::CppModelManagerInterface::instance();
hjk's avatar
hjk committed
187 188 189 190 191 192

    // when code manager signals that document is updated - handle it by ourselves
    connect(codeModelManager, SIGNAL(documentUpdated(CPlusPlus::Document::Ptr)),
            SLOT(onDocumentUpdated(CPlusPlus::Document::Ptr)), Qt::QueuedConnection);
    //
    connect(codeModelManager, SIGNAL(aboutToRemoveFiles(QStringList)),
193
            &d->parser, SLOT(removeFiles(QStringList)), Qt::QueuedConnection);
194 195 196 197
}

bool Manager::state() const
{
198
    return d->state;
199 200 201 202
}

void Manager::setState(bool state)
{
203
    QMutexLocker locker(&d->mutexState);
204 205

    // boolean comparsion - should be done correctly by any compiler
206
    if (state == d->state)
207 208
        return;

209
    d->state = state;
210

211
    emit stateChanged(d->state);
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
}

void Manager::onWidgetIsCreated()
{
    // do nothing - continue to sleep
}

void Manager::onWidgetVisibilityIsChanged(bool visibility)
{
    // activate data handling - when 1st time 'Class View' will be open
    if (visibility)
        setState(true);
}

void Manager::onStateChanged(bool state)
{
    if (state) {
        // enabled - request a current snapshots etc?..
        emit requestResetCurrentState();
    } else {
        // disabled - clean parsers internal cache
        emit requestClearCacheAll();
    }
}

void Manager::onProjectListChanged()
{
    // do nothing if Manager is disabled
    if (!state())
        return;

    // update to the latest state
    requestTreeDataUpdate();
}

void Manager::onTaskStarted(const QString &type)
{
249
    if (type != QLatin1String(CppTools::Constants::TASK_INDEX))
250 251 252
        return;

    // disable tree updates to speed up
253
    d->disableCodeParser = true;
254 255 256 257
}

void Manager::onAllTasksFinished(const QString &type)
{
258
    if (type != QLatin1String(CppTools::Constants::TASK_INDEX))
259 260 261
        return;

    // parsing is finished, enable tree updates
262
    d->disableCodeParser = false;
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281

    // do nothing if Manager is disabled
    if (!state())
        return;

    // any document might be changed, emit signal to clear cache
    emit requestClearCache();

    // request to update a tree to the current state
    emit requestResetCurrentState();
}

void Manager::onDocumentUpdated(CPlusPlus::Document::Ptr doc)
{
    // do nothing if Manager is disabled
    if (!state())
        return;

    // do nothing if updates are disabled
282
    if (d->disableCodeParser)
283 284 285 286 287 288 289 290
        return;

    emit requestDocumentUpdated(doc);
}

void Manager::gotoLocation(const QString &fileName, int line, int column)
{
    bool newEditor = false;
hjk's avatar
hjk committed
291
    TextEditor::BaseTextEditorWidget::openEditorAt(fileName, line, column, Core::Id(),
292 293
                                             Core::EditorManager::IgnoreNavigationHistory,
                                             &newEditor);
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
}

void Manager::gotoLocations(const QList<QVariant> &list)
{
    QSet<SymbolLocation> locations = Utils::roleToLocations(list);

    if (locations.count() == 0)
        return;

    QString fileName;
    int line = 0;
    int column = 0;
    bool currentPositionAvailable = false;

    // what is open now?
hjk's avatar
hjk committed
309
    if (Core::IEditor *editor = Core::EditorManager::currentEditor()) {
310
        // get current file name
David Schulz's avatar
David Schulz committed
311
        if (Core::IDocument *document = editor->document())
312
            fileName = document->fileName();
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 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 361 362 363 364 365 366 367 368 369 370 371

        // if text file - what is current position?
        TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor *>(editor);
        if (textEditor) {
            // there is open currently text editor
            int position = textEditor->position();
            textEditor->convertPosition(position, &line, &column);
            currentPositionAvailable = true;
        }
    }

    // if there is something open - try to check, is it currently activated symbol?
    if (currentPositionAvailable) {
        SymbolLocation current(fileName, line, column);
        QSet<SymbolLocation>::const_iterator it = locations.find(current);
        QSet<SymbolLocation>::const_iterator end = locations.constEnd();
        // is it known location?
        if (it != end) {
            // found - do one additional step
            ++it;
            if (it == end)
                it = locations.begin();
            const SymbolLocation &found = *it;
            gotoLocation(found.fileName(), found.line(), found.column());
            return;
        }
    }

    // no success - open first item in the list
    const SymbolLocation loc = *locations.constBegin();

    gotoLocation(loc.fileName(), loc.line(), loc.column());
}

void Manager::onRequestTreeDataUpdate()
{
    // do nothing if Manager is disabled
    if (!state())
        return;

    emit requestTreeDataUpdate();
}

void Manager::setFlatMode(bool flat)
{
    emit requestSetFlatMode(flat);
}

void Manager::onTreeDataUpdate(QSharedPointer<QStandardItem> result)
{
    // do nothing if Manager is disabled
    if (!state())
        return;

    emit treeDataUpdate(result);
}

} // namespace Internal
} // namespace ClassView