qmlinspectoradapter.cpp 19.1 KB
Newer Older
1 2 3 4 5 6
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
**
Eike Ziller's avatar
Eike Ziller committed
7
** Contact: http://www.qt-project.org/
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
**
**
** 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.
**
**
**************************************************************************/

#include "qmlinspectoradapter.h"

#include "debuggeractions.h"
#include "debuggercore.h"
#include "debuggerstringutils.h"
#include "qmladapter.h"
#include "qmlengine.h"
#include "qmlinspectoragent.h"
#include "qmllivetextpreview.h"

#include <coreplugin/actionmanager/actionmanager.h>
#include <coreplugin/editormanager/ieditor.h>
#include <coreplugin/icore.h>
#include <qmldebug/declarativeenginedebugclient.h>
#include <qmldebug/declarativetoolsclient.h>
#include <qmldebug/qmlenginedebugclient.h>
#include <qmldebug/qmltoolsclient.h>
#include <qmljseditor/qmljseditorconstants.h>
#include <qmljs/qmljsmodelmanagerinterface.h>
#include <utils/qtcassert.h>
#include <utils/savedaction.h>

using namespace QmlDebug;

namespace Debugger {
namespace Internal {
/*!
 * QmlInspectorAdapter manages the clients for the inspector, and the
 * integration with the text editor.
 */
QmlInspectorAdapter::QmlInspectorAdapter(QmlAdapter *debugAdapter,
                                         QmlEngine *engine,
                                         QObject *parent)
    : QObject(parent)
    , m_debugAdapter(debugAdapter)
    , m_engine(engine)
    , m_engineClient(0)
    , m_toolsClient(0)
    , m_agent(new QmlInspectorAgent(engine, this))
    , m_targetToSync(NoTarget)
    , m_debugIdToSelect(-1)
    , m_currentSelectedDebugId(-1)
    , m_listeningToEditorManager(false)
    , m_selectionCallbackExpected(false)
    , m_cursorPositionChangedExternally(false)
    , m_toolsClientConnected(false)
    , m_inspectorToolsContext("Debugger.QmlInspector")
    , m_selectAction(new QAction(this))
    , m_zoomAction(new QAction(this))
80
    , m_engineClientConnected(false)
81
{
Kai Koehne's avatar
Kai Koehne committed
82 83
    connect(m_agent, SIGNAL(objectFetched(QmlDebug::ObjectReference)),
            SLOT(onObjectFetched(QmlDebug::ObjectReference)));
84 85 86 87

    QmlDebugConnection *connection = m_debugAdapter->connection();
    DeclarativeEngineDebugClient *engineClient1
            = new DeclarativeEngineDebugClient(connection);
Kai Koehne's avatar
Kai Koehne committed
88 89 90 91
    connect(engineClient1, SIGNAL(newStatus(QmlDebug::ClientStatus)),
            this, SLOT(clientStatusChanged(QmlDebug::ClientStatus)));
    connect(engineClient1, SIGNAL(newStatus(QmlDebug::ClientStatus)),
            this, SLOT(engineClientStatusChanged(QmlDebug::ClientStatus)));
92 93

    QmlEngineDebugClient *engineClient2 = new QmlEngineDebugClient(connection);
Kai Koehne's avatar
Kai Koehne committed
94 95 96 97
    connect(engineClient2, SIGNAL(newStatus(QmlDebug::ClientStatus)),
            this, SLOT(clientStatusChanged(QmlDebug::ClientStatus)));
    connect(engineClient2, SIGNAL(newStatus(QmlDebug::ClientStatus)),
            this, SLOT(engineClientStatusChanged(QmlDebug::ClientStatus)));
98 99 100 101

    m_engineClients.insert(engineClient1->name(), engineClient1);
    m_engineClients.insert(engineClient2->name(), engineClient2);

Kai Koehne's avatar
Kai Koehne committed
102
    if (engineClient1->status() == QmlDebug::Enabled)
103
        setActiveEngineClient(engineClient1);
Kai Koehne's avatar
Kai Koehne committed
104
    if (engineClient2->status() == QmlDebug::Enabled)
105 106 107
        setActiveEngineClient(engineClient2);

    DeclarativeToolsClient *toolsClient1 = new DeclarativeToolsClient(connection);
Kai Koehne's avatar
Kai Koehne committed
108
    connect(toolsClient1, SIGNAL(newStatus(QmlDebug::ClientStatus)),
Kai Koehne's avatar
Kai Koehne committed
109
            this, SLOT(clientStatusChanged(QmlDebug::ClientStatus)));
Kai Koehne's avatar
Kai Koehne committed
110
    connect(toolsClient1, SIGNAL(newStatus(QmlDebug::ClientStatus)),
Kai Koehne's avatar
Kai Koehne committed
111
            this, SLOT(toolsClientStatusChanged(QmlDebug::ClientStatus)));
112 113

    QmlToolsClient *toolsClient2 = new QmlToolsClient(connection);
Kai Koehne's avatar
Kai Koehne committed
114
    connect(toolsClient2, SIGNAL(newStatus(QmlDebug::ClientStatus)),
Kai Koehne's avatar
Kai Koehne committed
115
            this, SLOT(clientStatusChanged(QmlDebug::ClientStatus)));
Kai Koehne's avatar
Kai Koehne committed
116
    connect(toolsClient2, SIGNAL(newStatus(QmlDebug::ClientStatus)),
Kai Koehne's avatar
Kai Koehne committed
117
            this, SLOT(toolsClientStatusChanged(QmlDebug::ClientStatus)));
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159

    // toolbar
    m_selectAction->setObjectName("QML Select Action");
    m_zoomAction->setObjectName("QML Zoom Action");
    m_selectAction->setCheckable(true);
    m_zoomAction->setCheckable(true);

    connect(m_selectAction, SIGNAL(triggered(bool)),
            SLOT(onSelectActionTriggered(bool)));
    connect(m_zoomAction, SIGNAL(triggered(bool)),
            SLOT(onZoomActionTriggered(bool)));
}

QmlInspectorAdapter::~QmlInspectorAdapter()
{
}

BaseEngineDebugClient *QmlInspectorAdapter::engineClient() const
{
    return m_engineClient;
}

BaseToolsClient *QmlInspectorAdapter::toolsClient() const
{
    return m_toolsClient;
}

QmlInspectorAgent *QmlInspectorAdapter::agent() const
{
    return m_agent;
}

int QmlInspectorAdapter::currentSelectedDebugId() const
{
    return m_currentSelectedDebugId;
}

QString QmlInspectorAdapter::currentSelectedDisplayName() const
{
    return m_currentSelectedDebugName;
}

Kai Koehne's avatar
Kai Koehne committed
160
void QmlInspectorAdapter::clientStatusChanged(QmlDebug::ClientStatus status)
161 162 163 164 165 166 167 168 169 170 171
{
    QString serviceName;
    float version = 0;
    if (QmlDebugClient *client = qobject_cast<QmlDebugClient*>(sender())) {
        serviceName = client->name();
        version = client->serviceVersion();
    }

    m_debugAdapter->logServiceStatusChange(serviceName, version, status);
}

Kai Koehne's avatar
Kai Koehne committed
172
void QmlInspectorAdapter::toolsClientStatusChanged(QmlDebug::ClientStatus status)
173 174
{
    BaseToolsClient *client = qobject_cast<BaseToolsClient*>(sender());
175
    QTC_ASSERT(client, return);
Kai Koehne's avatar
Kai Koehne committed
176
    if (status == QmlDebug::Enabled) {
177 178 179 180 181 182
        m_toolsClient = client;

        connect(client, SIGNAL(currentObjectsChanged(QList<int>)),
                SLOT(selectObjectsFromToolsClient(QList<int>)));
        connect(client, SIGNAL(logActivity(QString,QString)),
                m_debugAdapter, SLOT(logServiceActivity(QString,QString)));
183
        connect(client, SIGNAL(reloaded()), SLOT(onReloaded()));
184
        connect(client, SIGNAL(destroyedObject(int)), SLOT(onDestroyedObject(int)));
185 186 187 188 189 190 191 192 193

        // only enable zoom action for Qt 4.x/old client
        // (zooming is integrated into selection tool in Qt 5).
        m_zoomAction->setEnabled(
                    qobject_cast<DeclarativeToolsClient*>(client) != 0);

        // register actions here
        // because there can be multiple QmlEngines
        // at the same time (but hopefully one one is connected)
Eike Ziller's avatar
Eike Ziller committed
194
        Core::ActionManager::registerAction(m_selectAction,
195 196
                           Core::Id(Constants::QML_SELECTTOOL),
                           m_inspectorToolsContext);
Eike Ziller's avatar
Eike Ziller committed
197
        Core::ActionManager::registerAction(m_zoomAction, Core::Id(Constants::QML_ZOOMTOOL),
198 199
                           m_inspectorToolsContext);

200
        Core::ICore::updateAdditionalContexts(Core::Context(),
201 202 203 204 205 206 207 208 209 210 211 212 213
                                       m_inspectorToolsContext);

        Utils::SavedAction *action = debuggerCore()->action(QmlUpdateOnSave);
        connect(action, SIGNAL(valueChanged(QVariant)),
                SLOT(onUpdateOnSaveChanged(QVariant)));

        action = debuggerCore()->action(ShowAppOnTop);
        connect(action, SIGNAL(valueChanged(QVariant)),
                SLOT(onShowAppOnTopChanged(QVariant)));
        if (action->isChecked())
            m_toolsClient->showAppOnTop(true);

        m_toolsClientConnected = true;
214
    } else if (m_toolsClientConnected && client == m_toolsClient) {
215 216 217 218 219
        disconnect(client, SIGNAL(currentObjectsChanged(QList<int>)),
                   this, SLOT(selectObjectsFromToolsClient(QList<int>)));
        disconnect(client, SIGNAL(logActivity(QString,QString)),
                   m_debugAdapter, SLOT(logServiceActivity(QString,QString)));

Eike Ziller's avatar
Eike Ziller committed
220
        Core::ActionManager::unregisterAction(m_selectAction,
221
                             Core::Id(Constants::QML_SELECTTOOL));
Eike Ziller's avatar
Eike Ziller committed
222
        Core::ActionManager::unregisterAction(m_zoomAction,
223 224 225 226
                             Core::Id(Constants::QML_ZOOMTOOL));

        m_selectAction->setChecked(false);
        m_zoomAction->setChecked(false);
227
        Core::ICore::updateAdditionalContexts(m_inspectorToolsContext,
228 229 230 231 232 233 234 235 236 237 238
                                       Core::Context());

        Utils::SavedAction *action = debuggerCore()->action(QmlUpdateOnSave);
        disconnect(action, 0, this, 0);
        action = debuggerCore()->action(ShowAppOnTop);
        disconnect(action, 0, this, 0);

        m_toolsClientConnected = false;
    }
}

Kai Koehne's avatar
Kai Koehne committed
239
void QmlInspectorAdapter::engineClientStatusChanged(QmlDebug::ClientStatus status)
240 241 242
{
    BaseEngineDebugClient *client
            = qobject_cast<BaseEngineDebugClient*>(sender());
243 244 245 246

    if (status == QmlDebug::Enabled) {
        QTC_ASSERT(client, return);
        setActiveEngineClient(client);
247
    } else if (m_engineClientConnected && client == m_engineClient) {
248 249 250
        m_engineClientConnected = false;
        deletePreviews();
    }
251 252 253 254 255 256 257 258 259
}

void QmlInspectorAdapter::selectObjectsFromEditor(const QList<int> &debugIds)
{
    if (m_selectionCallbackExpected) {
        m_selectionCallbackExpected = false;
        return;
    }
    m_cursorPositionChangedExternally = true;
260 261
    m_targetToSync = ToolTarget;
    m_debugIdToSelect = debugIds.first();
262
    selectObject(agent()->objectForId(m_debugIdToSelect), ToolTarget);
263 264 265 266 267 268 269
}

void QmlInspectorAdapter::selectObjectsFromToolsClient(const QList<int> &debugIds)
{
    if (debugIds.isEmpty())
        return;

270 271
    m_targetToSync = EditorTarget;
    m_debugIdToSelect = debugIds.first();
272
    selectObject(agent()->objectForId(m_debugIdToSelect), EditorTarget);
273 274
}

Kai Koehne's avatar
Kai Koehne committed
275
void QmlInspectorAdapter::onObjectFetched(const ObjectReference &ref)
276 277 278 279 280 281 282 283 284
{
    if (ref.debugId() == m_debugIdToSelect) {
        m_debugIdToSelect = -1;
        selectObject(ref, m_targetToSync);
    }
}

void QmlInspectorAdapter::createPreviewForEditor(Core::IEditor *newEditor)
{
285 286 287
    if (!m_engineClientConnected)
        return;

288 289 290 291 292 293 294 295 296
    if (newEditor && newEditor->id()
            != QmlJSEditor::Constants::C_QMLJSEDITOR_ID)
        return;

    QString filename = newEditor->document()->fileName();
    QmlJS::ModelManagerInterface *modelManager =
            QmlJS::ModelManagerInterface::instance();
    QmlJS::Document::Ptr doc = modelManager->snapshot().document(filename);
    if (!doc) {
297
        if (filename.endsWith(".qml") || filename.endsWith(".js")) {
298 299 300 301 302 303
            // add to list of docs that we have to update when
            // snapshot figures out that there's a new document
            m_pendingPreviewDocumentNames.append(filename);
        }
        return;
    }
304
    if (!doc->qmlProgram() && !filename.endsWith(".js"))
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
        return;

    QmlJS::Document::Ptr initdoc = m_loadedSnapshot.document(filename);
    if (!initdoc)
        initdoc = doc;

    if (m_textPreviews.contains(filename)) {
        QmlLiveTextPreview *preview = m_textPreviews.value(filename);
        preview->associateEditor(newEditor);
    } else {
        QmlLiveTextPreview *preview
                = new QmlLiveTextPreview(doc, initdoc, this, this);
        connect(preview,
                SIGNAL(selectedItemsChanged(QList<int>)),
                SLOT(selectObjectsFromEditor(QList<int>)));
320

321 322
        preview->setApplyChangesToQmlInspector(
                    debuggerCore()->action(QmlUpdateOnSave)->isChecked());
323 324
        connect(preview, SIGNAL(reloadRequest()),
                this, SLOT(onReload()));
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

        m_textPreviews.insert(newEditor->document()->fileName(), preview);
        preview->associateEditor(newEditor);
        preview->updateDebugIds();
    }
}

void QmlInspectorAdapter::removePreviewForEditor(Core::IEditor *editor)
{
    if (QmlLiveTextPreview *preview
            = m_textPreviews.value(editor->document()->fileName())) {
        preview->unassociateEditor(editor);
    }
}

void QmlInspectorAdapter::updatePendingPreviewDocuments(QmlJS::Document::Ptr doc)
{
    int idx = -1;
    idx = m_pendingPreviewDocumentNames.indexOf(doc->fileName());

    if (idx == -1)
        return;

    Core::EditorManager *em = Core::EditorManager::instance();
    QList<Core::IEditor *> editors
            = em->editorsForFileName(doc->fileName());

    if (editors.isEmpty())
        return;

    m_pendingPreviewDocumentNames.removeAt(idx);

    Core::IEditor *editor = editors.takeFirst();
    createPreviewForEditor(editor);
    QmlLiveTextPreview *preview
            = m_textPreviews.value(editor->document()->fileName());
    foreach (Core::IEditor *editor, editors)
        preview->associateEditor(editor);
}

void QmlInspectorAdapter::onSelectActionTriggered(bool checked)
{
367
    QTC_ASSERT(toolsClient(), return);
368 369 370 371 372 373 374 375 376 377 378
    if (checked) {
        toolsClient()->setDesignModeBehavior(true);
        toolsClient()->changeToSelectTool();
        m_zoomAction->setChecked(false);
    } else {
        toolsClient()->setDesignModeBehavior(false);
    }
}

void QmlInspectorAdapter::onZoomActionTriggered(bool checked)
{
379
    QTC_ASSERT(toolsClient(), return);
380 381 382 383 384 385 386 387 388 389 390 391
    if (checked) {
        toolsClient()->setDesignModeBehavior(true);
        toolsClient()->changeToZoomTool();
        m_selectAction->setChecked(false);
    } else {
        toolsClient()->setDesignModeBehavior(false);
    }
}

void QmlInspectorAdapter::onShowAppOnTopChanged(const QVariant &value)
{
    bool showAppOnTop = value.toBool();
392
    if (m_toolsClient && m_toolsClient->status() == QmlDebug::Enabled)
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
        m_toolsClient->showAppOnTop(showAppOnTop);
}

void QmlInspectorAdapter::onUpdateOnSaveChanged(const QVariant &value)
{
    bool updateOnSave = value.toBool();
    for (QHash<QString, QmlLiveTextPreview *>::const_iterator it
         = m_textPreviews.constBegin();
         it != m_textPreviews.constEnd(); ++it) {
        it.value()->setApplyChangesToQmlInspector(updateOnSave);
    }
}

void QmlInspectorAdapter::setActiveEngineClient(BaseEngineDebugClient *client)
{
    if (m_engineClient == client)
        return;

    m_engineClient = client;
    m_agent->setEngineClient(m_engineClient);
413
    m_engineClientConnected = true;
414 415

    if (m_engineClient &&
Kai Koehne's avatar
Kai Koehne committed
416
            m_engineClient->status() == QmlDebug::Enabled) {
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
        QmlJS::ModelManagerInterface *modelManager
                = QmlJS::ModelManagerInterface::instance();
        QmlJS::Snapshot snapshot = modelManager->snapshot();
        for (QHash<QString, QmlLiveTextPreview *>::const_iterator it
             = m_textPreviews.constBegin();
             it != m_textPreviews.constEnd(); ++it) {
            QmlJS::Document::Ptr doc = snapshot.document(it.key());
            it.value()->resetInitialDoc(doc);
        }

        initializePreviews();
    }
}

void QmlInspectorAdapter::initializePreviews()
{
    Core::EditorManager *em = Core::EditorManager::instance();
    QmlJS::ModelManagerInterface *modelManager
            = QmlJS::ModelManagerInterface::instance();
    m_loadedSnapshot = modelManager->snapshot();

    if (!m_listeningToEditorManager) {
        m_listeningToEditorManager = true;
        connect(em, SIGNAL(editorAboutToClose(Core::IEditor*)),
                this, SLOT(removePreviewForEditor(Core::IEditor*)));
        connect(em, SIGNAL(editorOpened(Core::IEditor*)),
                this, SLOT(createPreviewForEditor(Core::IEditor*)));
        connect(modelManager,
                SIGNAL(documentChangedOnDisk(QmlJS::Document::Ptr)),
                this, SLOT(updatePendingPreviewDocuments(QmlJS::Document::Ptr)));
    }

    // initial update
    foreach (Core::IEditor *editor, em->openedEditors())
        createPreviewForEditor(editor);
}

void QmlInspectorAdapter::showConnectionStatusMessage(const QString &message)
{
    m_engine->showMessage(_("QML Inspector: ") + message, LogStatus);
}

void QmlInspectorAdapter::gotoObjectReferenceDefinition(
460
        const FileReference &objSource)
461 462 463 464 465 466
{
    if (m_cursorPositionChangedExternally) {
        m_cursorPositionChangedExternally = false;
        return;
    }

467
    const QString fileName = m_engine->toFileInProject(objSource.url());
468 469 470 471 472 473 474 475 476 477 478

    Core::EditorManager *editorManager = Core::EditorManager::instance();
    Core::IEditor *currentEditor = editorManager->currentEditor();
    Core::IEditor *editor = editorManager->openEditor(fileName);
    TextEditor::ITextEditor *textEditor
            = qobject_cast<TextEditor::ITextEditor*>(editor);

    if (currentEditor != editor)
        m_selectionCallbackExpected = true;

    if (textEditor) {
479 480 481 482
        m_selectionCallbackExpected = true;
        editorManager->addCurrentPositionToNavigationHistory();
        textEditor->gotoLine(objSource.lineNumber());
        textEditor->widget()->setFocus();
483 484 485
    }
}

Kai Koehne's avatar
Kai Koehne committed
486
void QmlInspectorAdapter::selectObject(const ObjectReference &obj,
487 488
                                       SelectionTarget target)
{
489
    if (m_toolsClient && target == ToolTarget)
490
        m_toolsClient->setObjectIdList(
Kai Koehne's avatar
Kai Koehne committed
491
                    QList<ObjectReference>() << obj);
492 493

    if (target == EditorTarget)
494
        gotoObjectReferenceDefinition(obj.source());
495

496 497
    if (!agent()->selectObjectInTree(obj.debugId()))
        return;
498 499

    m_currentSelectedDebugId = obj.debugId();
500
    m_currentSelectedDebugName = agent()->displayName(obj.debugId());
501 502 503
    emit selectionChanged();
}

504 505 506 507 508 509
void QmlInspectorAdapter::deletePreviews()
{
    foreach (const QString &key, m_textPreviews.keys())
        delete m_textPreviews.take(key);
}

510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
void QmlInspectorAdapter::onReload()
{
    QHash<QString, QByteArray> changesHash;
    for (QHash<QString, QmlLiveTextPreview *>::const_iterator it
         = m_textPreviews.constBegin();
         it != m_textPreviews.constEnd(); ++it) {
        if (it.value()->hasUnsynchronizableChange()) {
            QFileInfo info = QFileInfo(it.value()->fileName());
            QFile changedFile(it.value()->fileName());
            QByteArray fileContents;
            if (changedFile.open(QFile::ReadOnly))
                fileContents = changedFile.readAll();
            changedFile.close();
            changesHash.insert(info.fileName(),
                               fileContents);
        }
    }
527 528
    if (m_toolsClient)
        m_toolsClient->reload(changesHash);
529 530 531 532 533 534 535 536 537 538 539 540 541 542
}

void QmlInspectorAdapter::onReloaded()
{
    QmlJS::ModelManagerInterface *modelManager =
            QmlJS::ModelManagerInterface::instance();
    QmlJS::Snapshot snapshot = modelManager->snapshot();
    m_loadedSnapshot = snapshot;
    for (QHash<QString, QmlLiveTextPreview *>::const_iterator it
         = m_textPreviews.constBegin();
         it != m_textPreviews.constEnd(); ++it) {
        QmlJS::Document::Ptr doc = snapshot.document(it.key());
        it.value()->resetInitialDoc(doc);
    }
543
    m_agent->reloadEngines();
544 545
}

546
void QmlInspectorAdapter::onDestroyedObject(int objectDebugId)
547
{
548
    m_agent->fetchObject(m_agent->parentIdForObject(objectDebugId));
549 550
}

551 552
} // namespace Internal
} // namespace Debugger