data_container.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/parameter.h"
#include "hal_core/utilities/result.h"
 
#include <map>
#include <string>
#include <tuple>
#include <unordered_map>
#include <vector>
 
namespace hal
{
    class NETLIST_API DataContainer
    {
    public:
        DataContainer() = default;
 
        virtual ~DataContainer() = default;
 
        bool operator==(const DataContainer& other) const;
 
        bool operator!=(const DataContainer& other) const;
 
        bool set_data(const std::string& category, const std::string& key, const std::string& data_type, const std::string& value, const bool log_with_info_level = false);
 
        bool has_data(const std::string& category, const std::string& key) const;
 
        std::tuple<std::string, std::string> get_data(const std::string& category, const std::string& key) const;
 
        bool delete_data(const std::string& category, const std::string& key, const bool log_with_info_level = false);
 
        const std::map<std::tuple<std::string, std::string>, std::tuple<std::string, std::string>>& get_data_map() const;
 
        void set_data_map(const std::map<std::tuple<std::string, std::string>, std::tuple<std::string, std::string>>& map);
 
        Result<std::monostate> set_parameter(const Parameter& param, const std::string& value);
 
        Result<std::string> get_parameter_value(const std::string& name) const;
 
        Result<std::string> get_parameter_value(const Parameter& name) const;
 
        Result<Parameter> get_parameter_declaration(const std::string& name) const;
 
        bool has_parameter(const Parameter& param) const;
 
        bool has_parameter(const std::string& name) const;
 
        bool delete_parameter(const std::string& name);
 
        const std::unordered_map<std::string, std::pair<Parameter, std::string>>& get_parameters() const;
 
    protected:
        std::map<std::tuple<std::string, std::string>, std::tuple<std::string, std::string>> m_data;
        std::unordered_map<std::string, std::pair<Parameter, std::string>> m_parameters;
    };
}    // namespace hal