file_manager.h

Go to the documentation of this file.

// MIT License
// 
// Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
// Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
// Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
#pragma once
 
#include "hal_core/utilities/program_arguments.h"
 
#include <QObject>
#include <QTimer>
#include <QDir>
 
class QFileSystemWatcher;
 
namespace hal
{
    class GateLibrary;
    class SettingsItemCheckbox;
    class SettingsItemSpinbox;
    class FileManager : public QObject
    {
        Q_OBJECT
 
    public:
        static FileManager* get_instance();
 
        QString fileName() const;
 
        bool fileOpen() const;
 
        void watchFile(const QString& fileName);
 
        void emitProjectSaved(QString& projectDir, QString& file);
 
        enum DirectoryStatus { ProjectDirectory=2, OtherDirectory=1, IsFile=0, NotExisting=-1, InvalidExtension=-2, ParseError=-3,
                               NetlistError=-4, GatelibError=-5, UnknownDirectoryEntry=-6  };
 
        static DirectoryStatus directoryStatus(const QString& pathname);
 
        static QString directoryStatusText(DirectoryStatus stat);
 
        static GateLibrary* loadGateLibrary(const QString& path);
    Q_SIGNALS:
        void fileOpened(const QString& fileName);
 
        void projectOpened(QString projectDir, QString fileName);
 
        void projectSaved(QString projectDir, QString fileName);
 
        void fileChanged(const QString& path);
 
        void fileDirectoryChanged(const QString& path);
 
        void fileClosed();
 
        void fileAboutToClose(const QString& fileName);
 
    public Q_SLOTS:
 
        bool deprecatedOpenFile(QString filename, QString gatelibraryPath);
 
 
        void importFile(QString filename);
 
        void newProject();
 
        void openProject(QString projPath);
 
        void closeFile();
 
        void autosave();
 
    private Q_SLOTS:
        void handleFileChanged(const QString& path);
        void handleDirectoryChanged(const QString& path);
 
    private:
        FileManager(QObject* parent = nullptr);
 
        void fileSuccessfullyLoaded(QString file);
 
        void projectSuccessfullyLoaded(QString& projectDir, QString& file);
 
        void updateRecentFiles(const QString& file) const;
 
        void displayErrorMessage(QString error_message);
 
        void removeShadowDirectory();
 
        void moveShadowToProject(const QDir& shDir) const;
 
        QString mFileName;
        QFileSystemWatcher* mFileWatcher;
        bool mFileOpen;
        QTimer* mTimer;
        bool mAutosaveEnabled;
        int mAutosaveInterval;
 
        SettingsItemCheckbox* mSettingAutosave;
        SettingsItemSpinbox* mSettingAutosaveInterval;
    };
}