NP_functionality.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 NP_FUNCTIONALITY_HPP
#define NP_FUNCTIONALITY_HPP
#include "custom_map.hpp"
#include "refcount.hpp"
#include <ostream>
#include <string>
#include <vector>

REF_FORWARD_DECL(NP_functionality);

class xml_element;

#define START_LIBRARY_PARAMETER 1
#define LIBRARY_NAME 0


#define LIBRARY_DECL_SUFFIX_EXT "_DECL"

class NP_functionality
{
 public:
   enum NP_functionaly_type
   {
      TABLE = 0,
      EQUATION,
      PORT_LIST,
      LIBRARY,
      GRAPH,
      FSM,
      FSM_CS,
      SC_PROVIDED,
      VHDL_PROVIDED,
      VERILOG_PROVIDED,
      SYSTEM_VERILOG_PROVIDED,
      VERILOG_GENERATOR,
      VHDL_GENERATOR,
      FLOPOCO_PROVIDED,
      BAMBU_PROVIDED,
      IP_COMPONENT,
      IP_INCLUDE,
      IP_LIBRARY,
      VERILOG_FILE_PROVIDED,
      VHDL_FILE_PROVIDED,
      UNKNOWN
   };

 private:
   std::map<NP_functionaly_type, std::string> descriptions;
   static const char* NP_functionaly_typeNames[];
   NP_functionaly_type to_NP_functionaly_type(const std::string& val);

 public:
   NP_functionality() = default;

   explicit NP_functionality(const NP_functionalityRef& obj);

   ~NP_functionality() = default;

   void add_NP_functionality(NP_functionaly_type type, const std::string& functionality_description);

   std::string get_NP_functionality(NP_functionaly_type type) const;

   bool exist_NP_functionality(NP_functionaly_type type) const;

   std::string get_library_name() const;

   void get_library_parameters(std::vector<std::string>& parameters) const;

   void get_port_list(std::map<unsigned int, std::map<std::string, std::string>>& InPortMap,
                      std::map<unsigned int, std::map<std::string, std::string>>& OutPortMap) const;

   void xload(const xml_element* Enode);

   void xwrite(xml_element* rootnode);

   void print(std::ostream& os) const;

   std::string get_kind_text() const
   {
      return std::string("NP_functionality");
   }
};

using NP_functionalityRef = refcount<NP_functionality>;

#endif