ExternalProcess.h

Go to the documentation of this file.

// Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Chris Bielow $
// --------------------------------------------------------------------------
 
#pragma once
 
// OpenMS_GUI config
#include <OpenMS/DATASTRUCTURES/String.h>
 
#include <QtCore/QObject>
 
#include <functional> // for std::function
 
class QProcess; // forward declare to avoid header include
class QString;
class QStringList;
 
namespace OpenMS
{
 
  class OPENMS_DLLAPI ExternalProcess
    : public QObject
  {
    Q_OBJECT
 
  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 String&)> callbackStdOut, std::function<void(const String&)> callbackStdErr);
 
    ~ExternalProcess() override ;
 
    void setCallbacks(std::function<void(const String&)> callbackStdOut, std::function<void(const String&)> callbackStdErr);
 
    RETURNSTATE run(const QString& exe, const QStringList& args, const QString& working_dir, const bool verbose, String& error_msg, IO_MODE io_mode = IO_MODE::READ_WRITE);
    
    ExternalProcess::RETURNSTATE run(const QString& exe, const QStringList& args, const QString& working_dir, const bool verbose, IO_MODE io_mode = IO_MODE::READ_WRITE);
 
  private slots:
    void processStdOut_();
    void processStdErr_();
 
  private:
    QProcess* qp_; 
    std::function<void(const String&)> callbackStdOut_;
    std::function<void(const String&)> callbackStdErr_;
  };
} // ns OpenMS