src/declarative/debugger/qdeclarativeinspectorservice.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include "qdeclarativeinspectorservice_p.h"
  43 #include "qdeclarativeinspectorinterface_p.h"
  44 #include "qdeclarativedebugserver_p.h"
  45
  46 #include <QtCore/QCoreApplication>
  47 #include <QtCore/QDebug>
  48 #include <QtCore/QDir>
  49 #include <QtCore/QPluginLoader>
  50
  51 // print detailed information about loading of plugins
  52 DEFINE_BOOL_CONFIG_OPTION(qmlDebugVerbose, QML_DEBUGGER_VERBOSE)
  53
  54 QT_BEGIN_NAMESPACE
  55
  56 Q_GLOBAL_STATIC(QDeclarativeInspectorService, serviceInstance)
  57
  58 QDeclarativeInspectorService::QDeclarativeInspectorService()
  59     : QDeclarativeDebugService(QLatin1String("QDeclarativeObserverMode"))
  60     , m_currentInspectorPlugin(0)
  61 {
  62 }
  63
  64 QDeclarativeInspectorService *QDeclarativeInspectorService::instance()
  65 {
  66     return serviceInstance();
  67 }
  68
  69 void QDeclarativeInspectorService::addView(QObject *view)
  70 {
  71     m_views.append(view);
  72     updateStatus();
  73 }
  74
  75 void QDeclarativeInspectorService::removeView(QObject *view)
  76 {
  77     m_views.removeAll(view);
  78     updateStatus();
  79 }
  80
  81 void QDeclarativeInspectorService::sendMessage(const QByteArray &message)
  82 {
  83     if (status() != Enabled)
  84         return;
  85
  86     QDeclarativeDebugService::sendMessage(message);
  87 }
  88
  89 void QDeclarativeInspectorService::statusChanged(Status /*status*/)
  90 {
  91     updateStatus();
  92 }
  93
  94 void QDeclarativeInspectorService::updateStatus()
  95 {
  96     if (m_views.isEmpty()) {
  97         if (m_currentInspectorPlugin) {
  98             m_currentInspectorPlugin->deactivate();
  99             m_currentInspectorPlugin = 0;
 100         }
 101         return;
 102     }
 103
 104     if (status() == Enabled) {
 105         if (m_inspectorPlugins.isEmpty())
 106             loadInspectorPlugins();
 107
 108         if (m_inspectorPlugins.isEmpty()) {
 109             qWarning() << "QDeclarativeInspector: No plugins found.";
 110             QDeclarativeDebugServer::instance()->removeService(this);
 111             return;
 112         }
 113
 114         foreach (QDeclarativeInspectorInterface *inspector, m_inspectorPlugins) {
 115             if (inspector->canHandleView(m_views.first())) {
 116                 m_currentInspectorPlugin = inspector;
 117                 break;
 118             }
 119         }
 120
 121         if (!m_currentInspectorPlugin) {
 122             qWarning() << "QDeclarativeInspector: No plugin available for view '" << m_views.first()->metaObject()->className() << "'.";
 123             return;
 124         }
 125         m_currentInspectorPlugin->activate(m_views.first());
 126     } else {
 127         if (m_currentInspectorPlugin) {
 128             m_currentInspectorPlugin->deactivate();
 129             m_currentInspectorPlugin = 0;
 130         }
 131     }
 132 }
 133
 134 void QDeclarativeInspectorService::messageReceived(const QByteArray &message)
 135 {
 136     QMetaObject::invokeMethod(this, "processMessage", Qt::QueuedConnection, Q_ARG(QByteArray, message));
 137 }
 138
 139 void QDeclarativeInspectorService::processMessage(const QByteArray &message)
 140 {
 141     if (m_currentInspectorPlugin)
 142         m_currentInspectorPlugin->clientMessage(message);
 143 }
 144
 145 void QDeclarativeInspectorService::loadInspectorPlugins()
 146 {
 147     QStringList pluginCandidates;
 148     const QStringList paths = QCoreApplication::libraryPaths();
 149     foreach (const QString &libPath, paths) {
 150         const QDir dir(libPath + QLatin1String("/qmltooling"));
 151         if (dir.exists())
 152             foreach (const QString &pluginPath, dir.entryList(QDir::Files))
 153                 pluginCandidates << dir.absoluteFilePath(pluginPath);
 154     }
 155
 156     foreach (const QString &pluginPath, pluginCandidates) {
 157         if (qmlDebugVerbose())
 158             qDebug() << "QDeclarativeInspector: Trying to load plugin " << pluginPath << "...";
 159
 160         QPluginLoader loader(pluginPath);
 161         if (!loader.load()) {
 162             if (qmlDebugVerbose())
 163                 qDebug() << "QDeclarativeInspector: Error while loading: " << loader.errorString();
 164
 165             continue;
 166         }
 167
 168         QDeclarativeInspectorInterface *inspector =
 169                 qobject_cast<QDeclarativeInspectorInterface*>(loader.instance());
 170         if (inspector) {
 171             if (qmlDebugVerbose())
 172                 qDebug() << "QDeclarativeInspector: Plugin successfully loaded.";
 173             m_inspectorPlugins << inspector;
 174         } else {
 175             if (qmlDebugVerbose())
 176                 qDebug() << "QDeclarativeInspector: Plugin does not implement interface QDeclarativeInspectorInterface.";
 177
 178             loader.unload();
 179         }
 180     }
 181 }
 182
 183 QT_END_NAMESPACE