Add XML serialization/deserialization to SerialPortInfo.

oscar/SleepLib/deviceconnection.cpp

@@ -7,22 +7,109 @@
  * for more details. */
 
 #include "deviceconnection.h"
+#include <QtSerialPort/QSerialPortInfo>
+#include <QDebug>
+
+
+static QString hex(int i)
+{
+    return QString("0x") + QString::number(i, 16).toUpper();
+}
+
+
+// MARK: -
 
 SerialPortInfo::SerialPortInfo(const QSerialPortInfo & other)
-    : QSerialPortInfo(other)
 {
+    if (other.isNull() == false) {
+        m_info["portName"] = other.portName();
+        m_info["systemLocation"] = other.systemLocation();
+        m_info["description"] = other.description();
+        m_info["manufacturer"] = other.manufacturer();
+        m_info["serialNumber"] = other.serialNumber();
+        if (other.hasVendorIdentifier()) {
+            m_info["vendorIdentifier"] = other.vendorIdentifier();
+        }
+        if (other.hasProductIdentifier()) {
+            m_info["productIdentifier"] = other.productIdentifier();
+        }
+    }
 }
 
 SerialPortInfo::SerialPortInfo(const SerialPortInfo & other)
-    : QSerialPortInfo(dynamic_cast<const SerialPortInfo &>(other))
+    : m_info(other.m_info)
 {
 }
 
+SerialPortInfo::SerialPortInfo(const QString & data)
+{
+    QXmlStreamReader xml(data);
+    xml.readNextStartElement();
+    xml >> *this;
+}
+
 QList<SerialPortInfo> SerialPortInfo::availablePorts()
 {
+    // TODO: internal state when in record or playback mode
+
     QList<SerialPortInfo> out;
     for (auto & info : QSerialPortInfo::availablePorts()) {
-        out.append(SerialPortInfo(info));
+        SerialPortInfo portInfo(info);
+        qDebug().noquote() << portInfo;
+        out.append(portInfo);
     }
     return out;
 }
+
+QXmlStreamWriter & operator<<(QXmlStreamWriter & xml, const SerialPortInfo & info)
+{
+    xml.writeStartElement("serial");
+    if (info.isNull() == false) {
+        xml.writeAttribute("portName", info.portName());
+        xml.writeAttribute("systemLocation", info.systemLocation());
+        xml.writeAttribute("description", info.description());
+        xml.writeAttribute("manufacturer", info.manufacturer());
+        xml.writeAttribute("serialNumber", info.serialNumber());
+        if (info.hasVendorIdentifier()) {
+            xml.writeAttribute("vendorIdentifier", hex(info.vendorIdentifier()));
+        }
+        if (info.hasProductIdentifier()) {
+            xml.writeAttribute("productIdentifier", hex(info.productIdentifier()));
+        }
+    }
+    xml.writeEndElement();
+    return xml;
+}
+
+QXmlStreamReader & operator>>(QXmlStreamReader & xml, SerialPortInfo & info)
+{
+    if (xml.atEnd() == false && xml.isStartElement() && xml.name() == "serial") {
+        for (auto & attribute : xml.attributes()) {
+            QString name = attribute.name().toString();
+            QString value = attribute.value().toString();
+            if (name == "vendorIdentifier" || name == "productIdentifier") {
+                bool ok;
+                quint16 id = value.toUInt(&ok, 0);
+                if (ok) {
+                    info.m_info[name] = id;
+                } else {
+                    qWarning() << "invalid" << name << "value" << value;
+                }
+            } else {
+                info.m_info[name] = value;
+            }
+        }
+    } else {
+        qWarning() << "no <serial> tag";
+    }
+    xml.readNext();
+    return xml;
+}
+
+SerialPortInfo::operator QString() const
+{
+    QString out;
+    QXmlStreamWriter xml(&out);
+    xml << *this;
+    return out;
+}

oscar/SleepLib/deviceconnection.h

@@ -13,7 +13,10 @@
 // connections to devices. For now it just supports serial ports.
 
 #include <QtSerialPort/QSerialPort>
-#include <QtSerialPort/QSerialPortInfo>
+#include <QHash>
+#include <QVariant>
+#include <QXmlStreamReader>
+#include <QXmlStreamWriter>
 
 // TODO: This class may eventually be internal to a DeviceConnection class,
 // but for now it is used to provide support for recording and playback of
@@ -25,14 +28,34 @@ class SerialPort : public QSerialPort
 // TODO: This class's functionality will eventually be internal to a
 // DeviceConnection class, but for now it is needed to support recording
 // and playback of serial port scanning before refactoring.
