/***************************************************************************
        File                 : PythonScripting.h
        Project              : SciDAVis
--------------------------------------------------------------------
        Copyright            : (C) 2006 by Knut Franke
        Email (use @ for *)  : knut.franke*gmx.de
        Description          : Execute Python code from within SciDAVis

 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *  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.                                    *
 *                                                                         *
 *  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, write to the Free Software           *
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor,                    *
 *   Boston, MA  02110-1301  USA                                           *
 *                                                                         *
 ***************************************************************************/
#ifndef PYTHON_SCRIPTING_H
#define PYTHON_SCRIPTING_H

#include "ScriptingEnv.h"
#include "PythonScript.h"

class QObject;
class QString;

typedef struct _object PyObject;

class PythonScripting : public ScriptingEnv
{
    Q_OBJECT

public:
    static const char *langName;
    PythonScripting(ApplicationWindow *parent, bool batch = false);
    ~PythonScripting();
    static ScriptingEnv *constructor(ApplicationWindow *parent, bool batch = false)
    {
        return new PythonScripting(parent, batch);
    }
    bool initialize() override;
    void redirectStdIO() override;

    void write(const QString &text) { emit print(text); }

    //! like str(object) in Python
    /**
     * Convert object to a string.
     * Steals a reference to object if decref is true; borrows otherwise.
     */
    QString toString(PyObject *object, bool decref = false);
    //! evaluate a Python expression
    /**
     * Evaluates code, using argDict (borrowed reference) as local dictionary
     * or an empty one if argDict==NULL. name is the filename Python uses when
     * reporting errors. Returns a new reference; NULL means caller has to do
     * exception handling.
     */
    PyObject *eval(const QString &code, PyObject *argDict = NULL, const char *name = "<scidavis>");
    //! execute a sequence of Python statements
    /**
     * Executes code, using argDict (borrowed reference) as local dictionary
     * or an empty one if argDict==NULL. name is the filename Python uses when
     * reporting errors. A false return value means caller has to do exception
     * handling.
     */
    bool exec(const QString &code, PyObject *argDict = NULL, const char *name = "<scidavis>");
    QString errorMsg();

    bool isRunning() const override;
    Script *newScript(const QString &code, QObject *context,
                      const QString &name = "<input>") override
    {
        return new PythonScript(this, code, context, name);
    }

    bool setQObject(QObject *, const char *, PyObject *dict);
    bool setQObject(QObject *val, const char *name) override { return setQObject(val, name, NULL); }
    bool setInt(int i, const char *s) override { return setInt(i, s, nullptr); }
    bool setInt(int, const char *, PyObject *dict);
    bool setDouble(double x, const char *s) override { return setDouble(x, s, nullptr); }
    bool setDouble(double, const char *, PyObject *dict);

    const QStringList mathFunctions() const override;
    const QString mathFunctionDoc(const QString &name) const override;
    const QStringList fileExtensions() const override;

    PyObject *globalDict() { return globals; }
    PyObject *sysDict() { return sys; }

private:
    bool loadInitFile(const QString &path);

    PyObject *globals; // PyDict of global environment
    PyObject *math; // PyDict of math functions
    PyObject *sys; // PyDict of sys module
};

#endif
