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

#include "blackmisc/simulation/simulatedaircraft.h"
#include "blackmisc/simulation/interpolatormulti.h"
#include "simconnectdatadefinition.h"
#include <QSharedPointer>
#include <QStringList>

namespace BlackSimPlugin
{
    namespace FsxCommon
    {
        //! Class representing a SimConnect object
        class CSimConnectObject
        {
        public:
            //! Type
            enum SimObjectType
            {
                Aircraft,
                Probe
            };

            //! Constructor
            CSimConnectObject();

            //! Constructor
            CSimConnectObject(SimObjectType type) : m_type(type) {}

            //! Constructor providing initial situation/parts
            CSimConnectObject(const BlackMisc::Simulation::CSimulatedAircraft &aircraft,
                              DWORD requestId,
                              BlackMisc::Simulation::ISimulationEnvironmentProvider *simEnvProvider, BlackMisc::Simulation::IInterpolationSetupProvider *setupProvider,
                              BlackMisc::Simulation::IRemoteAircraftProvider *remoteAircraftProvider,
                              BlackMisc::Simulation::CInterpolationLogger *logger);

            //! Destructor
            ~CSimConnectObject() {}

            //! Get callsign
            const BlackMisc::Aviation::CCallsign &getCallsign() const { return m_aircraft.getCallsign(); }

            //! Simulated aircraft (as added)
            const BlackMisc::Simulation::CSimulatedAircraft &getAircraft() const { return m_aircraft; }

            //! Simulated aircraft model string
            const QString &getAircraftModelString() const { return m_aircraft.getModelString(); }

            //! Object type
            SimObjectType getType() const { return m_type; }

            //! Set the type
            void setType(SimObjectType type) { m_type = type; }

            //! Set the aircraft
            void setAircraft(const BlackMisc::Simulation::CSimulatedAircraft &aircraft) { m_aircraft = aircraft; }

            //! Get current lights (requested from simulator)
            const BlackMisc::Aviation::CAircraftLights &getCurrentLightsInSimulator() const { return m_currentLightsInSim; }

            //! Received lights in simulator
            bool hasCurrentLightsInSimulator() const { return !m_currentLightsInSim.isNull(); }

            //! Set current lights when received from simulator
            void setCurrentLightsInSimulator(const BlackMisc::Aviation::CAircraftLights &lights) { m_currentLightsInSim = lights; }

            //! Pretend to have received lights from simulator
            void fakeCurrentLightsInSimulator() { m_currentLightsInSim.setNull(false); }

            //! Parts as sent to simulator
            //! \deprecated KB T273 use BlackCore::CSimulatorCommon isEqual / remember functions
            const DataDefinitionRemoteAircraftPartsWithoutLights &getPartsAsSent() const { return m_partsAsSent; }

            //! Parts as sent to simulator
            //! \deprecated KB T273 use BlackCore::CSimulatorCommon isEqual / remember functions
            void setPartsAsSent(const DataDefinitionRemoteAircraftPartsWithoutLights &parts) { m_partsAsSent = parts; }

            //! Invalidate parts as sent
            //! \deprecated KB T273 use BlackCore::CSimulatorCommon isEqual / remember functions
            void invalidatePartsAsSent();

            //! Parts as sent to simulator
            //! \deprecated KB T273 use BlackCore::CSimulatorCommon isEqual / remember functions
            const SIMCONNECT_DATA_INITPOSITION &getPositionAsSent() const { return m_positionAsSent; }

            //! Position as sent
            //! \deprecated KB T273 use BlackCore::CSimulatorCommon isEqual / remember functions
            void setPositionAsSent(const SIMCONNECT_DATA_INITPOSITION &position) { m_positionAsSent = position; }

            //! Same as sent
            //! \deprecated KB T273 use BlackCore::CSimulatorCommon isEqual / remember functions
            bool isSameAsSent(const SIMCONNECT_DATA_INITPOSITION &position) const;

            //! Invalidate position as sent
            //! \deprecated KB T273 use BlackCore::CSimulatorCommon isEqual / remember functions
            void invalidatePositionAsSent();

            //! Lights as sent to simulator
            const BlackMisc::Aviation::CAircraftLights &getLightsAsSent() const { return m_lightsAsSent; }

            //! Lights as sent to simulator
            void setLightsAsSent(const BlackMisc::Aviation::CAircraftLights &lights) { m_lightsAsSent = lights; }

            //! How often do we request data from simulator for this remote aircraft
            SIMCONNECT_PERIOD getSimDataPeriod() const { return m_requestSimDataPeriod; }

            //! How often do we request data from simulator for this remote aircraft
            void setSimDataPeriod(SIMCONNECT_PERIOD period) { m_requestSimDataPeriod = period; }

            //! Set Simconnect request id
            void setRequestId(DWORD id) { m_requestId = id; m_validRequestId = true; }

            //! Get Simconnect request id
            DWORD getRequestId() const { return m_requestId; }

            //! Set Simconnect object id
            void setObjectId(DWORD id);

            //! Get Simconnect object id
            DWORD getObjectId() const { return m_objectId; }

            //! Get Simconnect object id
            QString getObjectIdAsString() const { return QString::number(this->getObjectId()); }

            //! Valid request id?
            bool hasValidRequestId() const { return m_validRequestId; }

            //! Valid object id?
            bool hasValidObjectId() const { return m_validObjectId; }

            //! Object is requested in simulator, not yet confirmed added
            bool isPendingAdded() const;

