/* Copyright (C) 2015
 * 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_SIMULATION_IAIRCRAFTMODELLOADER_H
#define BLACKMISC_SIMULATION_IAIRCRAFTMODELLOADER_H

#include "blackmisc/blackmiscexport.h"
#include "blackmisc/simulation/aircraftmodellist.h"
#include "blackmisc/simulation/simulatorinfo.h"
#include "blackmisc/simulation/data/modelcaches.h"
#include "blackmisc/pixmap.h"
#include <QObject>
#include <atomic>
#include <memory>

namespace BlackMisc
{
    namespace Simulation
    {
        /*!
         * Load the aircraft for a simulator
         */
        class BLACKMISC_EXPORT IAircraftModelLoader : public QObject
        {
            Q_OBJECT

        public:
            //! Parser mode
            enum LoadModeFlag
            {
                NotSet            = 0,
                LoadDirectly      = 1 << 0,   //!< load syncronously (blocking), normally for testing
                LoadInBackground  = 1 << 1,   //!< load in background, asnycronously
                CacheUntilNewer   = 1 << 2,   //!< use cache until newer data re available
                CacheFirst        = 1 << 3,   //!< always use cache (if it has data)
                CacheSkipped      = 1 << 4,   //!< ignore cache
                CacheOnly         = 1 << 5,   //!< force ignoring the cache
                Default           = LoadInBackground | CacheFirst //!< default mode
            };
            Q_DECLARE_FLAGS(LoadMode, LoadModeFlag)

            //! Destructor
            virtual ~IAircraftModelLoader();

            //! Start the loading process from disk
            void startLoading(LoadMode mode = Default);

            //! Change the directory
            bool changeRootDirectory(const QString &directory);

            //! Current root directory
            QString getRootDirectory() const { return this->m_rootDirectory; }

            //! Loading finished?
            virtual bool isLoadingFinished() const = 0;

            //! The loaded models
            virtual const BlackMisc::Simulation::CAircraftModelList &getAircraftModels() const = 0;

            //! Cache timestamp
            virtual QDateTime getCacheTimestamp() const = 0;

            //! Model files updated?
            virtual bool areModelFilesUpdated() const = 0;

            //! Any cached data
            virtual bool hasCachedData() const = 0;

            //! A representive pixmap for given model
            virtual BlackMisc::CPixmap iconForModel(const QString &modelName, BlackMisc::CStatusMessage &statusMessage) const = 0;

            //! Which simulators are supported by that very loader
            const BlackMisc::Simulation::CSimulatorInfo &supportedSimulators() const;

            //! Supported simulators as string
            QString supportedSimulatorsAsString() const;

            //! Is the given simulator supported?
            bool supportsSimulator(const BlackMisc::Simulation::CSimulatorInfo &info);

            //! Cancel read
            void cancelLoading();

            //! Shutdown
            void gracefulShutdown();

            //! Create a loader
            static std::unique_ptr<IAircraftModelLoader> createModelLoader(const BlackMisc::Simulation::CSimulatorInfo &simInfo);

        signals:
            //! Parsing is finished
            void loadingFinished(bool success);

        protected:
            //! Constructor
            IAircraftModelLoader(const CSimulatorInfo &info, const QString &rootDirectory, const QStringList &excludeDirs = {});

            //! Check if directory exists
            bool existsDir(const QString &directory) const;

            //! Start the loading process from disk
            virtual void startLoadingFromDisk(LoadMode mode) = 0;

            BlackMisc::Simulation::CSimulatorInfo m_simulatorInfo; //!< Corresponding simulator
            std::atomic<bool> m_cancelLoading { false };           //!< flag
            std::atomic<bool> m_loadingInProgress { false };       //!< Loading in progress
            QString m_rootDirectory;                               //!< root directory parsing aircraft.cfg files
            QStringList m_excludedDirectories;                     //!< directories not to be parsed

        protected slots:
            //! Loading finished
            void ps_loadFinished(bool success);
        };

    } // namespace
} // namespace

Q_DECLARE_METATYPE(BlackMisc::Simulation::IAircraftModelLoader::LoadMode)
Q_DECLARE_METATYPE(BlackMisc::Simulation::IAircraftModelLoader::LoadModeFlag)
Q_DECLARE_OPERATORS_FOR_FLAGS(BlackMisc::Simulation::IAircraftModelLoader::LoadMode)

#endif // guard