ConnectionInfo.h

/***************************************************************************
 *   Copyright (C) 2024 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 <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           
    };
    Q_ENUM(Type)
 
    
    ConnectionInfo() = default;

    explicit ConnectionInfo(const QBluetoothDeviceInfo& info, bool canonical=false);
 
#if __has_include (<QSerialPortInfo>)
    explicit ConnectionInfo(const QSerialPortInfo& info, bool canonical=false);
#endif

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

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

    Q_PROPERTY(bool canConnect READ canConnect CONSTANT)
 
    
    Q_PROPERTY(bool canonical READ canonical CONSTANT)

    Q_PROPERTY(QString description READ description CONSTANT)

    Q_PROPERTY(QString icon READ icon CONSTANT)

    Q_PROPERTY(QString name READ name CONSTANT)

    Q_PROPERTY(Traffic::ConnectionInfo::Type type READ type CONSTANT)
 
 
 
    //
    // Getter Methods
    //

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

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

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

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

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

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

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

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

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

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

    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;
};

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

QDataStream& operator>>(QDataStream& stream, Traffic::ConnectionInfo& connectionInfo);
 
} // namespace Traffic