ConnectionInfo.h

/***************************************************************************
 *   Copyright (C) 2024-2025 by Stefan Kebekus                             *
 *   stefan.kebekus@gmail.com                                              *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 3 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
 
#pragma once
 
#include <QBluetoothDeviceInfo>
#include <QQmlEngine>
 
#if __has_include (<QSerialPortInfo>)
#include <QSerialPort>
#include <QSerialPortInfo>
#endif
 
using namespace Qt::Literals::StringLiterals;
 
 
namespace Traffic {

class ConnectionInfo {
    Q_GADGET
    QML_VALUE_TYPE(connectionInfo)
 
    friend QDataStream& operator<<(QDataStream& stream, const Traffic::ConnectionInfo &connectionInfo);
    friend QDataStream& operator>>(QDataStream& stream, Traffic::ConnectionInfo& connectionInfo);
 
public:
    enum Type : quint8 {
        Invalid,            
        BluetoothClassic,   
        BluetoothLowEnergy, 
        TCP,                
        UDP,                
        Serial,             
        FLARMFile,          
        OGN                 
    };
    Q_ENUM(Type)
 
    // Duplicated from QSerialPort, in order to make it available to QML
    enum BaudRate {
        Baud1200 = 1200,
        Baud2400 = 2400,
        Baud4800 = 4800,
        Baud9600 = 9600,
        Baud19200 = 19200,
        Baud38400 = 38400,
        Baud57600 = 57600,
        Baud115200 = 115200
    };
    Q_ENUM(BaudRate)
 
    // Duplicated from QSerialPort, in order to make it available to QML
    enum StopBits {
        OneStop = 1,
        TwoStop = 2
    };
    Q_ENUM(StopBits)
 
    // Duplicated from QSerialPort, in order to make it available to QML
    enum FlowControl {
        NoFlowControl,
        HardwareControl,
        SoftwareControl
    };
    Q_ENUM(FlowControl)
 
    
    ConnectionInfo() = default;

    explicit ConnectionInfo(const QBluetoothDeviceInfo& info, bool canonical=false);

    explicit ConnectionInfo(const QString& serialPortNameOrDescription,
                            ConnectionInfo::BaudRate baudRate = ConnectionInfo::BaudRate::Baud9600,
                            ConnectionInfo::StopBits stopBits = ConnectionInfo::StopBits::OneStop,
                            ConnectionInfo::FlowControl flowControl = ConnectionInfo::FlowControl::NoFlowControl,
                            bool canonical = false);

    explicit ConnectionInfo(quint16 port, bool canonical=false);

    explicit ConnectionInfo(const QString& host, quint16 port, bool canonical=false);

    struct OgnInfo{};

    explicit ConnectionInfo(const OgnInfo& info);
 
 
    //
    // Properties
    //

    Q_PROPERTY(bool canConnect READ canConnect CONSTANT)
    [[nodiscard]] bool canConnect() const { return m_canConnect; }

    Q_PROPERTY(bool canonical READ canonical CONSTANT)
    [[nodiscard]] bool canonical() const { return m_canonical; }

    Q_PROPERTY(QString description READ description CONSTANT)
    [[nodiscard]] QString description() const { return m_description; }

    Q_PROPERTY(QString host READ host CONSTANT)
    [[nodiscard]] QString host() const { return m_host; }

    Q_PROPERTY(QString icon READ icon CONSTANT)
    [[nodiscard]] QString icon() const { return m_icon; }

    Q_PROPERTY(QString name READ name CONSTANT)
    [[nodiscard]] QString name() const { return m_name; }

    Q_PROPERTY(Traffic::ConnectionInfo::Type type READ type CONSTANT)
    [[nodiscard]] Traffic::ConnectionInfo::Type type() const { return m_type; }
 
 
    //
    // Methods
    //

    [[nodiscard]] BaudRate baudRate() const {return m_baudRate;}

    [[nodiscard]] QBluetoothDeviceInfo bluetoothDeviceInfo() const { return m_bluetoothDeviceInfo; }

    [[nodiscard]] FlowControl flowControl() const {return m_flowControl;}

    [[nodiscard]] quint16 port() const { return m_port; }

    [[nodiscard]] bool sameConnectionAs(const Traffic::ConnectionInfo& other) const;

    [[nodiscard]] StopBits stopBits() const {return m_stopBits;}

    [[nodiscard]] bool operator== (const Traffic::ConnectionInfo& other) const = default;

    bool operator< (const Traffic::ConnectionInfo& other) const;
 
private:
    //
    // Properties
    //
    bool                          m_canConnect { false };
    bool                          m_canonical { false };
    QString m_description;
    QString m_icon{u"/icons/material/ic_delete.svg"_s};
    QString                       m_name { QObject::tr("Invalid Device", "Traffic::ConnectionInfo") };
    Traffic::ConnectionInfo::Type m_type { Traffic::ConnectionInfo::Invalid };
 
    //
    // Private members, depending on m_type
    //
    QBluetoothDeviceInfo m_bluetoothDeviceInfo;
    quint16 m_port{0};
    QString                       m_host;
 
    BaudRate m_baudRate {BaudRate::Baud9600};
    StopBits m_stopBits {StopBits::OneStop};
    FlowControl m_flowControl {FlowControl::NoFlowControl};
 
};

QDataStream& operator<<(QDataStream& stream, const Traffic::ConnectionInfo &connectionInfo);

QDataStream& operator>>(QDataStream& stream, Traffic::ConnectionInfo& connectionInfo);
 
} // namespace Traffic
 
// Make enums available in QML
namespace ConnectionInfoQML {
Q_NAMESPACE
QML_FOREIGN_NAMESPACE(Traffic::ConnectionInfo)
QML_NAMED_ELEMENT(ConnectionInfo)
} // Namespace ConnectionInfoQML
 
// Declare meta types
//Q_DECLARE_METATYPE(Navigation::Aircraft)