hls_flow_step_factory.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 HLS_FLOW_STEP_FACTORY_HPP
#define HLS_FLOW_STEP_FACTORY_HPP

#include "custom_set.hpp"
#include "design_flow_step_factory.hpp"

#include <vector>

REF_FORWARD_DECL(DesignFlowStep);
REF_FORWARD_DECL(HLS_manager);
CONSTREF_FORWARD_DECL(HLSFlowStepSpecialization);
class xml_element;
class DesignFlowStepSet;
enum class HLSFlowStep_Type;

class HLSFlowStepFactory : public DesignFlowStepFactory
{
 protected:
   const HLS_managerRef HLS_mgr;

   bool checkNode(const xml_element* node, unsigned int funId, const std::string& ref_step) const;

 public:
   HLSFlowStepFactory(const DesignFlowManagerConstRef design_flow_manager, const HLS_managerRef _HLS_mgr,
                      const ParameterConstRef parameters);

   ~HLSFlowStepFactory() override;

   const std::string GetPrefix() const override;

   DesignFlowStepRef CreateHLSFlowStep(const HLSFlowStep_Type hls_flow_step_type, const unsigned int funId,
                                       const HLSFlowStepSpecializationConstRef hls_flow_step_specialization =
                                           HLSFlowStepSpecializationConstRef()) const;

   const DesignFlowStepSet CreateHLSFlowSteps(
       const CustomUnorderedSet<std::pair<HLSFlowStep_Type, HLSFlowStepSpecializationConstRef>>& hls_flow_steps) const;

   const DesignFlowStepSet
   CreateHLSFlowSteps(const std::pair<HLSFlowStep_Type, HLSFlowStepSpecializationConstRef>& hls_flow_step) const;
   const DesignFlowStepSet
   CreateHLSFlowSteps(const HLSFlowStep_Type type,
                      const HLSFlowStepSpecializationConstRef hls_flow_step_specialization) const;
   const DesignFlowStepRef
   CreateHLSFlowStep(const std::pair<HLSFlowStep_Type, HLSFlowStepSpecializationConstRef>& hls_flow_step) const;

   const DesignFlowStepRef
   CreateHLSFlowStep(const HLSFlowStep_Type type,
                     const HLSFlowStepSpecializationConstRef hls_flow_step_specialization) const;
};
#endif