qgsrunprocess.h

Go to the documentation of this file.

/***************************************************************************
                          qgsrunprocess.h
 
 A class that runs an external program
 
                             -------------------
    begin                : Jan 2005
    copyright            : (C) 2005 by Gavin Macaulay
    email                : gavin at macaulay dot co dot nz
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program 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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSRUNPROCESS_H
#define QGSRUNPROCESS_H
 
#include <QObject>
 
#if QT_CONFIG( process )
#include <QProcess>
#endif
 
#include <QThread>
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
class QgsFeedback;
class QgsMessageOutput;

class CORE_EXPORT QgsRunProcess : public QObject SIP_NODEFAULTCTORS
{
    Q_OBJECT
 
  public:
    // This class deletes itself, so to ensure that it is only created
    // using new, the Named Constructor Idiom is used, and one needs to
    // use the create() static function to get an instance of this class.
 
    // The action argument contains string with the command.
    // If capture is true, the standard output and error from the process
    // will be sent to QgsMessageOutput - usually a dialog box.
    static QgsRunProcess *create( const QString &action, bool capture ) SIP_FACTORY { return new QgsRunProcess( action, capture ); }

    static QStringList splitCommand( const QString &command );
 
  private:
    QgsRunProcess( const QString &action, bool capture ) SIP_FORCE;
    ~QgsRunProcess() override SIP_FORCE;
 
#if QT_CONFIG( process )
    // Deletes the instance of the class
    void die();
 
    std::unique_ptr<QProcess> mProcess;
    QgsMessageOutput *mOutput = nullptr;
    QString mCommand;
 
  public slots:
    void stdoutAvailable();
    void stderrAvailable();
    void processError( QProcess::ProcessError );
    void processExit( int, QProcess::ExitStatus );
    void dialogGone();
#endif // !(QT_CONFIG(process)
};
 
#if QT_CONFIG( process )

class CORE_EXPORT QgsBlockingProcess : public QObject
{
    Q_OBJECT
 
  public:
    QgsBlockingProcess( const QString &program, const QStringList &arguments );
 
#ifndef SIP_RUN

    void setStdOutHandler( const std::function< void( const QByteArray & ) > &handler ) { mStdoutHandler = handler; }
#else
    // clang-format off

    void setStdOutHandler( SIP_PYCALLABLE / AllowNone / );
    % MethodCode
    Py_BEGIN_ALLOW_THREADS
 
    sipCpp->setStdOutHandler( [a0]( const QByteArray &arg )
    {
      SIP_BLOCK_THREADS
      Py_XDECREF( sipCallMethod( NULL, a0, "D", &arg, sipType_QByteArray, NULL ) );
      SIP_UNBLOCK_THREADS
    } );
 
    Py_END_ALLOW_THREADS
    % End
// clang-format on
#endif
 
#ifndef SIP_RUN

    void setStdErrHandler( const std::function< void( const QByteArray & ) > &handler ) { mStderrHandler = handler; }
#else
      // clang-format off

    void setStdErrHandler( SIP_PYCALLABLE / AllowNone / );
    % MethodCode
    Py_BEGIN_ALLOW_THREADS
 
    sipCpp->setStdErrHandler( [a0]( const QByteArray &arg )
    {
      SIP_BLOCK_THREADS
      Py_XDECREF( sipCallMethod( NULL, a0, "D", &arg, sipType_QByteArray, NULL ) );
      SIP_UNBLOCK_THREADS
    } );
 
    Py_END_ALLOW_THREADS
    % End
// clang-format on
#endif

    int run( QgsFeedback *feedback = nullptr );

    QProcess::ExitStatus exitStatus() const;

    QProcess::ProcessError processError() const;
 
  private:
    QString mProcess;
    QStringList mArguments;
    std::function< void( const QByteArray & ) > mStdoutHandler;
    std::function< void( const QByteArray & ) > mStderrHandler;
 
    QProcess::ExitStatus mExitStatus = QProcess::NormalExit;
    QProcess::ProcessError mProcessError = QProcess::UnknownError;
};
 
#endif // QT_CONFIG(process)

#ifndef SIP_RUN
 
class ProcessThread : public QThread
{
    Q_OBJECT
 
  public:
    ProcessThread( const std::function<void()> &function, QObject *parent = nullptr )
      : QThread( parent )
      , mFunction( function )
    {}
 
    void run() override { mFunction(); }
 
  private:
    std::function<void()> mFunction;
};
 
#endif
 
 
#endif