pilotclient/src/blackmisc/aviation/callsign.h

/* Copyright (C) 2013
 * swift project Community / Contributors
 *
 * This file is part of Swift Project. It is subject to the license terms in the LICENSE file found in the top-level
 * directory of this distribution. No part of swift project, including this file, may be copied, modified, propagated,
 * or distributed except according to the terms contained in the LICENSE file.
 */

//! \file

#ifndef BLACKMISC_AVIATION_CALLSIGN_H
#define BLACKMISC_AVIATION_CALLSIGN_H

#include "blackmisc/blackmiscexport.h"
#include "blackmisc/icon.h"
#include "blackmisc/metaclass.h"
#include "blackmisc/propertyindex.h"
#include "blackmisc/valueobject.h"
#include "blackmisc/variant.h"
#include <QMetaType>
#include <QString>
#include <tuple>

class QStringList;

namespace BlackMisc
{
    namespace Aviation
    {
        //! Value object encapsulating information of a callsign.
        class BLACKMISC_EXPORT CCallsign : public CValueObject<CCallsign>
        {
        public:
            //! Indexes
            enum ColumnIndex
            {
                IndexCallsignString = CPropertyIndex::GlobalIndexCCallsign,
                IndexCallsignStringAsSet,
                IndexTelephonyDesignator,
                IndexSuffix,
                IndexSuffixSortOrder
            };

            //! Representing what
            enum TypeHint
            {
                NoHint,
                Aircraft,
                Atc
            };

            //! Default constructor.
            CCallsign() {}

            //! Constructor
            CCallsign(const QString &callsign, TypeHint hint = NoHint);

            //! Constructor
            CCallsign(const QString &callsign, const QString &telephonyDesignator, TypeHint hint = NoHint);

            //! Constructor, needed to disambiguate implicit conversion from string literal.
            CCallsign(const char *callsign, TypeHint hint = NoHint);

            //! Is empty?
            bool isEmpty() const { return m_callsignAsSet.isEmpty(); }

            //! ATC callsign
            //! \sa atcCallsignSuffixes()
            bool isAtcCallsign() const;

            //! ATC alike callsign
            //! \sa atcAlikeCallsignSuffixes()
            bool isAtcAlikeCallsign() const;

            //! Observer callsign?
            bool isObserverCallsign() const;

            //! Supervisor?
            bool isSupervisorCallsign() const;

            //! Pseudo callsing for broadcast messages
            //! \remark hack, workaround for VATSIM using "*" as callsign for text messages
            bool isBroadcastCallsign() const;

            //! Set a human readable name as "broadcast" callsign
            //! \remark hack, workaround for VATSIM using "*" as callsign for text messages
            void markAsBroadcastCallsign();

            //! Returns true if this is a co-pilot callsign of pilot. The logic is that the callsign is the same as the pilot one
            //! but with a single character as suffix.
            //! e.g Pilot logged in as DLH123, observer logged in as DLH123A
            bool isMaybeCopilotCallsign(const CCallsign &pilotCallsign) const;

            //! Get callsign (normalized)
            const QString &asString() const { return m_callsign; }

            //! Get callsign.
            const QString &getStringAsSet() const { return m_callsignAsSet; }

            //! The callsign string used with FSD
            QString getFsdCallsignString() const;

            //! Same as set callsign?
            bool isSameAsSet() const;

            //! Get callsign telephony designator (how callsign is pronounced)
            const QString &getTelephonyDesignator() const { return m_telephonyDesignator; }

            //! Type hint
            TypeHint getTypeHint() const { return m_typeHint; }

            //! Type hint
            void setTypeHint(TypeHint hint) { m_typeHint = hint; }

            //! Get ICAO code, if this makes sense (EDDF_TWR -> EDDF)
            QString getIcaoCode() const;

            //! Makes this callsign looking like an observer callsign (DAMBZ -> DAMBZ_OBS)
            QString getAsObserverCallsignString() const;

