Move debugger initialization out of QQmlDebugServer and QQmlEngine

QQmlDebugConnector has to check the parameters before deciding if (and
what kind of) instance to create. It also has to add the services
itself as we don't want to tie a specific implementation of
QQmlDebugConnector to a specific set of services. Logic to load the
services from plugins will be added in a separate change. Integrating
the service initialization with the connector initialization enables us
to load the services before the server thread startsi, which will
simplify the thread synchronization.

QQmlConfigurableDebugService has to recheck for blockingMode once it
gets enabled as it cannot rely on being enabled right away anymore. It
should have done that already before as it's possible to disable and
re-enable services.

Change-Id: I9d161d78836bae10d688a90b4c2a32efed320412
Reviewed-by: Simon Hausmann <simon.hausmann@theqtcompany.com>

1 files changed, 120 insertions, 0 deletions

diff --git a/src/qml/debugger/qqmldebug.cpp b/src/qml/debugger/qqmldebug.cpp
new file mode 100644
index 0000000000..83718921f1
--- /dev/null
+++ b/src/qml/debugger/qqmldebug.cpp
@@ -0,0 +1,120 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the QtQml module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL21$
+** 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 The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** 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 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file. Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** As a special exception, The Qt Company gives you certain additional
+** rights. These rights are described in The Qt Company LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qqmldebug.h"
+#include "qqmldebugconnector_p.h"
+
+#include <private/qqmlengine_p.h>
+
+QT_BEGIN_NAMESPACE
+
+QQmlDebuggingEnabler::QQmlDebuggingEnabler(bool printWarning)
+{
+#ifndef QQML_NO_DEBUG_PROTOCOL
+    if (!QQmlEnginePrivate::qml_debugging_enabled
+            && printWarning) {
+        qDebug("QML debugging is enabled. Only use this in a safe environment.");
+    }
+    QQmlEnginePrivate::qml_debugging_enabled = true;
+#else
+    Q_UNUSED(printWarning);
+#endif
+}
+
+/*!
+ * \enum QQmlDebuggingEnabler::StartMode
+ *
+ * Defines the debug server's start behavior. You can interrupt QML engines starting while a debug
+ * client is connecting, in order to set breakpoints in or profile startup code.
+ *
+ * \value DoNotWaitForClient Run any QML engines as usual while the debug services are connecting.
+ * \value WaitForClient      If a QML engine starts while the debug services are connecting,
+ *                           interrupt it until they are done.
+ */
+
+/*!
+ * Enables debugging for QML engines created after calling this function. The debug server will
+ * listen on \a port at \a hostName and block the QML engine until it receives a connection if
+ * \a mode is \c WaitForClient. If \a mode is not specified it won't block and if \a hostName is not
+ * specified it will listen on all available interfaces. You can only start one debug server at a
+ * time. A debug server may have already been started if the -qmljsdebugger= command line argument
+ * was given. This method returns \c true if a new debug server was successfully started, or
+ * \c false otherwise.
+ */
+bool QQmlDebuggingEnabler::startTcpDebugServer(int port, StartMode mode, const QString &hostName)
+{
+#ifndef QQML_NO_DEBUG_PROTOCOL
+    QQmlDebugConnector::setPluginKey(QLatin1String("QQmlDebugServer"));
+    QQmlDebugConnector *connector = QQmlDebugConnector::instance();
+    if (connector) {
+        QVariantHash configuration;
+        configuration[QLatin1String("portFrom")] = configuration[QLatin1String("portTo")] = port;
+        configuration[QLatin1String("block")] = (mode == WaitForClient);
+        configuration[QLatin1String("hostAddress")] = hostName;
+        return connector->open(configuration);
+    }
+#else
+    Q_UNUSED(port);
+    Q_UNUSED(block);
+    Q_UNUSED(hostName);
+#endif
+    return false;
+}
+
+/*!
+ * Enables debugging for QML engines created after calling this function. The debug server will
+ * connect to a debugger waiting on a local socket at the given \a socketFileName and block the QML
+ * engine until the connection is established if \a mode is \c WaitForClient. If \a mode is not
+ * specified it will not block. You can only start one debug server at a time. A debug server may
+ * have already been started if the -qmljsdebugger= command line argument was given. This method
+ * returns \c true if a new debug server was successfully started, or \c false otherwise.
+ */
+bool QQmlDebuggingEnabler::connectToLocalDebugger(const QString &socketFileName, StartMode mode)
+{
+#ifndef QQML_NO_DEBUG_PROTOCOL
+    QQmlDebugConnector::setPluginKey(QLatin1String("QQmlDebugServer"));
+    QQmlDebugConnector *connector = QQmlDebugConnector::instance();
+    if (connector) {
+        QVariantHash configuration;
+        configuration[QLatin1String("fileName")] = socketFileName;
+        configuration[QLatin1String("block")] = (mode == WaitForClient);
+        return connector->open(configuration);
+    }
+#else
+    Q_UNUSED(fileName);
+    Q_UNUSED(block);
+#endif
+    return false;
+}
+
+QT_END_NAMESPACE