VIVADO_xsim_wrapper.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 XILINX_VIVADO_XSIM_WRAPPER_HPP
#define XILINX_VIVADO_XSIM_WRAPPER_HPP

#include "SimulationTool.hpp"
#include "refcount.hpp"
CONSTREF_FORWARD_DECL(Parameter);
class xml_element;

#include "custom_map.hpp"
#include <string>
#include <vector>

#define XSIM_SUBDIR (Param->getOption<std::string>(OPT_output_directory) + std::string("/xsim"))

class VIVADO_xsim_wrapper : public SimulationTool
{
 private:
   std::string suffix;

   std::string create_project_script(const std::string& top_filename, const std::list<std::string>& file_list);

   std::string GenerateScript(std::ostream& script, const std::string& top_filename,
                              const std::list<std::string>& file_list) override;

 public:
   VIVADO_xsim_wrapper(const ParameterConstRef& Param, const std::string& suffix, const std::string& top_fname,
                       const std::string& inc_dirs);

   ~VIVADO_xsim_wrapper() override;

   void CheckExecution() override;

   void Clean() const override;
};
using VIVADO_xsim_wrapperRef = refcount<VIVADO_xsim_wrapper>;

#endif