var_pp_functor.hpp

Go to the documentation of this file.

/*
 *
 *                   _/_/_/    _/_/   _/    _/ _/_/_/    _/_/
 *                  _/   _/ _/    _/ _/_/  _/ _/   _/ _/    _/
 *                 _/_/_/  _/_/_/_/ _/  _/_/ _/   _/ _/_/_/_/
 *                _/      _/    _/ _/    _/ _/   _/ _/    _/
 *               _/      _/    _/ _/    _/ _/_/_/  _/    _/
 *
 *             ***********************************************
 *                              PandA Project
 *                     URL: http://panda.dei.polimi.it
 *                       Politecnico di Milano - DEIB
 *                        System Architectures Group
 *             ***********************************************
 *              Copyright (C) 2004-2024 Politecnico di Milano
 *
 *   This file is part of the PandA framework.
 *
 *   The PandA framework is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
#ifndef _VAR_PP_FUNCTOR_HPP
#define _VAR_PP_FUNCTOR_HPP

#include "custom_set.hpp" // for CustomSet
#include "refcount.hpp"
#include <string> // for string
#include <utility>

REF_FORWARD_DECL(Parameter);
CONSTREF_FORWARD_DECL(BehavioralHelper);
REF_FORWARD_DECL(var_pp_functor);

struct var_pp_functor
{
   virtual ~var_pp_functor() = default;

   virtual std::string operator()(unsigned int var) const = 0;
};
using var_pp_functorRef = refcount<var_pp_functor>;
using var_pp_functorConstRef = refcount<const var_pp_functor>;

struct std_var_pp_functor : public var_pp_functor
{
 private:
   const BehavioralHelperConstRef BH;

 public:
   explicit std_var_pp_functor(const BehavioralHelperConstRef _BH) : BH(_BH)
   {
   }

   ~std_var_pp_functor() override = default;

   std::string operator()(unsigned int var) const override;
};

struct pointer_var_pp_functor : public var_pp_functor
{
   pointer_var_pp_functor(const BehavioralHelperConstRef _BH, const CustomSet<unsigned int> vars,
                          bool _add_restrict = false);

   ~pointer_var_pp_functor() override = default;

   std::string operator()(unsigned int var) const override;

 private:
   const CustomSet<unsigned int> pointer_based_variables;

   const BehavioralHelperConstRef BH;

   const std_var_pp_functor std_functor;

   bool add_restrict;
};

struct address_var_pp_functor : public var_pp_functor
{
 public:
   address_var_pp_functor(const BehavioralHelperConstRef _BH, const CustomSet<unsigned int> vars,
                          const CustomSet<unsigned int> pointer_vars);

   ~address_var_pp_functor() override = default;

   std::string operator()(unsigned int var) const override;

 private:
   const CustomSet<unsigned int> addr_based_variables;

   const CustomSet<unsigned int> pointer_based_variables;

   const BehavioralHelperConstRef BH;
};

struct isolated_var_pp_functor : public var_pp_functor
{
 private:
   const BehavioralHelperConstRef BH;
   unsigned int repl_var;
   std::string var_string;

 public:
   isolated_var_pp_functor(const BehavioralHelperConstRef _BH, unsigned int _repl_var, const std::string& _var_string)
       : BH(_BH), repl_var(_repl_var), var_string(_var_string)
   {
   }

   ~isolated_var_pp_functor() override = default;

   std::string operator()(unsigned int var) const override;
};

#endif