            //! Adding is confirmed
            bool isConfirmedAdded() const;

            //! Marked as confirmed, means the simulator has "confirmed" the objectId as added and not instantly removed the object
            void setConfirmedAdded(bool confirm);

            //! Removing is pending
            bool isPendingRemoved() const { return m_pendingRemoved; }

            //! Marked as pending for removal
            void setPendingRemoved(bool pending);

            //! Pending added or removed?
            bool isPending() const { return this->isPendingAdded() || this->isPendingRemoved(); }

            //! Reset the state (like it was a new onject) without affecting interpolator and aircraft
            void resetState();

            //! VTOL?
            bool isVtol() const { return m_aircraft.isVtol(); }

            //! Engine count
            int getEngineCount() const { return m_aircraft.getEnginesCount(); }

            //! Was the object really added to simulator
            bool hasValidRequestAndObjectId() const;

            //! \copydoc BlackMisc::Simulation::CInterpolator::getInterpolatorInfo
            QString getInterpolatorInfo(BlackMisc::Simulation::CInterpolationAndRenderingSetupBase::InterpolatorMode mode) const;

            //! \copydoc BlackMisc::Simulation::CInterpolator::attachLogger
            void attachInterpolatorLogger(BlackMisc::Simulation::CInterpolationLogger *logger) const;

            //! \copydoc BlackMisc::Simulation::CInterpolator::getInterpolation
            BlackMisc::Simulation::CInterpolationResult getInterpolation(qint64 currentTimeSinceEpoc, const BlackMisc::Simulation::CInterpolationAndRenderingSetupPerCallsign &setup, int aircraftNumber) const;

            //! \copydoc BlackMisc::Simulation::CInterpolator::getLastInterpolatedSituation
            const BlackMisc::Aviation::CAircraftSituation &getLastInterpolatedSituation(BlackMisc::Simulation::CInterpolationAndRenderingSetupBase::InterpolatorMode mode) const;

            //! Interpolator
            BlackMisc::Simulation::CInterpolatorMulti *getInterpolator() const { return m_interpolator.data(); }

        private:
            BlackMisc::Simulation::CSimulatedAircraft m_aircraft; //!< corresponding aircraft
            SimObjectType m_type = Aircraft;
            DWORD m_requestId = 0;
            DWORD m_objectId  = 0;
            bool m_validRequestId = false;
            bool m_validObjectId  = false;
            bool m_confirmedAdded = false;
            bool m_pendingRemoved = false;
            int m_lightsRequestedAt = -1;
            DataDefinitionRemoteAircraftPartsWithoutLights m_partsAsSent {};          //!< parts as sent
            SIMCONNECT_DATA_INITPOSITION m_positionAsSent {};                         //!< position as sent
            BlackMisc::Aviation::CAircraftLights m_currentLightsInSim { nullptr };    //!< current lights to know state for toggling
            BlackMisc::Aviation::CAircraftLights m_lightsAsSent { nullptr };          //!< lights as sent to simulator
            SIMCONNECT_PERIOD m_requestSimDataPeriod = SIMCONNECT_PERIOD_NEVER;       //!< how often do we query ground elevation
            QSharedPointer<BlackMisc::Simulation::CInterpolatorMulti> m_interpolator; //!< shared pointer because CSimConnectObject can be copied
        };

        //! Simulator objects (aka AI aircraft)
        class CSimConnectObjects : public QHash<BlackMisc::Aviation::CCallsign, CSimConnectObject>
        {
        public:
            //! Set ID of a SimConnect object, so far we only have an request id in the object
            bool setSimConnectObjectIdForRequestId(DWORD requestId, DWORD objectId, bool resetSentParts = false);

            //! Find which callsign belongs to the object id
            BlackMisc::Aviation::CCallsign getCallsignForObjectId(DWORD objectId) const;

            //! Get object per object id
            CSimConnectObject getSimObjectForObjectId(DWORD objectId) const;

            //! Mark as added if existing
            CSimConnectObject markObjectAsAdded(DWORD objectId);

            //! Get object per request id
            CSimConnectObject getSimObjectForRequestId(DWORD requestId) const;

            //! Is the object id one of our AI objects?
            bool isKnownSimObjectId(DWORD objectId) const;

            //! Remove by id
            bool removeByObjectId(DWORD objectId);

            //! Pending add condition
            bool containsPendingAdded() const;

            //! Pending removed condition
            bool containsPendingRemoved() const;

            //! Number of pending added
            int countPendingAdded() const;

            //! Number of pending removed
            int countPendingRemoved() const;

            //! Objects not pending
            int countConfirmedAdded();

            //! Get all callsigns
            BlackMisc::Aviation::CCallsignSet getAllCallsigns() const;

            //! Get all callsign strings
            QStringList getAllCallsignStrings(bool sorted = false) const;

            //! Get all callsign strings as string
            QString getAllCallsignStringsAsString(bool sorted = false, const QString &separator = ", ") const;

            //! Callsigns of pending added callsigns
            BlackMisc::Aviation::CCallsignSet getPendingAddedCallsigns() const;

            //! Callsigns of pending removed callsigns
            BlackMisc::Aviation::CCallsignSet getPendingRemovedCallsigns() const;

            //! Get by type
            QList<CSimConnectObject> getByType(CSimConnectObject::SimObjectType type) const;

            //! Contains object of type
            bool containsType(CSimConnectObject::SimObjectType type) const;
        };
    } // namespace
} // namespace

#endif // guard