pilotclient/src/blackmisc/propertyindex.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 and at http://www.swift-project.org/license.html. 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_PROPERTYINDEX_H
#define BLACKMISC_PROPERTYINDEX_H

#include "blackmiscexport.h"
#include "dictionary.h"
#include "stringutils.h"
#include "variant.h"
#include "dbus.h"
#include "json.h"
#include "compare.h"
#include <initializer_list>

namespace BlackMisc
{
    /*!
     * Property index. The index can be nested, that's why it is a sequence
     * (e.g. PropertyIndexPilot, PropertyIndexRealname).
     */
    class BLACKMISC_EXPORT CPropertyIndex :
        public Mixin::MetaType<CPropertyIndex>,
        public Mixin::HashByMetaClass<CPropertyIndex>,
        public Mixin::DBusByMetaClass<CPropertyIndex>,
        public Mixin::JsonByMetaClass<CPropertyIndex>,
        public Mixin::EqualsByMetaClass<CPropertyIndex>,
        public Mixin::LessThanByMetaClass<CPropertyIndex>,
        public Mixin::CompareByMetaClass<CPropertyIndex>,
        public Mixin::String<CPropertyIndex>
    {
        // In the first trial I have used CSequence<int> as base class
        // This has created too much circular dependencies of the headers
        // CIndexVariantMap is used in CValueObject, CPropertyIndex in CIndexVariantMap

    public:
        //! Global index, make sure the indexes are unqiue (for using them in class hierarchy)
        enum GlobalIndex
        {
            GlobalIndexCValueObject           =   10, // avoid circular dependencies, GlobalIndexCValueObject needs to be set manually in CValueObject
            GlobalIndexCPhysicalQuantity      =   100,
            GlobalIndexCStatusMessage         =   200,
            GlobalIndexCNameVariantPair       =   300,
            GlobalIndexITimestampBased        =   400,
            GlobalIndexCIdentifier            =   500,
            GlobalIndexCRgbColor              =   600,
            GlobalIndexCCountry               =   700,
            GlobalIndexCCallsign              =  1000,
            GlobalIndexCAircraftSituation     =  1100,
            GlobalIndexCAtcStation            =  1200,
            GlobalIndexCAirport               =  1300,
            GlobalIndexCAircraftParts         =  1400,
            GlobalIndexCAircraftLights        =  1500,
            GlobalIndexCLivery                =  1600,
            GlobalIndexCModulator             =  2000,
            GlobalIndexCTransponder           =  2100,
            GlobalIndexCAircraftIcaoData      =  2500,
            GlobalIndexCAircraftIcaoCode      =  2600,
            GlobalIndexCAirlineIcaoCode       =  2700,
            GlobalIndexCAirportIcaoCode       =  2800,
            GlobalIndexCMetar                 =  4000,
            GlobalIndexCCloudLayer            =  4100,
            GlobalIndexCPresentWeather        =  4200,
            GlobalIndexCWindLayer             =  4300,
            GlobalIndexCTemperatureLayer      =  4400,
            GlobalIndexCGridPoint             =  4500,
            GlobalIndexCVisibilityLayer       =  4600,
            GlobalIndexICoordinateGeodetic    =  5000,
            GlobalIndexCCoordinateGeodetic    =  5100,
            GlobalIndexCClient                =  6000,
            GlobalIndexCUser                  =  6100,
            GlobalIndexCAuthenticatedUser     =  6200,
            GlobalIndexCRole                  =  6300,
            GlobalIndexCServer                =  6400,
            GlobalIndexCUrl                   =  6500,
            GlobalIndexCAircraftModel         =  6600,
            GlobalIndexCSimulatedAircraft     =  6700,
            GlobalIndexCTextMessage           =  6800,
            GlobalIndexCSimulatorSetup        =  6900,
            GlobalIndexCAircraftCfgEntries    =  7000,
            GlobalIndexCDistributor           =  7100,
            GlobalIndexCVPilotModelRule       =  8000,
            GlobalIndexCVoiceRoom             =  9000,
            GlobalIndexCSettingKeyboardHotkey = 10000,
            GlobalIndexIDatastoreInteger      = 11000,
            GlobalIndexIDatastoreString       = 11100,
            GlobalIndexCGlobalSetup           = 12000,
            GlobalIndexCUpdateInfo            = 12100,
            GlobalIndexCVatsimSetup           = 12200,
            GlobalIndexCDbOwnModelsComponent  = 14000,
            GlobalIndexAbuseMode              = 20000  // property index abused as map key or otherwise, to be removed if no longer needed
        };

        //! Default constructor.
        CPropertyIndex() = default;

        //! Non nested index
        CPropertyIndex(int singleProperty);

        //! Initializer list constructor
        CPropertyIndex(std::initializer_list<int> il);

        //! Construct from a base class object.
        CPropertyIndex(const QList<int> &indexes);

        //! From string
        CPropertyIndex(const QString &indexes);

        //! Copy with first element removed
        CPropertyIndex copyFrontRemoved() const;

        //! Is nested index?
        bool isNested() const;

        //! Myself index, used with nesting
        bool isMyself() const;

        //! Empty?
        bool isEmpty() const;

        //! Index list
        QList<int> indexList() const;

        //! Shif existing indexes to right and insert given index at front
        void prepend(int newLeftIndex);

        //! Contains index?
        bool contains(int index) const;

        //! Compare with index given by enum
        template<class EnumType> bool contains(EnumType ev) const
        {
            static_assert(std::is_enum<EnumType>::value, "Argument must be an enum");
            return contains(static_cast<int>(ev));
        }

        //! Front to integer
        int frontToInt() const;

        //! First element casted to given type, usually the PropertIndex enum
        template<class CastType> CastType frontCasted() const
        {
            static_assert(std::is_enum<CastType>::value || std::is_integral<CastType>::value, "CastType must be an enum or integer");
            return static_cast<CastType>(frontToInt());
        }

        //! Compare with index given by enum
        template<class EnumType> bool equalsPropertyIndexEnum(EnumType ev)
        {
            static_assert(std::is_enum<EnumType>::value, "Argument must be an enum");
            QList<int> l = indexList();
            if (l.size() != 1) { return false; }
            return static_cast<int>(ev) == l.first();
        }

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

    protected:
        //! Parse indexes from string
        void parseFromString(const QString &indexes);

    private:
        QString m_indexString; //! I use a little trick here, the string is used with the tupel system, as it provides all operators, hash ..

        //! Convert list to string
        void setIndexStringByList(const QList<int> &list);

        BLACK_METACLASS(
            CPropertyIndex,
            BLACK_METAMEMBER(indexString)
        );
    };
} //namespace

Q_DECLARE_METATYPE(BlackMisc::CPropertyIndex)

#endif //guard