instruction_writer.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 INSTRUCTION_WRITER_HPP
#define INSTRUCTION_WRITER_HPP

#include "graph.hpp"

#include <fstream>
#include <iosfwd>
#include <ostream>

#include "refcount.hpp"

CONSTREF_FORWARD_DECL(application_manager);
CONSTREF_FORWARD_DECL(FunctionBehavior);
REF_FORWARD_DECL(IndentedOutputStream);
REF_FORWARD_DECL(InstructionWriter);
CONSTREF_FORWARD_DECL(Parameter);
CONSTREF_FORWARD_DECL(var_pp_functor);
class simple_indent;
enum class ActorGraphBackend_Type;

class InstructionWriter
{
 protected:
   const application_managerConstRef AppM;

   const IndentedOutputStreamRef indented_output_stream;

   const ParameterConstRef parameters;

   int debug_level;

   InstructionWriter(const application_managerConstRef AppM, const IndentedOutputStreamRef indented_output_stream,
                     const ParameterConstRef parameters);

 public:
   static InstructionWriterRef CreateInstructionWriter(const ActorGraphBackend_Type actor_graph_backend_type,
                                                       const application_managerConstRef AppM,
                                                       const IndentedOutputStreamRef indented_output_stream,
                                                       const ParameterConstRef parameters);

   virtual ~InstructionWriter();

   virtual void Initialize();

   virtual void write(const FunctionBehaviorConstRef function_behavior, const vertex statement,
                      const var_pp_functorConstRef varFunctor);

   virtual void declareFunction(const unsigned int function_id);

   virtual void write_declarations();

   void WriteComment(const std::string& text);
};
using InstructionWriterRef = refcount<InstructionWriter>;
#endif