ToolManager.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 _TOOL_MANAGER_HPP_
#define _TOOL_MANAGER_HPP_

#include "refcount.hpp"
CONSTREF_FORWARD_DECL(Parameter);

#include <string>
#include <vector>

class ToolManager
{
 protected:
   const ParameterConstRef Param;

   std::string executable;

   std::string setup_script;

   bool local;

   std::string host;
   std::string remote_path;

   int debug_level;

   int execute_command(const std::string& _command_, const std::string& error_message, const std::string& log_file,
                       bool permissive = false, bool throw_message = true);

   int check_command(const std::string& _tool_, const std::string& setupscr, const std::string& _host_,
                     bool permissive = false);
   std::string create_remote_command_line(const std::vector<std::string>& parameters) const;

   void prepare_input_files(const std::vector<std::string>& files);

   void check_output_files(const std::vector<std::string>& files);

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

   void remove_files(const std::vector<std::string>& input_files, const std::vector<std::string>& files);

 public:
   explicit ToolManager(const ParameterConstRef& Param);

   virtual ~ToolManager();

   void configure(const std::string& _tool_, const std::string& setupscr, const std::string& _host_ = "",
                  const std::string& _remote_path_ = "", bool force_remote = false);

   int execute(const std::vector<std::string>& parameters, const std::vector<std::string>& input_files,
               const std::vector<std::string>& output_files = std::vector<std::string>(),
               const std::string& log_file = std::string(), bool permissive = false);

   std::vector<std::string> determine_paths(std::vector<std::string>& files, bool overwrite = true);

   std::string determine_paths(std::string& file_name, bool overwrite = true);
};

using ToolManagerRef = refcount<ToolManager>;

#endif