CVisualRegistryEditorComp.h

Go to the documentation of this file.

/********************************************************************************
**  This file is part of the ICF Framework. Copyright (C) Witold Gantzke & Kirill Lepskiy
**  ICF Framework may be used under the terms of the LGPL License v. 2.1 by the Free Software Foundation.
********************************************************************************/
 
#pragma once
 
 
// Qt includes
#include <QtCore/QObject>
#include <QtCore/QTimer>
 
// ICF includes
#include <istd/TPointerVector.h>
#include <ifile/IFilePersistence.h>
#include <imod/CMultiModelDispatcherBase.h>
#include <icomp/IRegistry.h>
#include <icomp/IMetaInfoManager.h>
#include <icomp/IPackagesManager.h>
#include <ibase/ICommandsProvider.h>
#include <idoc/IHelpViewer.h>
#include <idoc/IDocumentManager.h>
#include <istdgui/TDesignerGuiObserverCompBase.h>
#include <istdgui/CHierarchicalCommand.h>
#include <istdgui/IDropConsumer.h>
#include <icmpstr/IRegistryPreview.h>
#include <icmpstr/IRegistryConsistInfo.h>
#include <icmpstr/IElementSelectionInfo.h>
#include <icmpstr/ISceneProvider.h>
 
#include <GeneratedFiles/icmpstr/ui_CVisualRegistryEditorComp.h>
 
 
namespace icmpstr
{
 
class CRegistryElementShape;
class CVisualRegistryElement;
class CVisualRegistry;
 
 
class CVisualRegistryEditorCompBase:
        public istdgui::TDesignerGuiObserverCompBase<Ui::CVisualRegistryEditorComp, icomp::IRegistry>,
        virtual public istdgui::IDropConsumer,
        virtual public ibase::ICommandsProvider
{
    Q_OBJECT
 
public:
    typedef istdgui::TDesignerGuiObserverCompBase<Ui::CVisualRegistryEditorComp, icomp::IRegistry> BaseClass;
 
    I_BEGIN_BASE_COMPONENT(CVisualRegistryEditorCompBase);
        I_ASSIGN(m_sceneProviderCompPtr, "SceneProvider", "Display view where graphical objects will be shown", true, "SceneProvider");
        I_ASSIGN_TO(m_sceneProviderGuiCompPtr, m_sceneProviderCompPtr, true);
        I_ASSIGN(m_registryCodeSaverCompPtr, "RegistryCodeSaver", "Export registry to C++ code file", false, "RegistryCodeSaver");
        I_ASSIGN(m_registryPreviewCompPtr, "RegistryPreview", "Executes preview of the registry", false, "RegistryPreview");
        I_ASSIGN(m_metaInfoManagerCompPtr, "MetaInfoManager", "Allows access to component meta information", true, "MetaInfoManager");
        I_ASSIGN_TO(m_metaInfoManagerModelCompPtr, m_metaInfoManagerCompPtr, false);
        I_ASSIGN(m_packagesManagerCompPtr, "PackagesManager", "Access to information about package files", false, "PackagesManager");
        I_ASSIGN(m_quickHelpViewerCompPtr, "QuickHelpGui", "Show help of selected component using its address", false, "QuickHelpGui");
        I_ASSIGN(m_documentManagerCompPtr, "DocumentManager", "Document manager allowing to load files on double click", false, "DocumentManager");
        I_ASSIGN(m_consistencyInfoCompPtr, "ConsistencyInfo", "Allows to check consistency of registries and attributes", false, "ConsistencyInfo");
        I_ASSIGN(m_registryTopologyGuiCompPtr, "RegistryTopologyGui", "GUI for showing the registry component topology", false, "RegistryTopologyGui");
        I_ASSIGN_TO(m_registryObserverCompPtr, m_registryTopologyGuiCompPtr, false);
        I_ASSIGN(m_registryValidationStatusCompPtr, "RegistryValidationStatus", "Visual status of registry validation", false, "RegistryValidationStatus");
        I_ASSIGN_TO(m_registryValidationStatusModelCompPtr, m_registryValidationStatusCompPtr, false);
    I_END_COMPONENT;
 
protected:
    I_REF(ifile::IFilePersistence, m_registryCodeSaverCompPtr);
    I_REF(IRegistryPreview, m_registryPreviewCompPtr);
    I_REF(icomp::IMetaInfoManager, m_metaInfoManagerCompPtr);
    I_REF(imod::IModel, m_metaInfoManagerModelCompPtr);
    I_REF(icomp::IPackagesManager, m_packagesManagerCompPtr);
    I_REF(idoc::IHelpViewer, m_quickHelpViewerCompPtr);
    I_REF(idoc::IDocumentManager, m_documentManagerCompPtr);
    I_REF(IRegistryConsistInfo, m_consistencyInfoCompPtr);
    I_REF(istdgui::IGuiObject, m_registryTopologyGuiCompPtr);
    I_REF(imod::IObserver, m_registryObserverCompPtr);
    I_REF(istdgui::IVisualStatus, m_registryValidationStatusCompPtr);
    I_REF(imod::IModel, m_registryValidationStatusModelCompPtr);
    I_REF(ISceneProvider, m_sceneProviderCompPtr);
    I_REF(istdgui::IGuiObject, m_sceneProviderGuiCompPtr);
};
 
 
class CVisualRegistryEditorComp:
        public CVisualRegistryEditorCompBase,
        protected imod::CMultiModelDispatcherBase
{
    Q_OBJECT
 
public:
    typedef CVisualRegistryEditorCompBase BaseClass;
 
    I_BEGIN_COMPONENT(CVisualRegistryEditorComp);
        I_REGISTER_INTERFACE(ibase::ICommandsProvider);
        I_REGISTER_INTERFACE(istdgui::IDropConsumer);
        I_REGISTER_INTERFACE(imod::IObserver);
        I_REGISTER_INTERFACE(istdgui::IGuiObject);
        I_REGISTER_SUBELEMENT(SelectionInfo);
        I_REGISTER_SUBELEMENT_INTERFACE(SelectionInfo, IElementSelectionInfo, ExtractSelectionInfo);
        I_REGISTER_SUBELEMENT_INTERFACE(SelectionInfo, imod::IModel, ExtractSelectionInfo);
        I_REGISTER_SUBELEMENT_INTERFACE(SelectionInfo, istd::IChangeable, ExtractSelectionInfo);
    I_END_COMPONENT;
 
    CVisualRegistryEditorComp();
 
    // font getters used by CRegistryElementShape
    const QFont& GetElementNameFont() const;
    const QFont& GetElementDetailFont() const;
 
    const icomp::IMetaInfoManager* GetMetaInfoManager() const;
    const IRegistryConsistInfo* GetRegistryConsistInfo() const;
 
    bool TryOpenComponent(const CVisualRegistryElement& registryElement);
 
    void SetAcceptedMimeTypes(const QStringList& mimeTypes);
 
    // reimplemented (ibase::ICommandsProvider)
    const ibase::IHierarchicalCommand* GetCommands() const override;
 
    // reimplemented (istdgui::IDropConsumer)
    QStringList GetAcceptedMimeIds() const override;
    void OnDropFinished(const QMimeData& mimeData, QEvent* eventPtr) override;
 
protected:
    enum GroupId
    {
        GI_COMPONENT = 0x5430,
        GI_EMBEDDED_REGISTRY,
        GI_CODEGEN,
        GI_PREVIEW,
        GI_EDIT,
        GI_TOOLS
    };
 
    class EnvironmentObserver: public imod::TSingleModelObserverBase<icomp::IMetaInfoManager>
    {
    public:
        EnvironmentObserver(CVisualRegistryEditorComp* parentPtr);
 
    protected:
        // reimplemented (imod::TSingleModelObserverBase)
        virtual void OnUpdate(const istd::IChangeable::ChangeSet& changeSet);
 
    private:
        CVisualRegistryEditorComp& m_parent;
    };
 
    icomp::IRegistry* GetSelectedRegistry() const;
 
    QGraphicsItem* AddShapeToScene(iser::ISerializable* elementPtr) const;
    void AddConnectorsToScene();
    void AddConnector(
                CRegistryElementShape& sourceShape,
                const QByteArray& referenceComponentId,
                const QByteArray& attributeId,
                bool isFactory = false);
 
    icomp::IRegistryElement* TryCreateComponent(
                const QByteArray& elementId,
                const icomp::CComponentAddress& address,
                const i2d::CVector2d& position);
 
    void ConnectReferences(const QByteArray& componentRole);
 
    void UpdateComponentSelection();
 
    void DoRetranslate();
 
    void UpdateEmbeddedRegistryButtons();
    void UpdateEmbeddedRegistryView(const QByteArray& id);
 
    virtual bool OnDropObject(const QMimeData& data, QGraphicsSceneDragDropEvent* eventPtr);
    virtual void UpdateScene();
 
    // reimplemented (imod::CMultiModelDispatcherBase)
    void OnModelChanged(int modelId, const istd::IChangeable::ChangeSet& changeSet) override;
 
    // reimplemented (istdgui::TGuiObserverWrap)
    void UpdateGui(const istd::IChangeable::ChangeSet& changeSet) override;
 
    // reimplemented (imod::CSingleModelObserverBase)
    bool OnModelAttached(imod::IModel* modelPtr, istd::IChangeable::ChangeSet& changeMask) override;
    bool OnModelDetached(imod::IModel* modelPtr) override;
 
    // reimplemented (icomp::CGuiComponentBase)
    void OnRetranslate() override;
 
    // reimplemented (icomp::CComponentBase)
    void OnComponentCreated() override;
    void OnComponentDestroyed() override;
 
    // reimplemented (istdgui::CGuiComponentBase)
    void OnGuiCreated() override;
    void OnGuiDestroyed() override;
 
protected Q_SLOTS:
    void OnSelectionChanged();
 
    void OnCutCommand();
    void OnCopyCommand();
    void OnPasteCommand();
    void OnRemoveComponent();
    void OnRenameComponent();
    void NewEmbeddedComponent();
    void ToEmbeddedComponent();
    void RemoveEmbeddedComponent();
    void OnExportToCode();
    void OnExecute();
    void OnAbort();
    void OnExecutionTimerTick();
    void OnShowRegistryTopology();
 
    void OnEmbeddedComponentButtonClicked();
 
private:
    class SelectionInfoImpl: virtual public IElementSelectionInfo
    {
    public:
        void SetParent(CVisualRegistryEditorComp* parentPtr);
 
        // reimplemented (icmpstr::IElementSelectionInfo)
        virtual icomp::IRegistry* GetSelectedRegistry() const;
        virtual Elements GetSelectedElements() const;
 
    private:
        CVisualRegistryEditorComp* m_parentPtr;
    };
 
    friend class imod::TModelWrap<SelectionInfoImpl>;
 
    // static template methods for subelement access
    template <class InterfaceType>
    static InterfaceType* ExtractSelectionInfo(CVisualRegistryEditorComp& component)
    {
        return &component.m_selectionInfo;
    }
 
    istdgui::CHierarchicalCommand m_rootMenuCommand;
    istdgui::CHierarchicalCommand m_editMenu;
    istdgui::CHierarchicalCommand m_cutCommand;
    istdgui::CHierarchicalCommand m_copyCommand;
    istdgui::CHierarchicalCommand m_pasteCommand;
    istdgui::CHierarchicalCommand m_removeComponentCommand;
    istdgui::CHierarchicalCommand m_registryMenu;
    istdgui::CHierarchicalCommand m_renameComponentCommand;
    istdgui::CHierarchicalCommand m_newEmbeddedRegistryCommand;
    istdgui::CHierarchicalCommand m_toEmbeddedRegistryCommand;
    istdgui::CHierarchicalCommand m_removeEmbeddedRegistryCommand;
    istdgui::CHierarchicalCommand m_exportToCodeCommand;
    istdgui::CHierarchicalCommand m_executeRegistryCommand;
    istdgui::CHierarchicalCommand m_abortRegistryCommand;
    istdgui::CHierarchicalCommand m_showRegistryTopologyCommand;
 
    QTimer m_executionObserverTimer;
 
    QFont m_elementNameFont;
    QFont m_elementDetailFont;
 
    typedef QSet<QByteArray> ElementIds;
    ElementIds m_selectedElementIds;
 
    EnvironmentObserver m_environmentObserver;
 
    imod::TModelWrap<SelectionInfoImpl> m_selectionInfo;
 
    QByteArray m_embeddedRegistryId;
    QGraphicsScene* m_scenePtr;
    QStringList m_acceptedMimeTypes;
 
    istd::TPointerVector<QToolButton> m_embeddedButtons;
    QSpacerItem* m_buttonSpacerPtr;
};
 
 
// inline methods
 
inline const icomp::IMetaInfoManager* CVisualRegistryEditorComp::GetMetaInfoManager() const
{
    return m_metaInfoManagerCompPtr.get();
}
 
 
inline const IRegistryConsistInfo* CVisualRegistryEditorComp::GetRegistryConsistInfo() const
{
    return m_consistencyInfoCompPtr.get();
}
 
 
} // namespace icmpstr