parser.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/netlist/boolean_function.h"
 
#include <map>
 
namespace hal
{
    namespace BooleanFunctionParser
    {
        enum class ParserType
        {
            Liberty,
            Standard,
            LibertyNoSpace
        };
 
        enum class TokenType
        {
 
            And,       
            Not,       
            NotSuffix, 
            Or,        
            Xor,       
            Eq,        
            Question,  
            Colon,     
            Add,       
            Sub,       
            Mul,       
            Variable, 
            Constant, 
            BracketOpen,  
            BracketClose, 
        };
 
        struct Token
        {
            // Member
 
            TokenType type;
            std::tuple<std::string, u16> variable{};
            std::vector<BooleanFunction::Value> constant{};
 
            // Constructors, Destructors, Operators
 
            Token(TokenType _type, std::tuple<std::string, u16> variable, std::vector<BooleanFunction::Value> constant);
 
            static Token And();
 
            static Token Not();
 
            static Token NotSuffix();
 
            static Token Or();
 
            static Token Xor();
 
            static Token Eq();
 
            static Token Question();
 
            static Token Colon();
 
            static Token Add();
 
            static Token Sub();
 
            static Token Mul();
 
            static Token Variable(std::string name, u16 size);
 
            static Token Constant(std::vector<BooleanFunction::Value> value);
 
            static Token BracketOpen();
 
            static Token BracketClose();
 
            // Interface
 
            unsigned precedence(const ParserType& type) const;
 
            bool is_left_associative() const;
 
            bool is(TokenType type) const;
 
            friend std::ostream& operator<<(std::ostream& os, const Token& token);
 
            std::string to_string() const;
        };
 
        Result<std::vector<Token>> parse_with_standard_grammar(const std::string& expression, const std::map<std::string, u16>& var_sizes = {});
 
        Result<std::vector<Token>> parse_with_liberty_grammar(const std::string& expression, const std::map<std::string, u16>& var_sizes = {});
 
        Result<std::vector<Token>> reverse_polish_notation(std::vector<Token>&& tokens, const std::string& expression, const ParserType& parser);
 
        Result<BooleanFunction> translate(std::vector<Token>&& tokens, const std::string& expression);
 
    }    // namespace BooleanFunctionParser
}    // namespace hal