            //! Get the callsign suffix ("TWR", "ATIS" ...) if any ("_" is removed)
            QString getSuffix() const;

            //! Airline suffix (e.g. DLH1234 -> DLH) if applicable @{
            QString getAirlinePrefix() const;
            QString getAirlinePrefix(QString &flightNumber) const;
            QString getAirlinePrefix(QString &flightNumber, QString &flightIdentification) const;
            // @}

            //! Flight number (e.g. DLH1234 -> 1234) if applicable
            QString getFlightIndentification() const;

            //! Flight number (e.g. DLH1234 -> 1234) if applicable
            QString getFlightNumber() const;

            //! Flight number as integer
            int getFlightNumberInt() const;

            //! Suffix such as "_TWR"?
            bool hasSuffix() const;

            //! Has an ATC suffix?
            bool hasAtcSuffix() const;

            //! Sort order by suffix
            int getSuffixSortOrder() const;

            //! Equals callsign string?
            bool equalsString(const QString &callsignString) const;

            //! Valid callsign?
            bool isValid() const;

            //! \copydoc BlackMisc::Mixin::Icon::toIcon()
            CIcon toIcon() const { return convertToIcon(*this); }

            //! \copydoc BlackMisc::Mixin::Index::propertyByIndex
            CVariant propertyByIndex(const CPropertyIndex &index) const;

            //! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
            void setPropertyByIndex(const CPropertyIndex &index, const CVariant &variant);

            //! \copydoc BlackMisc::Mixin::Index::comparePropertyByIndex
            int comparePropertyByIndex(const CPropertyIndex &index, const CCallsign &compareValue) const;

            //! \copydoc BlackMisc::Mixin::String::toQString()
            QString convertToQString(bool i18n = false) const;

            //! Clear this callsign
            void clear();

            //! Index for ATC suffix, if unknown int max value
            static int suffixToSortOrder(const QString &suffix);

            //! Valid callsign?
            static bool isValidAircraftCallsign(const QString &callsign);

            //! Valid callsign?
            static bool isValidAircraftCallsign(const CCallsign &callsign);

            //! Valid callsign?
            static bool isValidAtcCallsign(const QString &callsign);

            //! Valid callsign?
            static bool isValidAtcCallsign(const CCallsign &callsign);

            //! Unify the callsign by removing illegal characters
            static QString unifyCallsign(const QString &callsign, TypeHint hint = NoHint);

            //! List of real ATC suffixes (e.g. TWR);
            static const QStringList &atcCallsignSuffixes();

            //! List of real ("TWR") and treated like ATC suffixes (e.g. OBS);
            static const QStringList &atcAlikeCallsignSuffixes();

            //! Does this look like an ATC callsign
            static bool looksLikeAtcCallsign(const QString &callsign);

            //! Suffix to icon
            static const CIcon &atcSuffixToIcon(const QString &suffix);

            //! Representing icon
            static const CIcon &convertToIcon(const CCallsign &callsign);

            //! Register metadata
            static void registerMetadata();

        private:
            QString  m_callsignAsSet;
            QString  m_callsign;
            QString  m_telephonyDesignator;
            TypeHint m_typeHint = NoHint;

            BLACK_METACLASS(
                CCallsign,
                BLACK_METAMEMBER(callsign, 0, CaseInsensitiveComparison),
                BLACK_METAMEMBER(callsignAsSet, 0, DisabledForComparison | DisabledForHashing),
                BLACK_METAMEMBER(telephonyDesignator, 0, DisabledForComparison | DisabledForHashing),
                BLACK_METAMEMBER(typeHint, 0, DisabledForComparison | DisabledForHashing)
            );
        };
    } // namespace
} // namespace

Q_DECLARE_METATYPE(BlackMisc::Aviation::CCallsign)
Q_DECLARE_METATYPE(BlackMisc::Aviation::CCallsign::TypeHint)

#endif // guard