project_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/defines.h"
#include "hal_core/netlist/netlist.h"
#include "hal_core/utilities/json_write_document.h"
#include "hal_core/utilities/project_directory.h"
 
#include <filesystem>
#include <string>
#include <unordered_map>
 
namespace hal
{
    class Netlist;
    class ProjectSerializer;
 
    class ProjectManager
    {
    public:
        enum ProjectStatus
        {
            NONE,   
            OPENED, 
            SAVED   
        };
 
    private:
        ProjectManager();
 
        static ProjectManager* inst;
 
        ProjectStatus m_project_status;
        Netlist* m_netlist_save;
        std::unique_ptr<Netlist> m_netlist_load;
        ProjectDirectory m_proj_dir;
        std::string m_proj_file;
        std::string m_netlist_file;
        std::string m_gatelib_path;
        std::unordered_map<std::string, ProjectSerializer*> m_serializer;
        std::unordered_map<std::string, std::string> m_filename;
 
        bool serialize_external(bool shadow);
 
        bool deserialize();
 
        bool serialize_to_projectfile(bool shadow) const;
 
    public:
        static ProjectManager* instance();
 
        void register_serializer(const std::string& tagname, ProjectSerializer* serializer);
 
        void unregister_serializer(const std::string& tagname);
 
        ProjectStatus get_project_status() const;
 
        void set_project_status(ProjectStatus status);
 
        std::string get_filename(const std::string& serializer_name);
 
        std::unique_ptr<Netlist>& get_netlist();
 
        void dump() const;
 
        void set_gate_library_path(const std::string& gl_path);
 
        bool serialize_project(Netlist* netlist, bool shadow = false);
 
        bool open_project(const std::string& path = "");
 
        const ProjectDirectory& get_project_directory() const;
 
        void set_project_directory(const std::string& path);
 
        void restore_project_file_from_autosave();
 
        bool create_project_directory(const std::string& path);
 
        bool remove_project_directory();
 
        std::string get_netlist_filename() const;
 
        static const std::string s_project_file;
    };
}    // namespace hal