Bluetooth - device (LE) discovery for iOS

Add a QBluetoothDeviceDiscoveryAgent for iOS, implementation is based on
Core Bluetooth framework. Low Energy devices scan only.
- Ctor with address: set error as invalid bluetooth adapter error,
  Core Bluetooth framework does not provide access to the local adapter's address.
- Adjust a test - we do not have access to the 'local device' information on iOS
  (no address, no number of devices etc.) - skip the last test in tst_deviceDiscovery.

Change-Id: I49080d021c340016aebc548cc8ed758777c66397
Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>

1 files changed, 387 insertions, 0 deletions

diff --git a/src/bluetooth/qbluetoothdevicediscoveryagent_ios.mm b/src/bluetooth/qbluetoothdevicediscoveryagent_ios.mm
new file mode 100644
index 00000000..20304d99
--- /dev/null
+++ b/src/bluetooth/qbluetoothdevicediscoveryagent_ios.mm
@@ -0,0 +1,387 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtBluetooth module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** 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.
+**
+** 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 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
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qbluetoothdevicediscoveryagent.h"
+#include "osx/osxbtledeviceinquiry_p.h"
+#include "qbluetoothlocaldevice.h"
+#include "qbluetoothdeviceinfo.h"
+#include "osx/osxbtutility_p.h"
+#include "qbluetoothuuid.h"
+
+#include <QtCore/qloggingcategory.h>
+#include <QtCore/qstring.h>
+#include <QtCore/qdebug.h>
+#include <QtCore/qlist.h>
+
+#include <CoreBluetooth/CoreBluetooth.h>
+
+QT_BEGIN_NAMESPACE
+
+using OSXBluetooth::ObjCScopedPointer;
+
+class QBluetoothDeviceDiscoveryAgentPrivate : public OSXBluetooth::LEDeviceInquiryDelegate
+{
+    friend class QBluetoothDeviceDiscoveryAgent;
+public:
+    QBluetoothDeviceDiscoveryAgentPrivate(const QBluetoothAddress &address,
+                                          QBluetoothDeviceDiscoveryAgent *q);
+    virtual ~QBluetoothDeviceDiscoveryAgentPrivate();
+
+    bool isValid() const;
+    bool isActive() const;
+
+    void start();
+    void stop();
+
+private:
+    // LEDeviceInquiryDelegate:
+    void LEdeviceInquiryError(QBluetoothDeviceDiscoveryAgent::Error error) Q_DECL_OVERRIDE;
+    void LEnotSupported() Q_DECL_OVERRIDE;
+    void LEdeviceFound(CBPeripheral *peripheral, const QBluetoothUuid &deviceUuid,
+                       NSDictionary *advertisementData, NSNumber *RSSI) Q_DECL_OVERRIDE;
+    void LEdeviceInquiryFinished() Q_DECL_OVERRIDE;
+
+    void setError(QBluetoothDeviceDiscoveryAgent::Error, const QString &text = QString());
+
+    QBluetoothDeviceDiscoveryAgent *q_ptr;
+
+    QBluetoothDeviceDiscoveryAgent::Error lastError;
+    QString errorString;
+
+    QBluetoothDeviceDiscoveryAgent::InquiryType inquiryType;
+
+    typedef ObjCScopedPointer<LEDeviceInquiryObjC> LEDeviceInquiry;
+    LEDeviceInquiry inquiryLE;
+
+    typedef QList<QBluetoothDeviceInfo> DevicesList;
+    DevicesList discoveredDevices;
+
+    bool startPending;
+    bool stopPending;
+};
+
+QBluetoothDeviceDiscoveryAgentPrivate::QBluetoothDeviceDiscoveryAgentPrivate(const QBluetoothAddress &adapter,
+                                                                             QBluetoothDeviceDiscoveryAgent *q) :
+    q_ptr(q),
+    lastError(QBluetoothDeviceDiscoveryAgent::NoError),
+    inquiryType(QBluetoothDeviceDiscoveryAgent::GeneralUnlimitedInquiry),
+    startPending(false),
+    stopPending(false)
+{
+    Q_UNUSED(adapter);
+
+    Q_ASSERT_X(q != Q_NULLPTR, "QBluetoothDeviceDiscoveryAgentPrivate()",
+               "invalid q_ptr (null)");
+
+    // OSXBTLEDeviceInquiry can be constructed even if LE is not supported -
+    // at this stage it's only a memory allocation of the object itself,
+    // if it fails - we have some memory-related problems.
+    LEDeviceInquiry newInquiryLE([[LEDeviceInquiryObjC alloc] initWithDelegate:this]);
+    if (!newInquiryLE) {
+        qCWarning(QT_BT_OSX) << "QBluetoothDeviceDiscoveryAgentPrivate() "
+                                "failed to initialize a device inquiry object";
+        return;
+    }
+
+    inquiryLE.reset(newInquiryLE.take());
+}
+
+QBluetoothDeviceDiscoveryAgentPrivate::~QBluetoothDeviceDiscoveryAgentPrivate()
+{
+}
+
+bool QBluetoothDeviceDiscoveryAgentPrivate::isValid() const
+{
+    // isValid() - Qt does not use exceptions, but the ctor
+    // can fail to initialize some important data-members
+    // - this is what meant here by valid/invalid.
+    return inquiryLE;
+}
+
+bool QBluetoothDeviceDiscoveryAgentPrivate::isActive() const
+{
+    if (startPending)
+        return true;
+    if (stopPending)
+        return false;
+
+    return [inquiryLE isActive];
+}
+
+void QBluetoothDeviceDiscoveryAgentPrivate::start()
+{
+    Q_ASSERT_X(isValid(), "start()", "called on invalid device discovery agent");
+    Q_ASSERT_X(!isActive(), "start()", "called on active device discovery agent");
+    Q_ASSERT_X(lastError != QBluetoothDeviceDiscoveryAgent::InvalidBluetoothAdapterError,
+               "startLE()", "called with an invalid Bluetooth adapter");
+
+    if (stopPending) {
+        startPending = true;
+        return;
+    }
+
+    discoveredDevices.clear();
+    setError(QBluetoothDeviceDiscoveryAgent::NoError);
+
+    if (![inquiryLE start]) {
+        // We can be here only if we have some kind of
+        // resource allocation error.
+        setError(QBluetoothDeviceDiscoveryAgent::UnknownError,
+                 QObject::tr("device discovery agent, failed to start: "
+                             "resource allocation error"));
+        emit q_ptr->error(lastError);
+    }
+}
+
+void QBluetoothDeviceDiscoveryAgentPrivate::stop()
+{
+    Q_ASSERT_X(isValid(), "stop()", "called on invalid device discovery agent");
+    Q_ASSERT_X(isActive(), "stop()", "called whithout active inquiry");
+    Q_ASSERT_X(lastError != QBluetoothDeviceDiscoveryAgent::InvalidBluetoothAdapterError,
+               "stop()", "called with invalid bluetooth adapter");
+
+    startPending = false;
+    stopPending = true;
+
+    setError(QBluetoothDeviceDiscoveryAgent::NoError);
+    // Can be asynchronous (depending on a status update of CBCentralManager).
+    // The call itself is always 'success'.
+    [inquiryLE stop];
+}
+
+void QBluetoothDeviceDiscoveryAgentPrivate::LEdeviceInquiryError(QBluetoothDeviceDiscoveryAgent::Error error)
+{
+    // At the moment the only error reported by osxbtledeviceinquiry
+    // can be 'powered off' error, it happens
+    // after the LE scan started (so we have LE support and this is
+    // a real PoweredOffError).
+    Q_ASSERT_X(error == QBluetoothDeviceDiscoveryAgent::PoweredOffError,
+               "LEdeviceInquiryError", "unexpected error");
+
+    startPending = false;
+    stopPending = false;
+    setError(error);
+    emit q_ptr->error(lastError);
+}
+
+void QBluetoothDeviceDiscoveryAgentPrivate::LEnotSupported()
+{
+    startPending = false;
+    stopPending = false;
+    setError(QBluetoothDeviceDiscoveryAgent::UnsupportedPlatformError);
+    emit q_ptr->error(lastError);
+}
+
+void QBluetoothDeviceDiscoveryAgentPrivate::LEdeviceFound(CBPeripheral *peripheral, const QBluetoothUuid &deviceUuid,
+                                                          NSDictionary *advertisementData,
+                                                          NSNumber *RSSI)
+{
+    Q_ASSERT_X(peripheral, "LEdeviceFound", "invalid peripheral (nil)");
+
+    QT_BT_MAC_AUTORELEASEPOOL;
+
+    QString name;
+    if (peripheral.name && peripheral.name.length) {
+        name = QString::fromNSString(peripheral.name);
+    } else {
+        NSString *const localName = [advertisementData objectForKey:CBAdvertisementDataLocalNameKey];
+        if (localName && [localName length])
+            name = QString::fromNSString(localName);
+    }
+
+    // TODO: fix 'classOfDevice' (0 for now).
+    QBluetoothDeviceInfo newDeviceInfo(deviceUuid, name, 0);
+    if (RSSI)
+        newDeviceInfo.setRssi([RSSI shortValue]);
+    // CoreBluetooth scans only for LE devices.
+    newDeviceInfo.setCoreConfigurations(QBluetoothDeviceInfo::LowEnergyCoreConfiguration);
+
+    // Update, append or discard.
+    for (int i = 0, e = discoveredDevices.size(); i < e; ++i) {
+        if (discoveredDevices[i].deviceUuid() == newDeviceInfo.deviceUuid()) {
+            if (discoveredDevices[i] == newDeviceInfo)
+                return;
+
+            discoveredDevices.replace(i, newDeviceInfo);
+            emit q_ptr->deviceDiscovered(newDeviceInfo);
+            return;
+        }
+    }
+
+    discoveredDevices.append(newDeviceInfo);
+    emit q_ptr->deviceDiscovered(newDeviceInfo);
+}
+
+void QBluetoothDeviceDiscoveryAgentPrivate::LEdeviceInquiryFinished()
+{
+    Q_ASSERT_X(isValid(), "LEdeviceInquiryFinished", "invalid device discovery agent");
+
+    if (stopPending && !startPending) {
+        stopPending = false;
+        emit q_ptr->canceled();
+    } else if (startPending) {
+        startPending = false;
+        stopPending = false;
+        start();
+    } else {
+        emit q_ptr->finished();
+    }
+}
+
+void QBluetoothDeviceDiscoveryAgentPrivate::setError(QBluetoothDeviceDiscoveryAgent::Error error,
+                                                     const QString &text)
+{
+    lastError = error;
+
+    if (text.length() > 0) {
+        errorString = text;
+    } else {
+        switch (lastError) {
+        case QBluetoothDeviceDiscoveryAgent::NoError:
+            errorString = QString();
+            break;
+        case QBluetoothDeviceDiscoveryAgent::PoweredOffError:
+            errorString = QObject::tr("device discovery agent: adapter is powered off");
+            break;
+        case QBluetoothDeviceDiscoveryAgent::InvalidBluetoothAdapterError:
+            errorString = QObject::tr("device discovery agent: invalid bluetooth adapter");
+            break;
+        case QBluetoothDeviceDiscoveryAgent::InputOutputError:
+            errorString = QObject::tr("device discovery agent: input output error");
+            break;
+        case QBluetoothDeviceDiscoveryAgent::UnsupportedPlatformError:
+            errorString = QObject::tr("Bluetooth LE is not supported");
+            break;
+        case QBluetoothDeviceDiscoveryAgent::UnknownError:
+        default:
+            errorString = QObject::tr("device discovery agent: unknown error");
+        }
+    }
+}
+
+QBluetoothDeviceDiscoveryAgent::QBluetoothDeviceDiscoveryAgent(QObject *parent) :
+    QObject(parent),
+    d_ptr(new QBluetoothDeviceDiscoveryAgentPrivate(QBluetoothAddress(), this))
+{
+}
+
+QBluetoothDeviceDiscoveryAgent::QBluetoothDeviceDiscoveryAgent(
+    const QBluetoothAddress &deviceAdapter, QObject *parent) :
+    QObject(parent),
+    d_ptr(new QBluetoothDeviceDiscoveryAgentPrivate(deviceAdapter, this))
+{
+    if (!deviceAdapter.isNull()) {
+        qCWarning(QT_BT_OSX) << "QBluetoothDeviceDiscoveryAgent::QBluetoothDeviceDiscoveryAgent(), "
+                                "local device address is not available, provided address is ignored";
+        d_ptr->setError(InvalidBluetoothAdapterError);
+    }
+}
+
+QBluetoothDeviceDiscoveryAgent::~QBluetoothDeviceDiscoveryAgent()
+{
+    delete d_ptr;
+}
+
+QBluetoothDeviceDiscoveryAgent::InquiryType QBluetoothDeviceDiscoveryAgent::inquiryType() const
+{
+    return d_ptr->inquiryType;
+}
+
+void QBluetoothDeviceDiscoveryAgent::setInquiryType(QBluetoothDeviceDiscoveryAgent::InquiryType type)
+{
+    d_ptr->inquiryType = type;
+}
+
+QList<QBluetoothDeviceInfo> QBluetoothDeviceDiscoveryAgent::discoveredDevices() const
+{
+    return d_ptr->discoveredDevices;
+}
+
+void QBluetoothDeviceDiscoveryAgent::start()
+{
+    if (d_ptr->lastError != InvalidBluetoothAdapterError) {
+        if (d_ptr->isValid()) {
+            if (!isActive()) {
+                d_ptr->start();
+            } else {
+                qCDebug(QT_BT_OSX) << "QBluetoothDeviceDiscoveryAgent::start(), "
+                                      "already started";
+            }
+        } else {
+            // We previously failed to initialize
+            // private object correctly.
+            d_ptr->setError(InvalidBluetoothAdapterError);
+            emit error(InvalidBluetoothAdapterError);
+        }
+    }
+}
+
+void QBluetoothDeviceDiscoveryAgent::stop()
+{
+    if (d_ptr->isValid()) {
+        if (isActive() && d_ptr->lastError != InvalidBluetoothAdapterError) {
+            d_ptr->stop();
+        } else {
+            qCDebug(QT_BT_OSX) << "QBluetoothDeviceDiscoveryAgent::stop(), "
+                                  "failed to stop";
+        }
+    }
+}
+
+bool QBluetoothDeviceDiscoveryAgent::isActive() const
+{
+    if (d_ptr->isValid())
+        return d_ptr->isActive();
+
+    return false;
+}
+
+QBluetoothDeviceDiscoveryAgent::Error QBluetoothDeviceDiscoveryAgent::error() const
+{
+    return d_ptr->lastError;
+}
+
+QString QBluetoothDeviceDiscoveryAgent::errorString() const
+{
+    return d_ptr->errorString;
+}
+
+QT_END_NAMESPACE