-class SerialPortInfo : public QSerialPortInfo
+class SerialPortInfo
 {
 public:
     static QList<SerialPortInfo> availablePorts();
     SerialPortInfo(const SerialPortInfo & other);
+    SerialPortInfo(const QString & data);
+
+    inline QString portName() const { return m_info["portName"].toString(); }
+    inline QString systemLocation() const { return m_info["systemLocation"].toString(); }
+    inline QString description() const { return m_info["description"].toString(); }
+    inline QString manufacturer() const { return m_info["manufacturer"].toString(); }
+    inline QString serialNumber() const { return m_info["serialNumber"].toString(); }
+
+    inline quint16 vendorIdentifier() const { return m_info["vendorIdentifier"].toInt(); }
+    inline quint16 productIdentifier() const { return m_info["productIdentifier"].toInt(); }
+
+    inline bool hasVendorIdentifier() const { return m_info.contains("vendorIdentifier"); }
+    inline bool hasProductIdentifier() const { return m_info.contains("productIdentifier"); }
+
+    inline bool isNull() const { return m_info.isEmpty(); }
+
+    operator QString() const;
+    friend QXmlStreamWriter & operator<<(QXmlStreamWriter & xml, const SerialPortInfo & info);
+    friend QXmlStreamReader & operator>>(QXmlStreamReader & xml, SerialPortInfo & info);
 
 protected:
-    SerialPortInfo(const QSerialPortInfo & other);
+    SerialPortInfo(const class QSerialPortInfo & other);
+    QHash<QString,QVariant> m_info;
 };
 
 #endif // DEVICECONNECTION_H

oscar/oscar.pro

@@ -538,6 +538,7 @@ test {
         tests/sessiontests.cpp \
         tests/versiontests.cpp \
         tests/viatomtests.cpp \
+        tests/deviceconnectiontests.cpp \
         tests/dreemtests.cpp \
         tests/zeotests.cpp
 
@@ -548,6 +549,7 @@ test {
         tests/sessiontests.h \
         tests/versiontests.h \
         tests/viatomtests.h \
+        tests/deviceconnectiontests.h \
         tests/dreemtests.h \
         tests/zeotests.h
 }

oscar/tests/deviceconnectiontests.cpp

@@ -0,0 +1,52 @@
+/* Device Connection Unit Tests
+ *
+ * Copyright (c) 2020 The OSCAR Team
+ *
+ * This file is subject to the terms and conditions of the GNU General Public
+ * License. See the file COPYING in the main directory of the source code
+ * for more details. */
+
+#include "deviceconnectiontests.h"
+#include "SleepLib/deviceconnection.h"
+
+void DeviceConnectionTests::testSerialPortInfoSerialization()
+{
+    QString serialized;
+    
+    // With VID and PID
+    const QString tag = R"(<serial portName="cu.SLAB_USBtoUART" systemLocation="/dev/cu.SLAB_USBtoUART" description="CP210x USB to UART Bridge Controller" manufacturer="Silicon Labs" serialNumber="0001" vendorIdentifier="0x10C4" productIdentifier="0xEA60"/>)";
+    SerialPortInfo info = SerialPortInfo(tag);
+    Q_ASSERT(info.isNull() == false);
+    Q_ASSERT(info.portName() == "cu.SLAB_USBtoUART");
+    Q_ASSERT(info.systemLocation() == "/dev/cu.SLAB_USBtoUART");
+    Q_ASSERT(info.description() == "CP210x USB to UART Bridge Controller");
+    Q_ASSERT(info.manufacturer() == "Silicon Labs");
+    Q_ASSERT(info.serialNumber() == "0001");
+    Q_ASSERT(info.hasVendorIdentifier());
+    Q_ASSERT(info.hasProductIdentifier());
+    Q_ASSERT(info.vendorIdentifier() == 0x10C4);
+    Q_ASSERT(info.productIdentifier() == 0xEA60);
+    serialized = info;
+    Q_ASSERT(serialized == tag);
+    
+    // Without VID or PID
+    const QString tag2 = R"(<serial portName="cu.Bluetooth-Incoming-Port" systemLocation="/dev/cu.Bluetooth-Incoming-Port" description="incoming port - Bluetooth-Incoming-Port" manufacturer="" serialNumber=""/>)";
+    SerialPortInfo info2 = SerialPortInfo(tag2);
+    Q_ASSERT(info2.isNull() == false);
+    Q_ASSERT(info2.portName() == "cu.Bluetooth-Incoming-Port");
+    Q_ASSERT(info2.systemLocation() == "/dev/cu.Bluetooth-Incoming-Port");
+    Q_ASSERT(info2.description() == "incoming port - Bluetooth-Incoming-Port");
+    Q_ASSERT(info2.manufacturer() == "");
+    Q_ASSERT(info2.serialNumber() == "");
+    Q_ASSERT(info2.hasVendorIdentifier() == false);
+    Q_ASSERT(info2.hasProductIdentifier() == false);
+    serialized = info2;
+    Q_ASSERT(serialized == tag2);
+
+    // Empty
+    const QString tag3 = R"(<serial/>)";
+    SerialPortInfo info3 = SerialPortInfo(tag3);
+    Q_ASSERT(info3.isNull() == true);
+    serialized = info3;
+    Q_ASSERT(serialized == tag3);
+}

oscar/tests/deviceconnectiontests.h

@@ -0,0 +1,17 @@
+/* Device Connection Unit Tests
+ *
+ * Copyright (c) 2020 The OSCAR Team
+ *
+ * This file is subject to the terms and conditions of the GNU General Public
+ * License. See the file COPYING in the main directory of the source code
+ * for more details. */
+
+#include "tests/AutoTest.h"
+
+class DeviceConnectionTests : public QObject
+{
+    Q_OBJECT
+private slots:
+    void testSerialPortInfoSerialization();
+};
+DECLARE_TEST(DeviceConnectionTests)