// Copyright (C) 2016 The Qt Company Ltd.

// Copyright (C) 2016 Intel Corporation.

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

// Qt-Security score:significant reason:default

#ifndef QHOSTADDRESS_H

#define QHOSTADDRESS_H

#include <QtNetwork/qtnetworkglobal.h>

#include <QtCore/qstring.h>

#include <QtCore/qshareddata.h>

#if QT_VERSION < QT_VERSION_CHECK(7, 0, 0)

#include <QtNetwork/qabstractsocket.h>

#endif

#include <utility>

struct sockaddr;

QT_BEGIN_NAMESPACE

class QHostAddressPrivate;

QT_DECLARE_QESDP_SPECIALIZATION_DTOR(QHostAddressPrivate)

class QT6_ONLY(Q_NETWORK_EXPORT) QIPv6Address

{

public:

    inline quint8 &operator [](int index) { return c[index]; }

    inline quint8 operator [](int index) const { return c[index]; }

    quint8 c[16];

};

typedef QIPv6Address Q_IPV6ADDR;

class QHostAddress;

// qHash is a friend, but we can't use default arguments for friends (§8.3.6.4)

Q_NETWORK_EXPORT size_t qHash(const QHostAddress &key, size_t seed = 0) noexcept;

class Q_NETWORK_EXPORT QHostAddress

{

    Q_GADGET

public:

    enum SpecialAddress {

        Null,

        Broadcast,

        LocalHost,

        LocalHostIPv6,

        Any,

        AnyIPv6,

        AnyIPv4

    };

    enum ConversionModeFlag {

        ConvertV4MappedToIPv4 = 1,

        ConvertV4CompatToIPv4 = 2,

        ConvertUnspecifiedAddress = 4,

        ConvertLocalHost = 8,

        TolerantConversion = 0xff,

        StrictConversion = 0

    };

    Q_DECLARE_FLAGS(ConversionMode, ConversionModeFlag)

#if QT_VERSION < QT_VERSION_CHECK(7, 0, 0)

    using NetworkLayerProtocol = QAbstractSocket::NetworkLayerProtocol;

    static constexpr auto IPv4Protocol = QAbstractSocket::IPv4Protocol;

    static constexpr auto IPv6Protocol = QAbstractSocket::IPv6Protocol;

    static constexpr auto AnyIPProtocol = QAbstractSocket::AnyIPProtocol;

    static constexpr auto UnknownNetworkLayerProtocol = QAbstractSocket::UnknownNetworkLayerProtocol;

#else

    enum NetworkLayerProtocol {

        IPv4Protocol,

        IPv6Protocol,

        AnyIPProtocol,

        UnknownNetworkLayerProtocol = -1

    };

    Q_ENUM(NetworkLayerProtocol)

#endif

    QHostAddress();

    explicit QHostAddress(quint32 ip4Addr);

    explicit QHostAddress(const quint8 *ip6Addr);

    explicit QHostAddress(const Q_IPV6ADDR &ip6Addr);

    explicit QHostAddress(const sockaddr *address);

    explicit QHostAddress(const QString &address);

    QHostAddress(const QHostAddress &copy);

    QHostAddress(QHostAddress &&other) noexcept = default;

    QHostAddress(SpecialAddress address);

    ~QHostAddress();

    QHostAddress &operator=(QHostAddress &&other) noexcept

    { swap(other); return *this; }

    QHostAddress &operator=(const QHostAddress &other);

    QHostAddress &operator=(SpecialAddress address);

    void swap(QHostAddress &other) noexcept { d.swap(other.d); }

    void setAddress(quint32 ip4Addr);

    void setAddress(const quint8 *ip6Addr);

    void setAddress(const Q_IPV6ADDR &ip6Addr);

    void setAddress(const sockaddr *address);

    bool setAddress(const QString &address);

    void setAddress(SpecialAddress address);

    NetworkLayerProtocol protocol() const;

    quint32 toIPv4Address(bool *ok = nullptr) const;

    Q_IPV6ADDR toIPv6Address() const;

    QString toString() const;

    QString scopeId() const;

    void setScopeId(const QString &id);

    bool isEqual(const QHostAddress &address, ConversionMode mode = TolerantConversion) const;

    bool operator ==(const QHostAddress &address) const;

    bool operator ==(SpecialAddress address) const;

    inline bool operator !=(const QHostAddress &address) const

    { return !operator==(address); }

    inline bool operator !=(SpecialAddress address) const

    { return !operator==(address); }

    bool isNull() const;

    void clear();

    bool isInSubnet(const QHostAddress &subnet, int netmask) const;

    bool isInSubnet(const std::pair<QHostAddress, int> &subnet) const;

    bool isLoopback() const;

    bool isGlobal() const;

    bool isLinkLocal() const;

    bool isSiteLocal() const;

    bool isUniqueLocalUnicast() const;

    bool isMulticast() const;

    bool isBroadcast() const;

    bool isPrivateUse() const;

    static std::pair<QHostAddress, int> parseSubnet(const QString &subnet);

    friend Q_NETWORK_EXPORT size_t qHash(const QHostAddress &key, size_t seed) noexcept;

    friend bool operator ==(QHostAddress::SpecialAddress lhs, const QHostAddress &rhs)

    { return rhs == lhs; }

    friend bool operator!=(QHostAddress::SpecialAddress lhs, const QHostAddress &rhs)

    { return rhs != lhs; }

protected:

    friend class QHostAddressPrivate;

    QExplicitlySharedDataPointer<QHostAddressPrivate> d;

};

Q_DECLARE_OPERATORS_FOR_FLAGS(QHostAddress::ConversionMode)

Unexecuted instantiation: operator|(QHostAddress::ConversionModeFlag, QFlags<QHostAddress::ConversionModeFlag>)

Unexecuted instantiation: operator&(QHostAddress::ConversionModeFlag, QHostAddress::ConversionModeFlag)

Unexecuted instantiation: operator&(QHostAddress::ConversionModeFlag, QFlags<QHostAddress::ConversionModeFlag>)

Unexecuted instantiation: operator^(QHostAddress::ConversionModeFlag, QHostAddress::ConversionModeFlag)

Unexecuted instantiation: operator^(QHostAddress::ConversionModeFlag, QFlags<QHostAddress::ConversionModeFlag>)

Unexecuted instantiation: operator|(QHostAddress::ConversionModeFlag, int)

Unexecuted instantiation: operator|(QHostAddress::ConversionModeFlag, QHostAddress::ConversionModeFlag)

Q_DECLARE_SHARED(QHostAddress)

#ifndef QT_NO_DEBUG_STREAM

Q_NETWORK_EXPORT QDebug operator<<(QDebug, const QHostAddress &);

#endif

#ifndef QT_NO_DATASTREAM

Q_NETWORK_EXPORT QDataStream &operator<<(QDataStream &, const QHostAddress &);

Q_NETWORK_EXPORT QDataStream &operator>>(QDataStream &, QHostAddress &);

#endif

QT_END_NAMESPACE

#endif // QHOSTADDRESS_H