qgspythonrunner.h

Go to the documentation of this file.

/***************************************************************************
    qgspythonrunner.h
    ---------------------
    begin                : May 2011
    copyright            : (C) 2011 by Martin Dobias
    email                : wonder dot sk at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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 QGSPYTHONRUNNER_H
#define QGSPYTHONRUNNER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QString>

class CORE_EXPORT QgsPythonRunner
{
  public:
    static bool isValid();

    static bool run( const QString &command, const QString &messageOnError = QString() );

    static bool runFile( const QString &filename, const QString &messageOnError = QString() );

    static bool eval( const QString &command, QString &result SIP_OUT );

    static bool setArgv( const QStringList &arguments, const QString &messageOnError = QString() );

    static void setInstance( QgsPythonRunner *runner SIP_TRANSFER );
 
  protected:
    QgsPythonRunner() = default;
    virtual ~QgsPythonRunner() = default;

    virtual bool runCommand( QString command, QString messageOnError = QString() ) = 0;

    virtual bool runFileCommand( const QString &filename, const QString &messageOnError = QString() ) = 0;

    virtual bool evalCommand( QString command, QString &result ) = 0;

    virtual bool setArgvCommand( const QStringList &arguments, const QString &messageOnError = QString() ) = 0;
 
    static QgsPythonRunner *sInstance;
};
 
#endif // QGSPYTHONRUNNER_H