dbmappingcomponent.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2015 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_GUI_COMPONENTS_DBMAPPINGCOMPONENT_H
#define SWIFT_GUI_COMPONENTS_DBMAPPINGCOMPONENT_H
 
#include <QList>
#include <QObject>
#include <QScopedPointer>
#include <QString>
#include <QStringList>
 
#include "core/data/authenticateduser.h"
#include "gui/enablefordockwidgetinfoarea.h"
#include "gui/enableforviewbasedindicator.h"
#include "gui/menus/menudelegate.h"
#include "gui/overlaymessagesframe.h"
#include "gui/swiftguiexport.h"
#include "misc/aviation/airlineicaocode.h"
#include "misc/datacache.h"
#include "misc/digestsignal.h"
#include "misc/network/entityflags.h"
#include "misc/simulation/aircraftmodellist.h"
#include "misc/simulation/distributor.h"
#include "misc/simulation/fscommon/vpilotrulesreader.h"
#include "misc/simulation/simulatorinfo.h"
#include "misc/statusmessage.h"
#include "misc/statusmessagelist.h"
 
class QAction;
class QModelIndex;
class QPoint;
 
namespace swift::misc::aviation
{
    class CAircraftIcaoCode;
    class CLivery;
} // namespace swift::misc::aviation
namespace Ui
{
    class CDbMappingComponent;
}
namespace swift::gui
{
    namespace menus
    {
        class CMenuActions;
    }
    namespace views
    {
        class CAircraftModelView;
    }
 
    namespace components
    {
        class CDbAutoStashingComponent;
        class CDbAutoSimulatorStashingComponent;
        class CDbModelMappingModifyDialog;
 
