xml_script_command.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 _XML_SCRIPT_COMMAND_HPP_
#define _XML_SCRIPT_COMMAND_HPP_

#include <vector>

#include "refcount.hpp"

#include "polixml.hpp"
#include "xml_helper.hpp"

REF_FORWARD_DECL(xml_script_node_t);
REF_FORWARD_DECL(xml_set_variable_t);
REF_FORWARD_DECL(xml_set_entry_t);
REF_FORWARD_DECL(xml_parameter_t);
REF_FORWARD_DECL(xml_command_t);
REF_FORWARD_DECL(xml_shell_t);
REF_FORWARD_DECL(xml_ite_block_t);
REF_FORWARD_DECL(DesignParameters);

// Tags of XML nodes
#define TAG_VARIABLE "set"
#define TAG_ENTRY "entry"
#define TAG_PARAMETER "param"
#define TAG_COMMAND "cmd"
#define TAG_SHELL "sh"
#define TAG_ITE_BLOCK "if"
#define TAG_FOREACH "foreach"

using xml_script_node_enum_t = enum xml_script_node_enum_t {
   NODE_UNKNOWN = 0,
   NODE_ENTRY = 1,
   NODE_VARIABLE = 2,
   NODE_PARAMETER = 3,
   NODE_COMMAND = 4,
   NODE_SHELL = 5,
   NODE_ITE_BLOCK = 6,
   NODE_FOREACH = 7
};

class xml_script_node_t
{
 public:
   xml_script_node_enum_t nodeType;

   virtual std::string get_xml_name() const = 0;
   virtual xml_nodeRef create_xml_node() const = 0;

   virtual void clean() = 0;

   virtual bool checkCondition(const DesignParametersRef& dp) const;

   static xml_script_node_enum_t find_type(const xml_element* element);
   static xml_script_node_t* create(const xml_element* element);

   static bool evaluate_condition(const std::string* condition);
   static bool evaluate_condition(const std::string* condition, const DesignParametersRef& dp);

   explicit xml_script_node_t(xml_script_node_enum_t _type) : nodeType(_type)
   {
   }
   virtual ~xml_script_node_t();
};
using xml_script_node_tRef = refcount<xml_script_node_t>;

class xml_set_entry_t : public xml_script_node_t
{
 public:
   std::string value;
   std::string* condition;

   xml_set_entry_t(std::string _value, const std::string* _condition);
   explicit xml_set_entry_t(const xml_element* element);

   ~xml_set_entry_t() override;

   std::string get_xml_name() const override;
   xml_nodeRef create_xml_node() const override;

   void clean() override;

   bool checkCondition(const DesignParametersRef& dp) const override;
};
using xml_set_entry_tRef = refcount<xml_set_entry_t>;

class xml_set_variable_t : public xml_script_node_t
{
 public:
   std::string name;
   std::string* singleValue;
   std::vector<xml_set_entry_tRef> multiValues;
   std::string* condition;

   xml_set_variable_t(std::string _name, const std::string* _singleValue, const std::string* _condition);
   explicit xml_set_variable_t(const xml_element* element);

   ~xml_set_variable_t() override;

   std::string get_xml_name() const override;
   xml_nodeRef create_xml_node() const override;

   void clean() override;

   bool checkCondition(const DesignParametersRef& dp) const override;
};
using xml_set_variable_tRef = refcount<xml_set_variable_t>;

class xml_parameter_t : public xml_script_node_t
{
 public:
   std::string* name;
   std::string* singleValue;
   std::vector<xml_set_entry_tRef> multiValues;
   std::string* condition;
   std::string separator;
   bool curlyBrackets;

   xml_parameter_t(const std::string* _name, const std::string* _singleValue, const std::string* _condition,
                   const std::string& _separator, bool _curlyBrackets);
   explicit xml_parameter_t(const xml_element* element);

   ~xml_parameter_t() override;

   std::string get_xml_name() const override;
   xml_nodeRef create_xml_node() const override;

   void clean() override;

   bool checkCondition(const DesignParametersRef& dp) const override;
};
using xml_parameter_tRef = refcount<xml_parameter_t>;

class xml_command_t : public xml_script_node_t
{
 public:
   std::string* name;
   std::string* value;
   std::vector<xml_parameter_tRef> parameters;
   std::string* condition;
   std::string* output;

   xml_command_t(const std::string* _name, const std::string* _value, const std::string* _condition,
                 const std::string* _output);
   explicit xml_command_t(const xml_element* element);

   ~xml_command_t() override;

   std::string get_xml_name() const override;
   xml_nodeRef create_xml_node() const override;

   void clean() override;

   bool checkCondition(const DesignParametersRef& dp) const override;
};
using xml_command_tRef = refcount<xml_command_t>;

class xml_shell_t : public xml_script_node_t
{
 public:
   std::string* name;
   std::string* value;
   std::vector<xml_parameter_tRef> parameters;
   std::string* condition;
   std::string* output;

   xml_shell_t(const std::string* _name, const std::string* _value, const std::string* _condition,
               const std::string* _output);
   explicit xml_shell_t(const xml_element* element);

   ~xml_shell_t() override;

   std::string get_xml_name() const override;
   xml_nodeRef create_xml_node() const override;

   void clean() override;

   bool checkCondition(const DesignParametersRef& dp) const override;
};
using xml_shell_tRef = refcount<xml_shell_t>;

class xml_ite_block_t : public xml_script_node_t
{
 public:
   std::string condition;
   std::vector<xml_script_node_tRef> thenNodes;
   std::vector<xml_script_node_tRef> elseNodes;

   explicit xml_ite_block_t(const std::string* _condition);
   explicit xml_ite_block_t(const xml_element* element);

   std::string get_xml_name() const override;
   xml_nodeRef create_xml_node() const override;

   ~xml_ite_block_t() override;

   void clean() override;

   bool checkCondition(const DesignParametersRef& dp) const override;
};
using xml_ite_block_tRef = refcount<xml_ite_block_t>;

struct xml_foreach_t : public xml_script_node_t
{
 public:
   std::string variable;
   std::vector<xml_script_node_tRef> Nodes;

   explicit xml_foreach_t(std::string _variable);
   explicit xml_foreach_t(const xml_element* element);

   std::string get_xml_name() const override;
   xml_nodeRef create_xml_node() const override;

   ~xml_foreach_t() override;

   void clean() override;
};
using xml_foreach_tRef = refcount<xml_foreach_t>;

#endif