LibraryHandler.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: libraryhandler.h
//-----------------------------------------------------------------------------
// Project: Kactus 2
// Author: Antti Kamppi
// Date: 20.12.2010
//
// Description:
// LibraryHandler is the class that implements the services to manage the IP-XACT library.
//-----------------------------------------------------------------------------
 
#ifndef LIBRARYHANDLER_H
#define LIBRARYHANDLER_H
 
#include "LibraryInterface.h"
#include "LibraryLoader.h"
#include "LibraryModel.h"
 
#include "HierarchyModelBase.h"
 
#include "NullChannel.h"
#include "utils.h"
 
#include "DocumentFileAccess.h"
#include "DocumentValidator.h"
 
#include <IPXACTmodels/common/Document.h>
#include <IPXACTmodels/common/TagData.h>
 
#include <IPXACTmodels/kactusExtensions/KactusAttribute.h>
 
#include <KactusAPI/KactusAPIGlobal.h>
 
#include <QString>
#include <QStringList>
#include <QList>
#include <QSharedPointer>
#include <QObject>
 
class LibraryItem;
class MessageMediator;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API LibraryHandler : public QObject, public LibraryInterface
{
    Q_OBJECT
 
public:

    static LibraryHandler& getInstance();

    LibraryHandler(const LibraryHandler &other) = delete;

    LibraryHandler& operator=(const LibraryHandler& other) = delete;

    ~LibraryHandler() final = default;
 
    void setOutputChannel(MessageMediator* messageChannel);

    void replaceModel(LibraryModel* model);

    void replaceHierarchyModel(HierarchyModelBase* model);

    QSharedPointer<Document> getModel(VLNV const& vlnv) final;

    QSharedPointer<Document const> getModelReadOnly(VLNV const& vlnv) final;

    QList<VLNV> getAllVLNVs() const final;

    bool contains(VLNV const& vlnv) const final;

    const QString getPath(VLNV const& vlnv) const final;

    QString getDirectoryPath(VLNV const& vlnv) const final;

    bool writeModelToFile(QString const& path, QSharedPointer<Document> model) final;

    bool writeModelToFile(QSharedPointer<Document> model) final;

    void searchForIPXactFiles() final;
    
     void getNeededVLNVs(VLNV const& vlnv, QList<VLNV>& list) final;

     void getDependencyFiles(VLNV const& vlnv, QStringList& list) final;

     LibraryItem const* getTreeRoot() const final;

    VLNV::IPXactType getDocumentType(VLNV const& vlnv) final;

    int referenceCount(VLNV const& vlnv) const final;

    int getOwners(QList<VLNV>& list, VLNV const& vlnvToSearch) const final;

    int getChildren(QList<VLNV>& list, VLNV const& vlnvToSearch) const final;

    VLNV getDesignVLNV(VLNV const& hierarchyRef) final;

    QSharedPointer<Design> getDesign(VLNV const& hierarchyRef) final;

    bool isValid(VLNV const& vlnv) final;
 
    HierarchyModelBase* getHierarchyModel();
 
    LibraryModel* getTreeModel();

    QVector<QString> findErrorsInDocument(QSharedPointer<Document> document, QString const& path);
 
public slots:

    void onCheckLibraryIntegrity() final;

    void onEditItem(VLNV const& vlnv) final;

    void onOpenDesign(VLNV const& vlnv, QString const& viewName) final;

    void onOpenMemoryDesign(VLNV const& vlnv, QString const& activeView);

    void onOpenSWDesign(VLNV const& vlnv);

    void onOpenSystemDesign(VLNV const& vlnv, QString const& activeView);
 

    void removeObject(VLNV const& vlnv) final;

    void removeObjects(const QList<VLNV>& vlnvList) final;

    void beginSave();

    void endSave();
 
signals:
 
 
    void progressStatus();

    void openDesign(VLNV const& vlnv, const QString& viewName);

    void openMemoryDesign(VLNV const& vlnv, const QString& viewName);

    void openSWDesign(VLNV const& vlnv, QString const& viewName);

    void openSystemDesign(VLNV const& vlnv, QString const& viewName);

    void openBus(VLNV const& busDefVLNV);

    void openAbsDef(VLNV const& absDefVLNV);

    void openComponent(VLNV const& vlnv);

    void openCatalog(VLNV const& vlnv);

    void openComDefinition(VLNV const& vlnv);

    void openApiDefinition(VLNV const& vlnv);

    void itemSelected(VLNV const& vlnv);

    void openPlatformComponent(VLNV const& vlnv);

    void updatedVLNV(VLNV const& vlnv);

    void addVLNV(VLNV const& vlnv);

    void removeVLNV(VLNV const& vlnv);

    void resetModel();
 
private slots:
    
    void onItemSaved(VLNV const& vlnv);
 
private:

    struct DocumentInfo
    {
        QSharedPointer<Document> document;  //<! The model for the document.
        QString path;                       //<! The path to the file containing the document.
        bool isValid;                       //<! Flag for well-formed content.

        explicit DocumentInfo(QString const& filePath = QString(), 
            QSharedPointer<Document> doc = QSharedPointer<Document>(),
            bool valid = false): document(doc), path(filePath), isValid(valid) {}
    };

    struct DocumentStatistics
    {
        int fileCount = 0;
        int documentCount = 0;
    };
 
    //-----------------------------------------------------------------------------
    // The private functions used by public class methods
    //-----------------------------------------------------------------------------

    LibraryHandler();
 

    void syncronizeModels();

    void showNotFoundError(VLNV const& vlnv) const;

    bool addObject(QSharedPointer<Document> model, QString const& filePath);

    void clearCache();

    void loadAvailableVLNVs();

    void resetModels();

    void showIntegrityResults() const;

     bool removeFile(QString const& filePath) const;

    bool validateDocument(QSharedPointer<Document> document, QString const& documentPath);
 

    bool validateDependentVLNVReferencences(QSharedPointer<Document> document);

    void findErrorsInDependentVLNVReferencences(QSharedPointer<const Document> document, QVector<QString>& errorList);

    bool validateDependentDirectories(QSharedPointer<Document> document, QString const& documentPath);

    void findErrorsInDependentDirectories(QSharedPointer<const Document> document, QString const& documentPath,
        QVector<QString>& errorList);

    bool validateDependentFiles(QSharedPointer<Document> document, QString const& documentPath);

    void findErrorsInDependentFiles(QSharedPointer<const Document> document, QString const& documentPath,
        QVector<QString>& errorList);
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------
 

    NullChannel defaultChannel;

    MessageMediator* messageChannel_{ &defaultChannel };

    LibraryLoader loader_{ };

    QMap<VLNV, DocumentInfo> documentCache_;

    QRegularExpressionValidator urlTester_{ Utils::URL_VALIDITY_REG_EXP, this };

    DocumentValidator validator_{ this };

    QScopedPointer<LibraryModel> treeModel_ = QScopedPointer<LibraryModel>{ new LibraryModel(this) };

    QScopedPointer<HierarchyModelBase> hierarchyModel_ = QScopedPointer<HierarchyModelBase>(new HierarchyModelBase{ this, this });

    bool saveInProgress_{ false };

    DocumentStatistics checkResults_;
 
};
 
#endif // LIBRARYHANDLER_H