/* 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 BLACKCORE_CONTEXT_CONTEXTOWNAIRCRAFT_IMPL_H
#define BLACKCORE_CONTEXT_CONTEXTOWNAIRCRAFT_IMPL_H

#include "blackcore/blackcoreexport.h"
#include "blackcore/context/contextownaircraft.h"
#include "blackcore/corefacadeconfig.h"
#include "blackcore/vatsim/vatsimsettings.h"
#include "blackmisc/aviation/aircraftparts.h"
#include "blackmisc/aviation/airlineicaocode.h"
#include "blackmisc/aviation/atcstation.h"
#include "blackmisc/aviation/comsystem.h"
#include "blackmisc/aviation/selcal.h"
#include "blackmisc/geo/coordinategeodetic.h"
#include "blackmisc/network/user.h"
#include "blackmisc/pq/frequency.h"
#include "blackmisc/pq/length.h"
#include "blackmisc/simulation/aircraftmodel.h"
#include "blackmisc/simulation/ownaircraftprovider.h"
#include "blackmisc/simulation/simulatedaircraft.h"
#include "blackmisc/settingscache.h"
#include "blackmisc/identifiable.h"
#include "blackmisc/identifier.h"
#include "blackmisc/simplecommandparser.h"

#include <QObject>
#include <QReadWriteLock>
#include <QString>

namespace BlackMisc
{
    class CDBusServer;
    namespace Aviation
    {
        class CAircraftIcaoCode;
        class CAircraftSituation;
        class CAltitude;
        class CCallsign;
        class CTransponder;
    }
}
namespace BlackCore
{
    class CCoreFacade;
    namespace Context
    {
        //! Own aircraft context implementation.
        //! Central instance of data for \sa IOwnAircraftProvider .
        class BLACKCORE_EXPORT CContextOwnAircraft :
            public IContextOwnAircraft,
            public BlackMisc::Simulation::IOwnAircraftProvider,
            public BlackMisc::CIdentifiable
        {
            Q_OBJECT
            Q_CLASSINFO("D-Bus Interface", BLACKCORE_CONTEXTOWNAIRCRAFT_INTERFACENAME)
            Q_INTERFACES(BlackMisc::Simulation::IOwnAircraftProvider)
            Q_INTERFACES(BlackMisc::IProvider)
            friend class BlackCore::CCoreFacade;
            friend class IContextOwnAircraft;

        public:
            //! Destructor
            virtual ~CContextOwnAircraft();

            // IOwnAircraftProvider overrides
            //! \copydoc BlackMisc::Simulation::IOwnAircraftProvider::getOwnAircraftParts
            //! \ingroup ownaircraftprovider
            virtual BlackMisc::Geo::CCoordinateGeodetic getOwnAircraftPosition() const override;

            //! Own aircraft's situation
            //! \copydoc BlackMisc::Simulation::IOwnAircraftProvider::getOwnAircraftParts
            //! \ingroup ownaircraftprovider
            virtual BlackMisc::Aviation::CAircraftSituation getOwnAircraftSituation() const override;

            //! \copydoc BlackMisc::Simulation::IOwnAircraftProvider::getOwnAircraftParts
            //! \ingroup ownaircraftprovider
            virtual BlackMisc::Aviation::CAircraftParts getOwnAircraftParts() const override;

            //! \copydoc BlackMisc::Simulation::IOwnAircraftProvider::getOwnAircraftModel
            //! \ingroup ownaircraftprovider
            virtual BlackMisc::Simulation::CAircraftModel getOwnAircraftModel() const override;

            //! \copydoc BlackMisc::Simulation::IOwnAircraftProvider::getDistanceToOwnAircraft
            //! \ingroup ownaircraftprovider
            virtual BlackMisc::PhysicalQuantities::CLength getDistanceToOwnAircraft(const BlackMisc::Geo::ICoordinateGeodetic &position) const override;

            //! \copydoc BlackMisc::Simulation::IOwnAircraftProvider::updateOwnModel
            //! \ingroup ownaircraftprovider
            //! \remark perform reverse lookup if possible
            virtual bool updateOwnModel(const BlackMisc::Simulation::CAircraftModel &model) override;

            //! \copydoc BlackMisc::Simulation::IOwnAircraftProvider::updateOwnSituation
            //! \ingroup ownaircraftprovider
            virtual bool updateOwnSituation(const BlackMisc::Aviation::CAircraftSituation &situation) override;

            //! \copydoc BlackMisc::Simulation::IOwnAircraftProvider::updateOwnParts
            //! \ingroup ownaircraftprovider
            virtual bool updateOwnParts(const BlackMisc::Aviation::CAircraftParts &parts) override;

            //! \copydoc BlackMisc::IProvider::asQObject
            virtual QObject *asQObject() override { return this; }

        public slots:
            //! \copydoc IContextOwnAircraft::getOwnAircraft()
            //! \ingroup ownaircraftprovider
            virtual BlackMisc::Simulation::CSimulatedAircraft getOwnAircraft() const override;

            //! \copydoc IContextOwnAircraft::updateOwnCallsign
            //! \ingroup ownaircraftprovider
            virtual bool updateOwnCallsign(const BlackMisc::Aviation::CCallsign &callsign) override;

            //! \copydoc IContextOwnAircraft::updateOwnIcaoCodes
            //! \ingroup ownaircraftprovider
            virtual bool updateOwnIcaoCodes(const BlackMisc::Aviation::CAircraftIcaoCode &aircraftIcaoCode, const BlackMisc::Aviation::CAirlineIcaoCode &airlineIcaoCode) override;

            //! \copydoc IContextOwnAircraft::updateOwnPosition
            virtual bool updateOwnPosition(const BlackMisc::Geo::CCoordinateGeodetic &position, const BlackMisc::Aviation::CAltitude &altitude, const BlackMisc::Aviation::CAltitude &pressureAltitude) override;

            //! \copydoc IContextOwnAircraft::updateCockpit
            virtual bool updateCockpit(const BlackMisc::Aviation::CComSystem &com1, const BlackMisc::Aviation::CComSystem &com2, const BlackMisc::Aviation::CTransponder &transponder, const BlackMisc::CIdentifier &originator) override;

            //! \copydoc IContextOwnAircraft::updateSelcal
            virtual bool updateSelcal(const BlackMisc::Aviation::CSelcal &selcal, const BlackMisc::CIdentifier &originator) override;

            //! \copydoc IContextOwnAircraft::updateActiveComFrequency
            virtual bool updateActiveComFrequency(const BlackMisc::PhysicalQuantities::CFrequency &frequency, BlackMisc::Aviation::CComSystem::ComUnit comUnit, const BlackMisc::CIdentifier &originator) override;

            //! \copydoc IContextOwnAircraft::updateOwnAircraftPilot
            virtual bool updateOwnAircraftPilot(const BlackMisc::Network::CUser &pilot) override;

            //! \copydoc IContextOwnAircraft::setAudioOutputVolume
            virtual void setAudioOutputVolume(int outputVolume) override;

            //! \copydoc IContextOwnAircraft::setAudioVoiceRoomOverrideUrls
            virtual void setAudioVoiceRoomOverrideUrls(const QString &voiceRoom1Url, const QString &voiceRoom2Url) override;

            //! \copydoc IContextOwnAircraft::enableAutomaticVoiceRoomResolution
            virtual void enableAutomaticVoiceRoomResolution(bool enable) override;

            //! \addtogroup swiftdotcommands
            //! @{
            //! <pre>
            //! .x    .xpdr  code       set transponder code    BlackCore::Context::CContextOwnAircraft
            //! .x    .xpdr  mode       set transponder mode    BlackCore::Context::CContextOwnAircraft
            //! .com1 .com2  frequency  set COM1/2 frequency    BlackCore::Context::CContextOwnAircraft
            //! .selcal      code       set SELCAL code         BlackCore::Context::CContextOwnAircraft
            //! </pre>
            //! @}
            //! \copydoc IContextOwnAircraft::parseCommandLine
            virtual bool parseCommandLine(const QString &commandLine, const BlackMisc::CIdentifier &originator) override;

            //! Register help
            static void registerHelp()
            {
                if (BlackMisc::CSimpleCommandParser::registered("BlackCore::Context::CContextOwnAircraft")) { return; }
                BlackMisc::CSimpleCommandParser::registerCommand({".x", "alias: .xpdr"});
                BlackMisc::CSimpleCommandParser::registerCommand({".x code|mode", "set XPDR code or mode"});
                BlackMisc::CSimpleCommandParser::registerCommand({".selcal code", "set SELCAL code"});
                BlackMisc::CSimpleCommandParser::registerCommand({".com1", "alias .c1"});
                BlackMisc::CSimpleCommandParser::registerCommand({".com1 frequency", "set COM1 frequency"});
                BlackMisc::CSimpleCommandParser::registerCommand({".com2 frequency", "set COM2 frequency"});
            }

        protected:
            //! Constructor, with link to runtime
            CContextOwnAircraft(CCoreFacadeConfig::ContextMode, CCoreFacade *runtime);

            //! Register myself in DBus
            CContextOwnAircraft *registerWithDBus(BlackMisc::CDBusServer *server);

        private:
            BlackMisc::Simulation::CSimulatedAircraft m_ownAircraft; //!< my aircraft
            bool m_automaticVoiceRoomResolution = true;              //!< automatic voice room resolution, or disable for override
            QString m_voiceRoom1UrlOverride;                         //!< overridden voice room url
            QString m_voiceRoom2UrlOverride;                         //!< overridden voice room url
            mutable QReadWriteLock m_lockAircraft;                   //!< lock aircraft

            BlackMisc::CSetting<Vatsim::TCurrentTrafficServer> m_currentNetworkServer { this };

            //! Station has been changed, needed to tune in/out voice room
            //! \ingroup crosscontextfunction
            void xCtxChangedAtcStationOnlineConnectionStatus(const BlackMisc::Aviation::CAtcStation &atcStation, bool connected);

            //! Simulator model has been changed
            //! \ingroup crosscontextfunction
            void xCtxChangedSimulatorModel(const BlackMisc::Simulation::CAircraftModel &model);

            //! Web data loaded
            void allSwiftWebDataRead();

            //! Init my very own aircraft with some defaults, before overridden by simulator
            void initOwnAircraft();

            //! Resolve voice rooms
            void resolveVoiceRooms();

            //! Reverse lookup of the model against DB data
            static BlackMisc::Simulation::CAircraftModel reverseLookupModel(const BlackMisc::Simulation::CAircraftModel &model);
        };
    } // ns
} // ns
#endif // guard