ExternalProcess.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Chris Bielow $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/DATASTRUCTURES/StringUtils.h>
 
#include <functional>
#include <map>
#include <string>
#include <vector>
 
namespace OpenMS
{
 
  class OPENMS_DLLAPI ExternalProcess
  {
  public:
    enum class RETURNSTATE
    {
      SUCCESS,  
      NONZERO_EXIT, 
      CRASH, 
      FAILED_TO_START 
    };
 
    enum class IO_MODE
    {
        NO_IO, 
        READ_ONLY,
        WRITE_ONLY,
        READ_WRITE
    };
 
    ExternalProcess();
 
    ExternalProcess(std::function<void(const std::string&)> callbackStdOut, std::function<void(const std::string&)> callbackStdErr);
 
    ~ExternalProcess();
 
    void setCallbacks(std::function<void(const std::string&)> callbackStdOut, std::function<void(const std::string&)> callbackStdErr);
 
    RETURNSTATE run(const std::string& exe, const std::vector<std::string>& args, const std::string& working_dir, const bool verbose, std::string& error_msg,
                    IO_MODE io_mode = IO_MODE::READ_WRITE,
                    const std::map<std::string, std::string>& env = {},
                    std::function<void()> idle_callback = nullptr);
 
    RETURNSTATE run(const std::string& exe, const std::vector<std::string>& args, const std::string& working_dir, const bool verbose,
                    IO_MODE io_mode = IO_MODE::READ_WRITE,
                    const std::map<std::string, std::string>& env = {},
                    std::function<void()> idle_callback = nullptr);
 
  private:
    std::function<void(const std::string&)> callbackStdOut_;
    std::function<void(const std::string&)> callbackStdErr_;
  };
} // ns OpenMS