        class SWIFT_GUI_EXPORT CDbMappingComponent :
            public COverlayMessagesFrame,
            public CEnableForDockWidgetInfoArea,
            public CEnableForViewBasedIndicator
        {
            Q_OBJECT
 
        public:
            enum TabIndex
            {
                NoValidTab = -1,
                TabOwnModelSet = 0,
                TabOwnModels = 1,
                TabWorkbench = 2,
                TabStash = 3,
                TabModelMatcher = 4,
                TabVPilot = 5
            };
 
            explicit CDbMappingComponent(QWidget *parent = nullptr);
 
            virtual ~CDbMappingComponent() override;
 
            void gracefulShutdown();
 
            bool withVPilot() const { return m_vPilotEnabled; }
 
            bool hasSelectedModelsToStash() const;
 
            swift::misc::simulation::CAircraftModelList getSelectedModelsToStash() const;
 
            TabIndex currentTabIndex() const;
 
            bool isStashTab() const;
 
            bool isWorkbenchTab() const;
 
            bool canAddToModelSetTab() const;
 
            views::CAircraftModelView *currentModelView() const;
 
            views::CAircraftModelView *modelView(TabIndex tab) const;
 
            swift::misc::simulation::CAircraftModel getEditorAircraftModel() const;
 
            // ---------------- stash -----------------
 
            const swift::misc::simulation::CAircraftModelList &getStashedModels() const;
 
            bool hasStashedModels() const;
 
            QStringList getStashedModelStrings() const;
 
            // ---------------- own models -----------------
 
            swift::misc::simulation::CAircraftModelList getOwnModels() const;
 
            swift::misc::simulation::CAircraftModelList
            getOwnCachedModels(const swift::misc::simulation::CSimulatorInfo &simulator) const;
 
            swift::misc::simulation::CAircraftModelList getOwnSelectedModels() const;
 
            swift::misc::simulation::CAircraftModel getOwnModelForModelString(const QString &modelString) const;
 
            swift::misc::simulation::CSimulatorInfo getOwnModelsSimulator() const;
 
            void setOwnModelsSimulator(const swift::misc::simulation::CSimulatorInfo &simulator);
 
            int getOwnModelsCount() const;
 
            QString getOwnModelsInfoString() const;
 
            QString getOwnModelsInfoStringFsFamily() const;
 
            // ---------------- own model set -----------------
 
            void setOwnModelSetSimulator(const swift::misc::simulation::CSimulatorInfo &simulator);
 
            swift::misc::simulation::CAircraftModelList getOwnModelSet() const;
 
        public slots:
            swift::misc::CStatusMessage stashModel(const swift::misc::simulation::CAircraftModel &model,
                                                   bool replace = false);
 
            swift::misc::CStatusMessageList stashModels(const swift::misc::simulation::CAircraftModelList &models);
 
            swift::misc::CStatusMessage addToOwnModelSet(const swift::misc::simulation::CAircraftModelList &models,
                                                         const swift::misc::simulation::CSimulatorInfo &simulator);
 
            swift::misc::simulation::CAircraftModel
            consolidateModel(const swift::misc::simulation::CAircraftModel &model) const;
 
            void replaceStashedModelsUnvalidated(const swift::misc::simulation::CAircraftModelList &models) const;
 
            swift::misc::CStatusMessageList validateCurrentModel(bool withNestedForms) const;
 
            void resizeForSelect();
 
            void resizeForMapping();
 
            void maxTableView();
 
            void stashSelectedModels();
 
            void modifyModelDialog();
 
        signals:
            void filterByLivery(const swift::misc::aviation::CLivery &livery);
 
            void filterByAircraftIcao(const swift::misc::aviation::CAircraftIcaoCode &icao);
 
            void filterByDistributor(const swift::misc::simulation::CDistributor &distributor);
 
            void requestUpdatedData(swift::misc::network::CEntityFlags::Entity entities);
 
            void tabIndexChanged(int index);
 
        private slots:
            void ps_addToOwnModelSet(); // still used with QShortcut
 
        private:
            void onLoadVPilotDataFinished(bool success);
 
            void loadRemovedModels();
 
            void mergeWithVPilotModels();
 
            void onVPilotCacheChanged();
 
            void loadVPilotData();
 
            void requestVPilotDataUpdate();
 
            void mergeSelectedWithVPilotModels();
 
            void onVPilotDataChanged(int count, bool withFilter);
 
            void onWorkbenchDataChanged(int count, bool withFilter);
 
            void onTabIndexChanged(int index);
 
            void onStashedModelsChangedTriggerDigest();
 
            void onStashedModelsChangedDigest();
 
            void onStashedModelsDataChangedDigest(int count, bool withFilter);
 
            void onModelsSuccessfullyPublished(const swift::misc::simulation::CAircraftModelList &models,
                                               bool directWrite);
 
            void handleStashDropRequest(const swift::misc::aviation::CAirlineIcaoCode &code) const;
 
            void onModelSetChangedDigest(int count, bool withFilter);
 
            void onOwnModelsChangedDigest(int count, bool withFilter);
 
            void onModelRowSelected(const QModelIndex &index);
 
            void onOwnModelsSimulatorChanged(const swift::misc::simulation::CSimulatorInfo simulator);
 
            void onUserChanged();
 
            void stashCurrentModel();
 
            void displayAutoStashingDialog();
 
            void displayAutoSimulatorStashingDialog();
 
            void removeDbModelsFromView();
 
            void showChangedAttributes();
 
            void toggleAutoFiltering();
 
            void applyFormLiveryData();
 
            void applyFormAircraftIcaoData();
 
            void applyFormDistributorData();
 
            void onCustomContextMenu(const QPoint &point);
 
        private:
            QScopedPointer<Ui::CDbMappingComponent> ui;
            QScopedPointer<CDbAutoStashingComponent> m_autoStashDialog; 
            QScopedPointer<CDbAutoSimulatorStashingComponent> m_autoSimulatorDialog; 
            QScopedPointer<CDbModelMappingModifyDialog> m_modelModifyDialog; 
            swift::misc::simulation::fscommon::CVPilotRulesReader m_vPilotReader; 
            swift::misc::CDigestSignal m_dsStashedModelsChanged { this,
                                                                  &CDbMappingComponent::onStashedModelsChangedDigest,
                                                                  std::chrono::milliseconds(750), 25 };
            swift::misc::CDataReadOnly<swift::core::data::TAuthenticatedDbUser> m_swiftDbUser {
                this, &CDbMappingComponent::onUserChanged
            };
            const bool vPilotSupport = true; 
            bool m_vPilot1stInit = true; 
            bool m_vPilotEnabled = false; 
            bool m_vPilotFormatted = false; 
            bool m_autoFilterInDbViews = false; 
 
            void initVPilotLoading();
 
            void formatVPilotView();
 
            swift::misc::simulation::CAircraftModel getModelFromView(const QModelIndex &index) const;
 
            QString currentTabText() const;
 
            void updateEditorsWhenApplicable();
 
            // -------------------- component specific menus --------------------------
 
            class CMappingVPilotMenu : public menus::IMenuDelegate
            {
            public:
                CMappingVPilotMenu(CDbMappingComponent *mappingComponent) : menus::IMenuDelegate(mappingComponent) {}
 
                virtual void customMenu(menus::CMenuActions &menuActions) override;
 
            private:
                CDbMappingComponent *mappingComponent() const;
                QAction *m_menuAction = nullptr;
            };
 
            class CStashToolsMenu : public menus::IMenuDelegate
            {
            public:
                CStashToolsMenu(CDbMappingComponent *mappingComponent);
 
                virtual void customMenu(menus::CMenuActions &menuActions) override;
 
            private:
                CDbMappingComponent *mappingComponent() const;
 
                void addStashViewSpecificMenus(menus::CMenuActions &menuActions);
 
                QAction *m_autoStashing = nullptr;
                QAction *m_autoSimulatorStashing = nullptr;
                QAction *m_stashFiltering = nullptr;
            };
 
            class COwnModelSetMenu : public menus::IMenuDelegate
            {
            public:
                COwnModelSetMenu(CDbMappingComponent *mappingComponent) : menus::IMenuDelegate(mappingComponent) {}
 
                virtual void customMenu(menus::CMenuActions &menuActions) override;
 
            private:
                CDbMappingComponent *mappingComponent() const;
 
                QAction *m_menuAction = nullptr;
            };
 
            class CRemovedModelsMenu : public menus::IMenuDelegate
            {
            public:
                CRemovedModelsMenu(CDbMappingComponent *mappingComponent) : menus::IMenuDelegate(mappingComponent) {}
 
                virtual void customMenu(menus::CMenuActions &menuActions) override;
 
            private:
                CDbMappingComponent *mappingComponent() const;
 
                QAction *m_menuAction = nullptr;
            };
 
            class CApplyDbDataMenu : public menus::IMenuDelegate
            {
            public:
                CApplyDbDataMenu(CDbMappingComponent *mappingComponent) : menus::IMenuDelegate(mappingComponent) {}
 
                virtual void customMenu(menus::CMenuActions &menuActions) override;
 
            private:
                CDbMappingComponent *mappingComponent() const;
 
                QList<QAction *> m_menuActions; 
            };
 
            class CMergeWithVPilotMenu : public menus::IMenuDelegate
            {
            public:
                CMergeWithVPilotMenu(CDbMappingComponent *mappingComponent);
 
                virtual void customMenu(menus::CMenuActions &menuActions) override;
 
                CDbMappingComponent *mappingComponent() const;
 
            private:
                QList<QAction *> m_menuActions; 
            };
        };
    } // namespace components
} // namespace swift::gui
#endif // SWIFT_GUI_COMPONENTS_DBMAPPINGCOMPONENT_H