classviewmanager.cpp 11 KB
Newer Older
1 2 3 4 5 6
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Denis Mingulov.
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
8 9 10 11
**
**
** GNU Lesser General Public License Usage
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** 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.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
29
** Nokia at qt-info@nokia.com.
30 31 32 33 34 35 36 37 38 39 40 41 42
**
**************************************************************************/

#include "classviewsymbollocation.h"
#include "classviewmanager.h"
#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>
43
#include <cplusplus/ModelManagerInterface.h>
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
#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>

#include <QtCore/QThread>
#include <QtCore/QMutex>
#include <QtCore/QMutexLocker>

namespace ClassView {
namespace Internal {

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

60 61 62
// static variable initialization
static Manager *managerInstance = 0;

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

    //! State mutex
    QMutex mutexState;

    //! code state/changes parser
    Parser parser;

    //! separate thread for the parser
    QThread parserThread;

hjk's avatar
hjk committed
83 84 85
    //! Internal manager state. \sa Manager::state
    bool state;

86 87 88 89 90 91 92 93
    //! there is some massive operation ongoing so temporary we should wait
    bool disableCodeParser;
};

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

Manager::Manager(QObject *parent)
    : QObject(parent),
94
    d(new ManagerPrivate())
95
{
96
    managerInstance = this;
97 98 99 100 101 102 103

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

    initialize();

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

    // initial setup
    onProjectListChanged();
}

Manager::~Manager()
{
113 114 115 116
    d->parserThread.quit();
    d->parserThread.wait();
    delete d;
    managerInstance = 0;
117 118
}

119
Manager *Manager::instance()
120
{
121
    return managerInstance;
122 123 124 125
}

bool Manager::canFetchMore(QStandardItem *item) const
{
126
    return d->parser.canFetchMore(item);
127 128 129 130
}

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

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

    // widget factory signals
139
    connect(NavigationWidgetFactory::instance(), SIGNAL(widgetIsCreated()),
140 141 142 143 144
            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
145
    // connections to enable/disable navi widget factory
146 147 148 149 150 151 152 153
    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
154
    connect(Core::ICore::progressManager(), SIGNAL(taskStarted(QString)),
155
            SLOT(onTaskStarted(QString)), Qt::QueuedConnection);
hjk's avatar
hjk committed
156
    connect(Core::ICore::progressManager(), SIGNAL(allTasksFinished(QString)),
157 158 159 160
            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)),
161
            &d->parser, SLOT(parseDocument(CPlusPlus::Document::Ptr)), Qt::QueuedConnection);
162 163

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

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

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

    // clear cache request
    connect(this, SIGNAL(requestClearCache()),
177
            &d->parser, SLOT(clearCache()), Qt::QueuedConnection);
178 179 180

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

    // flat mode request
    connect(this, SIGNAL(requestSetFlatMode(bool)),
185
            &d->parser, SLOT(setFlatMode(bool)), Qt::QueuedConnection);
hjk's avatar
hjk committed
186 187 188 189 190 191 192 193 194 195

    // connect to the cpp model manager for signals about document updates
    CPlusPlus::CppModelManagerInterface *codeModelManager
        = CPlusPlus::CppModelManagerInterface::instance();

    // 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)),
196
            &d->parser, SLOT(removeFiles(QStringList)), Qt::QueuedConnection);
197 198 199 200
}

bool Manager::state() const
{
201
    return d->state;
202 203 204 205
}

void Manager::setState(bool state)
{
206
    QMutexLocker locker(&d->mutexState);
207 208

    // boolean comparsion - should be done correctly by any compiler
209
    if (state == d->state)
210 211
        return;

212
    d->state = state;
213

214
    emit stateChanged(d->state);
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 249 250 251
}

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)
{
252
    if (type != QLatin1String(CppTools::Constants::TASK_INDEX))
253 254 255
        return;

    // disable tree updates to speed up
256
    d->disableCodeParser = true;
257 258 259 260
}

void Manager::onAllTasksFinished(const QString &type)
{
261
    if (type != QLatin1String(CppTools::Constants::TASK_INDEX))
262 263 264
        return;

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

    // 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
285
    if (d->disableCodeParser)
286 287 288 289 290 291 292 293
        return;

    emit requestDocumentUpdated(doc);
}

void Manager::gotoLocation(const QString &fileName, int line, int column)
{
    bool newEditor = false;
hjk's avatar
hjk committed
294
    TextEditor::BaseTextEditorWidget::openEditorAt(fileName, line, column, Core::Id(),
295 296
                                             Core::EditorManager::IgnoreNavigationHistory,
                                             &newEditor);
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 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 372 373 374 375 376
}

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?
    Core::IEditor *editor = Core::EditorManager::instance()->currentEditor();
    if (editor) {
        // get current file name
        Core::IFile *file = editor->file();
        if (file)
            fileName = file->fileName();

        // 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