parameter.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/utilities/enums.h"
#include "hal_core/utilities/result.h"
 
#include <map>
#include <string>
#include <vector>
 
namespace hal
{
    struct NETLIST_API Parameter
    {
        enum class Type
        {
            Boolean,
            BitVector,
            LogicVector,
            Integer,
            String,
            Float,
            Time,
            Enum,
        };
 
        explicit Parameter();
 
        const std::string& get_name() const;
 
        Type get_type() const;
 
        u16 get_size() const;
 
        const std::string& get_default_value() const;
 
        const std::vector<std::string>& get_enum_values() const;
 
        static Result<Parameter> Boolean(const std::string& name, const std::string& default_value);
 
        static Result<Parameter> BitVector(const std::string& name, u16 size, const std::string& default_value);
 
        static Result<Parameter> LogicVector(const std::string& name, u16 size, const std::string& default_value);
 
        static Result<Parameter> Integer(const std::string& name, const std::string& default_value);
 
        static Result<Parameter> String(const std::string& name, const std::string& default_value);
 
        static Result<Parameter> Float(const std::string& name, const std::string& default_value);
 
        static Result<Parameter> Time(const std::string& name, const std::string& default_value);
 
        static Result<Parameter> Enum(const std::string& name, const std::vector<std::string>& values, const std::string& default_value);
 
        bool validate(const std::string& value) const;
 
        Result<u64> encode_as_int(const std::string& value) const;
 
        bool operator==(const Parameter& other) const;
        bool operator!=(const Parameter& other) const;
 
    private:
        std::string name;
        Type type;
        u16 size = 0;
        std::string default_value = "";
        std::vector<std::string> enum_values = {};
    };
 
    template<>
    std::map<Parameter::Type, std::string> EnumStrings<Parameter::Type>::data;
}    // namespace hal